modules/dbus/include/dpl/dbus/server.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   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  * @file    server.h
  18  * @author  Zbigniew Kostrzewa (z.kostrzewa@samsung.com)
  19  * @version 1.0
  20  * @brief
  21  */
  22
  23 #ifndef DPL_DBUS_SERVER_H
  24 #define DPL_DBUS_SERVER_H
  25
  26 #include <memory>
  27 #include <string>
  28 #include <gio/gio.h>
  29 #include <dpl/generic_event.h>
  30 #include <dpl/event/event_support.h>
  31 #include <dpl/dbus/connection.h>
  32
  33 namespace DPL
  34 {
  35 namespace DBus
  36 {
  37
  38 namespace ServerEvents
  39 {
  40 /**
  41  * Emitted when new connection is accepted.
  42  *
  43  * Arg0 Accepted connection.
  44  *
  45  * @remarks If this event is processed on separate thread than that thread
  46  *          should run GLib main loop if one wants to e.g. register DBus
  47  *          objects during this event processing.
  48  */
  49 DECLARE_GENERIC_EVENT_1(NewConnectionEvent, ConnectionPtr)
  50 }
  51
  52 class Server;
  53 typedef std::shared_ptr<Server> ServerPtr;
  54
  55 /**
  56  * Class acting as a server for peer to peer connections over DBus.
  57  */
  58 class Server : public DPL::Event::EventSupport<ServerEvents::NewConnectionEvent>
  59 {
  60 public:
  61     /**
  62      * Creates server.
  63      *
  64      * @param address Address the server should listen on.
  65      * @return Server.
  66      */
  67     static ServerPtr create(const std::string& address);
  68
  69     ~Server();
  70
  71     /**
  72      * Starts the server.
  73      */
  74     void start();
  75
  76     /**
  77      * Stops the server.
  78      */
  79     void stop();
  80
  81 protected:
  82     explicit Server(GDBusServer* server);
  83
  84 private:
  85     static gboolean onNewConnection(GDBusServer* server,
  86                                     GDBusConnection* connection,
  87                                     gpointer data);
  88
  89     GDBusServer* m_server;
  90 };
  91
  92 }
  93 }
  94
  95 #endif // DPL_DBUS_SERVER_H