IDobbyIPCUtils.h

/*
* If not stated otherwise in this file or this component's LICENSE file the
* following copyright and licenses apply:
*
* Copyright 2016 Sky UK
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
 * File:   IDobbyIPCUtils.h
 *
 */
#ifndef IDOBBYIPCUTILS_H
#define IDOBBYIPCUTILS_H
 
#include <IIpcService.h>
 
#include <cstdint>
#include <string>
#include <list>
#include <functional>
 
#include <sys/types.h>
#include <sys/sysmacros.h>
 
// -----------------------------------------------------------------------------
class IDobbyIPCUtils
{
public:
    virtual ~IDobbyIPCUtils() = default;
 
public:
    // -------------------------------------------------------------------------
    enum class BusType
    {
        NoneBus,
        SystemBus,
        AIPrivateBus,
        AIPublicBus
    };
 
    // -------------------------------------------------------------------------
    virtual std::shared_ptr<AI_IPC::IAsyncReplyGetter> ipcInvokeMethod(const BusType &bus,
                                                                       const AI_IPC::Method &method,
                                                                       const AI_IPC::VariantList &args,
                                                                       int timeoutMs = -1) const = 0;
 
    // -------------------------------------------------------------------------
    virtual bool ipcInvokeMethod(const BusType &bus,
                                 const AI_IPC::Method &method,
                                 const AI_IPC::VariantList &args,
                                 AI_IPC::VariantList &replyArgs) const = 0;
 
    // -------------------------------------------------------------------------
    virtual bool ipcEmitSignal(const BusType &bus,
                               const AI_IPC::Signal &signal,
                               const AI_IPC::VariantList &args) const = 0;
 
    // -------------------------------------------------------------------------
    virtual bool ipcServiceAvailable(const BusType &bus,
                                     const std::string &serviceName) const = 0;
 
    // -------------------------------------------------------------------------
    virtual int ipcRegisterServiceHandler(const BusType &bus,
                                          const std::string &serviceName,
                                          const std::function<void(bool)> &handlerFunc) = 0;
 
    // -------------------------------------------------------------------------
    virtual int ipcRegisterSignalHandler(const BusType &bus,
                                         const AI_IPC::Signal &signal,
                                         const AI_IPC::SignalHandler &handlerFunc) = 0;
 
    // -------------------------------------------------------------------------
    virtual void ipcUnregisterHandler(const BusType &bus, int handlerId) = 0;
 
    // -------------------------------------------------------------------------
    virtual std::string ipcDbusAddress(const BusType &bus) const = 0;
 
    // -------------------------------------------------------------------------
    virtual std::string ipcDbusSocketPath(const BusType &bus) const = 0;
};
 
#endif // !defined(IDOBBYIPCUTILS_H)