ArnSapi.hpp

Go to the documentation of this file.

// Copyright (C) 2010-2022 Michael Wiklund.
// All rights reserved.
// Contact: arnlib@wiklunden.se
//
// This file is part of the ArnLib - Active Registry Network.
// Parts of ArnLib depend on Qt and/or other libraries that have their own
// licenses. Usage of these other libraries is subject to their respective
// license agreements.
//
// GNU Lesser General Public License Usage
// This file may be used under the terms of the GNU Lesser General Public
// License version 2.1 as published by the Free Software Foundation and
// appearing in the file LICENSE_LGPL.txt included in the packaging of this
// file. In addition, as a special exception, you may use the rights described
// in the Nokia Qt LGPL Exception version 1.1, included in the file
// LGPL_EXCEPTION.txt in this package.
//
// GNU General Public License Usage
// Alternatively, this file may be used under the terms of the GNU General Public
// License version 3.0 as published by the Free Software Foundation and appearing
// in the file LICENSE_GPL.txt included in the packaging of this file.
//
// Other Usage
// Alternatively, this file may be used in accordance with the terms and conditions
// contained in a signed written agreement between you and Michael Wiklund.
//
// 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 Lesser General Public License for more details.
//

#ifndef ARNSAPI_HPP
#define ARNSAPI_HPP

#include "ArnLib_global.hpp"
#include "ArnRpc.hpp"
#include <QString>
#include <QByteArray>
#include <QObject>

#if defined(__DATE__) && defined(Q_SIGNALS)  // Handle QT Creator code completion
# define MQ_PUBLIC_ACCESS public:
#else
# define MQ_PUBLIC_ACCESS
#endif

class ArnSapiPrivate;





class ARNLIBSHARED_EXPORT ArnSapi : public ArnRpc
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(ArnSapi)

public:
    explicit  ArnSapi( QObject* parent = arnNullptr);


    bool  open( const QString& pipePath = QString(), Mode mode = Mode(),
                const char* providerPrefix = arnNullptr, const char* requesterPrefix = arnNullptr);


    void  batchConnectTo( const QObject* receiver, const QString& prefix = QString(),
                          Mode mode = Mode());


    void  batchConnectFrom( const QObject* sender, const QString& prefix = QString(),
                            Mode mode = Mode());


    QString  defaultPath()  const;

protected:
    ArnSapi( const QString& defaultPath, QObject* parent = arnNullptr);


    void  setDefaultPath( const QString& defaultPath);

    ArnSapi( ArnSapiPrivate& dd, QObject* parent);

private:
    void  setPipe( ArnPipe* pipe);
    void  setReceiver( QObject* receiver);
    bool  setReceiver( QObject* receiver, bool useTrackRpcSender);
    void  setMethodPrefix( const QString& prefix);
    void  setIncludeSender( bool v);
    void  setMode( Mode mode);
    void  addSenderSignals( QObject* sender, const QString& prefix);
    ArnRpc*  rpcSender();
    static ArnRpc*  rpcSender( QObject* receiver);
};


#endif // ARNSAPI_HPP