include/dbus_server.h

   1 /*
   2  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __CONTEXT_DBUS_SERVER_H__
  18 #define __CONTEXT_DBUS_SERVER_H__
  19
  20 #include <sys/types.h>
  21
  22 namespace ctx {
  23         /* Forward Declaration */
  24         class dbus_listener_iface;
  25
  26         namespace dbus_server {
  27                 /**
  28                  * @brief       Subscribes to signals.
  29                  * @param[in]   sender          Sensor name to match on. NULL to listen from all senders.
  30                  * @param[in]   path            Object path to match on. NULL to match on all object paths.
  31                  * @param[in]   iface           D-Bus interface name to match on. NULL to match on all interfaces.
  32                  * @param[in]   name            D-Bus signal name to match on. NULL to match on all signals.
  33                  * @param[in]   listener        Listener object to receive matching signals.
  34                  * @return      A subscription identifier that can be used with signal_unsubscribe().@n
  35                  *                      If failed, a negative value.
  36                  */
  37                 int64_t signal_subscribe(const char* sender, const char* path, const char* iface, const char* name, dbus_listener_iface* listener);
  38
  39                 /**
  40                  * @brief       Unsubscribes from signals.
  41                  */
  42                 void signal_unsubscribe(int64_t subscription_id);
  43
  44         }       /* namespace ctx::dbus_server */
  45 }       /* namespace ctx */
  46
  47 #endif  /* End of __CONTEXT_DBUS_SERVER_H__ */