CppWAMP
C++11 client library for the WAMP protocol
Public Member Functions | List of all members
wamp::Interruption Class Reference

Contains details within WAMP INTERRUPT messages. More...

#include <cppwamp/peerdata.hpp>

Inheritance diagram for wamp::Interruption:
Inheritance graph
[legend]

Public Member Functions

 Interruption ()
 Default constructor. More...
 
bool empty () const
 Returns false if the Interruption has been initialized and is ready for use.
 
bool calleeHasExpired () const
 Determines if the Session object that dispatched this interruption still exists or has expired.
 
RequestId requestId () const
 Returns the request ID associated with this interruption.
 
AnyIoExecutor executor () const
 Obtains the executor used to execute user-provided handlers. More...
 
void yield (Result result=Result()) const
 Manually sends a YIELD result back to the callee. More...
 
void yield (Error error) const
 Manually sends an ERROR result back to the callee. More...
 

Detailed Description

Contains details within WAMP INTERRUPT messages.

This class also provides the means for manually sending a YIELD or ERROR result back to the RPC caller.

Constructor & Destructor Documentation

◆ Interruption()

wamp::Interruption::Interruption ( )

Default constructor.

Postcondition
this->empty() == true

Member Function Documentation

◆ executor()

AnyIoExecutor wamp::Interruption::executor ( ) const

Obtains the executor used to execute user-provided handlers.

Returns
the same object as Session::userExecutor().
Precondition
this->empty() == false

◆ yield() [1/2]

void wamp::Interruption::yield ( Result  result = Result()) const

Manually sends a YIELD result back to the callee.

Precondition
this->calleeHasExpired == false

◆ yield() [2/2]

void wamp::Interruption::yield ( Error  error) const

Manually sends an ERROR result back to the callee.

Precondition
this->calleeHasExpired == false
The documentation for this class was generated from the following files: