Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::platform::DBus::CallContext Class Reference

Context for one incoming method call against a registered object. More...

#include <dbus.hpp>

Public Member Functions

const std::string & path () const
const std::string & interface () const
const std::string & member () const
const std::string & sender () const
Reader & args ()
 Argument reader over the incoming call.
Writer reply ()
 Begin a success reply.
void error (const std::string &name, const std::string &message)
 Answer with a D-Bus error (e.g.

Friends

class DBus

Detailed Description

Context for one incoming method call against a registered object.

The handler reads arguments via args(), and answers with EXACTLY ONE of reply() (success) or error() (failure). A handler that returns true without calling either yields an empty success reply; returning false makes the server emit org.freedesktop.DBus.Error.UnknownMethod.

Member Function Documentation

◆ args()

Reader & pulp::platform::DBus::CallContext::args ( )
inline

Argument reader over the incoming call.

◆ error()

void pulp::platform::DBus::CallContext::error ( const std::string & name,
const std::string & message )

Answer with a D-Bus error (e.g.

"org.freedesktop.DBus.Error.Failed"). Marks the call answered. Mutually exclusive with reply().

◆ interface()

const std::string & pulp::platform::DBus::CallContext::interface ( ) const
inline

◆ member()

const std::string & pulp::platform::DBus::CallContext::member ( ) const
inline

◆ path()

const std::string & pulp::platform::DBus::CallContext::path ( ) const
inline

◆ reply()

Writer pulp::platform::DBus::CallContext::reply ( )

Begin a success reply.

Returns a Writer to append return values into. Calling reply() marks the call answered; the server sends it after the handler returns. May only be called once per call.

◆ sender()

const std::string & pulp::platform::DBus::CallContext::sender ( ) const
inline

◆ DBus

friend class DBus
friend

The documentation for this class was generated from the following file:
  • /home/runner/work/pulp/pulp/core/platform/include/pulp/platform/dbus.hpp