Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::inspect::ControlService::Session Class Reference

Carrier-owned state for exactly one authenticated local connection. More...

#include <control_service.hpp>

Public Member Functions

 ~Session ()
 Session (const Session &)=delete
Session & operator= (const Session &)=delete
 Session (Session &&other) noexcept
Session & operator= (Session &&other) noexcept
bool is_open () const
const ControlClientId & client_id () const
const VerifiedControlPeerIdentity & peer () const
ControlServiceResult dispatch (std::string_view encoded_envelope)
ControlArtifactReadResult read_artifact (std::string_view artifact_id, std::uint64_t offset, std::size_t maximum_bytes)
 Reads only artifacts produced by this connection-bound client ID.

Friends

class ControlService

Detailed Description

Carrier-owned state for exactly one authenticated local connection.

Negotiation cannot leak across peers and is discarded on disconnect by destroying this value.

Constructor & Destructor Documentation

◆ ~Session()

pulp::inspect::ControlService::Session::~Session ( )

◆ Session() [1/2]

pulp::inspect::ControlService::Session::Session ( const Session & )
delete

◆ Session() [2/2]

pulp::inspect::ControlService::Session::Session ( Session && other)
noexcept

Member Function Documentation

◆ client_id()

const ControlClientId & pulp::inspect::ControlService::Session::client_id ( ) const
inline

◆ dispatch()

ControlServiceResult pulp::inspect::ControlService::Session::dispatch ( std::string_view encoded_envelope)

◆ is_open()

bool pulp::inspect::ControlService::Session::is_open ( ) const
inline

◆ operator=() [1/2]

Session & pulp::inspect::ControlService::Session::operator= ( const Session & )
delete

◆ operator=() [2/2]

Session & pulp::inspect::ControlService::Session::operator= ( Session && other)
noexcept

◆ peer()

const VerifiedControlPeerIdentity & pulp::inspect::ControlService::Session::peer ( ) const
inline

◆ read_artifact()

ControlArtifactReadResult pulp::inspect::ControlService::Session::read_artifact ( std::string_view artifact_id,
std::uint64_t offset,
std::size_t maximum_bytes )

Reads only artifacts produced by this connection-bound client ID.

◆ ControlService

friend class ControlService
friend

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