Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
PhosphorIpc::IpcRouter Class Reference

#include <PhosphorIpc/IpcRouter.h>

Inheritance diagram for PhosphorIpc::IpcRouter:
[legend]

Public Types

enum class  StopMode { Abort , Flush }
enum class  InvokeOutcome {
  Ok , NoSuchTarget , NoSuchFn , ArgCountMismatch ,
  ArgConvertFailed , InvokeFailed , CallFailed , Deferred
}

Signals

void targetRegistered (const QString &name)
void targetUnregistered (const QString &name)
void connectionOpened (quint64 connectionId)
void connectionRefused ()
void connectionClosed (quint64 connectionId)

Public Member Functions

 IpcRouter (QObject *parent=nullptr)
 ~IpcRouter () override
bool start (const QString &socketPath=QString())
void stop ()
void stop (StopMode mode, int flushTimeoutMs=DefaultFlushTimeoutMs)
QString socketPath () const
void setMaxConnections (int max)
int maxConnections () const
int connectionCount () const
bool registerTarget (const QString &name, QObject *object)
void unregisterTarget (const QString &name, QObject *object=nullptr)
QStringList listTargets () const
QObject * target (const QString &name) const
QJsonObject schemaFor (const QString &target) const
QVariant invoke (const QString &target, const QString &fn, const QVariantList &args, InvokeOutcome *outcome=nullptr, QString *errorMessage=nullptr)
void broadcastEvent (const QString &target, const QString &signalName, const QJsonArray &args)
bool sendEvent (quint64 connectionId, const QString &target, const QString &signalName, const QJsonArray &args)
bool sendEvent (quint64 connectionId, const QString &target, const QString &signalName, const QJsonArray &args, qint64 *lineBytes)

Static Public Attributes

static constexpr int MaxPendingCallsPerConnection = 256
static constexpr int DefaultFlushTimeoutMs = 5000

Member Enumeration Documentation

◆ InvokeOutcome

Enumerator
Ok 
NoSuchTarget 
NoSuchFn 
ArgCountMismatch 
ArgConvertFailed 
InvokeFailed 
CallFailed 
Deferred 

◆ StopMode

Enumerator
Abort 
Flush 

Constructor & Destructor Documentation

◆ IpcRouter()

PhosphorIpc::IpcRouter::IpcRouter ( QObject * parent = nullptr)
explicit

◆ ~IpcRouter()

PhosphorIpc::IpcRouter::~IpcRouter ( )
override

Member Function Documentation

◆ broadcastEvent()

void PhosphorIpc::IpcRouter::broadcastEvent ( const QString & target,
const QString & signalName,
const QJsonArray & args )

◆ connectionClosed

void PhosphorIpc::IpcRouter::connectionClosed ( quint64 connectionId)
signal

◆ connectionCount()

int PhosphorIpc::IpcRouter::connectionCount ( ) const
nodiscard

◆ connectionOpened

void PhosphorIpc::IpcRouter::connectionOpened ( quint64 connectionId)
signal

◆ connectionRefused

void PhosphorIpc::IpcRouter::connectionRefused ( )
signal

◆ invoke()

QVariant PhosphorIpc::IpcRouter::invoke ( const QString & target,
const QString & fn,
const QVariantList & args,
InvokeOutcome * outcome = nullptr,
QString * errorMessage = nullptr )

◆ listTargets()

QStringList PhosphorIpc::IpcRouter::listTargets ( ) const
nodiscard

◆ maxConnections()

int PhosphorIpc::IpcRouter::maxConnections ( ) const
nodiscard

◆ registerTarget()

bool PhosphorIpc::IpcRouter::registerTarget ( const QString & name,
QObject * object )
nodiscard

◆ schemaFor()

QJsonObject PhosphorIpc::IpcRouter::schemaFor ( const QString & target) const
nodiscard

◆ sendEvent() [1/2]

bool PhosphorIpc::IpcRouter::sendEvent ( quint64 connectionId,
const QString & target,
const QString & signalName,
const QJsonArray & args )

◆ sendEvent() [2/2]

bool PhosphorIpc::IpcRouter::sendEvent ( quint64 connectionId,
const QString & target,
const QString & signalName,
const QJsonArray & args,
qint64 * lineBytes )

◆ setMaxConnections()

void PhosphorIpc::IpcRouter::setMaxConnections ( int max)

◆ socketPath()

QString PhosphorIpc::IpcRouter::socketPath ( ) const
nodiscard

◆ start()

bool PhosphorIpc::IpcRouter::start ( const QString & socketPath = QString())

◆ stop() [1/2]

void PhosphorIpc::IpcRouter::stop ( )

◆ stop() [2/2]

void PhosphorIpc::IpcRouter::stop ( StopMode mode,
int flushTimeoutMs = DefaultFlushTimeoutMs )

◆ target()

QObject * PhosphorIpc::IpcRouter::target ( const QString & name) const
nodiscard

◆ targetRegistered

void PhosphorIpc::IpcRouter::targetRegistered ( const QString & name)
signal

◆ targetUnregistered

void PhosphorIpc::IpcRouter::targetUnregistered ( const QString & name)
signal

◆ unregisterTarget()

void PhosphorIpc::IpcRouter::unregisterTarget ( const QString & name,
QObject * object = nullptr )

Member Data Documentation

◆ DefaultFlushTimeoutMs

int PhosphorIpc::IpcRouter::DefaultFlushTimeoutMs = 5000
staticconstexpr

◆ MaxPendingCallsPerConnection

int PhosphorIpc::IpcRouter::MaxPendingCallsPerConnection = 256
staticconstexpr

The documentation for this class was generated from the following file: