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 namespace DBus {
  35 namespace ServerEvents {
  36 /**
  37  * Emitted when new connection is accepted.
  38  *
  39  * Arg0 Accepted connection.
  40  *
  41  * @remarks If this event is processed on separate thread than that thread
  42  *          should run GLib main loop if one wants to e.g. register DBus
  43  *          objects during this event processing.
  44  */
  45 DECLARE_GENERIC_EVENT_1(NewConnectionEvent, ConnectionPtr)
  46 }
  47
  48 class Server;
  49 typedef std::shared_ptr<Server> ServerPtr;
  50
  51 /**
  52  * Class acting as a server for peer to peer connections over DBus.
  53  */
  54 class Server : public DPL::Event::EventSupport<ServerEvents::NewConnectionEvent>
  55 {
  56   public:
  57     /**
  58      * Creates server.
  59      *
  60      * @param address Address the server should listen on.
  61      * @return Server.
  62      */
  63     static ServerPtr create(const std::string& address);
  64
  65     ~Server();
  66
  67     /**
  68      * Starts the server.
  69      */
  70     void start();
  71
  72     /**
  73      * Stops the server.
  74      */
  75     void stop();
  76
  77   protected:
  78     explicit Server(GDBusServer* server);
  79
  80   private:
  81     static gboolean onNewConnection(GDBusServer* server,
  82                                     GDBusConnection* connection,
  83                                     gpointer data);
  84
  85     GDBusServer* m_server;
  86 };
  87 }
  88 }
  89
  90 #endif // DPL_DBUS_SERVER_H