dbus_server.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2023 Alec Leamas                                        *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,  USA.         *
 **************************************************************************/
 
#ifndef DBUS_HANDLER_H__
#define DBUS_HANDLER_H__
 
#include <functional>
#include <thread>
 
#include <gio/gio.h>
 
#include "model/instance_check.h"
#include "model/local_api.h"
#include "observable_evtvar.h"
 
static const char* const kDbusName = "org.opencpn.OpenCPN";
 
static const char* const kDbusObject = "/org/opencpn/OpenCPN";
 
static const char* const kDbusInterface = "opencpn.desktop";
 
static const gchar introspection_xml[] = R"""(
<node>
  <interface name='opencpn.desktop'>
    <annotation name='org.gtk.GDBus.Annotation' value='OnInterface'/>
    <annotation name='org.gtk.GDBus.Annotation' value='AlsoOnInterface'/>
    <method name='Ping'>
      <annotation name='org.gtk.GDBus.Annotation' value='OnMethod'/>
      <arg type='u' name='level' direction='out'/>
      <arg type='b' name='stat' direction='out'/>
    </method>
    <method name='Raise'>
      <annotation name='org.gtk.GDBus.Annotation' value='OnMethod'/>
      <!-- In the GUI case, raise application to top. -->
    </method>
    <method name='Open'>
      <annotation name='org.gtk.GDBus.Annotation' value='OnMethod'/>
      <arg type='s' name='level' direction='in'/>
      <arg type='b' name='stat' direction='out'/>
    </method>
    <method name='GetRestEndpoint'>
      <annotation name='org.gtk.GDBus.Annotation' value='OnMethod'/>
      <arg type='s' name='endpoint' direction='out'/>
    </method>
     <method name='Quit'>
      <annotation name='org.gtk.GDBus.Annotation' value='OnMethod'/>
    </method>
   </interface>
</node>
)""";
 
static void HandleMethodCall(GDBusConnection* connection, const gchar* sender,
                             const gchar* object_path,
                             const gchar* interface_name,
                             const gchar* method_name, GVariant* parameters,
                             GDBusMethodInvocation* invocation,
                             gpointer user_data);
 
class DbusServer : public LocalServerApi, public InstanceCheck {
public:
  static DbusServer& GetInstance();
 
  static void Disconnect();
 
  DbusServer(DbusServer&) = delete;
  void operator=(const DbusServer&) = delete;
 
  virtual ~DbusServer();
 
  void WaitUntilValid() override;
 
  GDBusNodeInfo* introspection_data;
 
  bool IsMainInstance() { return m_is_main_instance; }
 
  void SetMainInstance(bool value) { m_is_main_instance = value; }
 
  DbusServer* UnitTestInstance() { return new DbusServer(); }
 
protected:
  DbusServer();
 
private:
  static DbusServer* s_instance;
  bool m_is_main_instance;
  unsigned m_owner_id;
};
 
#endif  // DBUS_HANDLER_H__