wamp::Rpc Class Reference

Contains the procedure URI, options, and payload contained within WAMP CALL messages. More...

#include <cppwamp/peerdata.hpp>

Inheritance diagram for wamp::Rpc:

Public Types
using	CallerTimeoutDuration = std::chrono::steady_clock::duration
	The duration type used for caller-initiated timeouts.

Public Member Functions
	Rpc (String uri)
	Converting constructor taking a procedure URI.
const String &	procedure () const
	Obtains the procedure URI.
Rpc &	captureError (Error &error)
	Specifies the Error object in which to store call errors returned by the callee.
Progressive Call Results
See Progressive Call Results in the WAMP Specification
Rpc &	withProgressiveResults (bool enabled=true)
	Sets willingness to receive progressive results. More...
bool	progressiveResultsAreEnabled () const
	Indicates if progressive results were enabled.
Call Timeouts
See Call Timeouts in the WAMP Specification. Setting a duration of zero deactivates the timeout.
Rpc &	withDealerTimeout (UInt milliseconds)
	Requests that the dealer cancel the call after the specified timeout duration in milliseconds. More...
template<typename R , typename P >
Rpc &	withDealerTimeout (std::chrono::duration< R, P > timeout)
	Requests that the dealer cancel the call after the specified timeout duration.
Rpc &	withCallerTimeout (UInt milliseconds)
	Requests that the caller cancel the call after the specified timeout duration in milliseconds.
template<typename R , typename P >
Rpc &	withCallerTimeout (std::chrono::duration< R, P > timeout)
	Requests that the dealer cancel the call after the specified timeout duration.
CallerTimeoutDuration	callerTimeout () const
	Obtains the caller timeout duration.
Caller Identification
See Caller Identification in the WAMP Specification
Rpc &	withDiscloseMe (bool disclosed=true)
	Requests that the identity (session ID) of this session be disclosed in the call invocation. More...
Call Cancellation
Rpc &	withCancelMode (CallCancelMode mode)
	Sets the default cancellation mode to use when none is specified.
CallCancelMode	cancelMode () const
	Obtains the default cancellation mode associated with this RPC.

Detailed Description

Contains the procedure URI, options, and payload contained within WAMP CALL messages.

Examples

examples/asynctimeclient/main.cpp, examples/chat/main.cpp, examples/coro20timeclient/main.cpp, examples/futuretimeclient/main.cpp, examples/stacklesstimeclient/main.cpp, and examples/timeclient/main.cpp.

Member Function Documentation

withProgressiveResults()

Rpc & wamp::Rpc::withProgressiveResults

(

bool

enabled = true

)

Sets willingness to receive progressive results.

This sets the CALL.Options.receive_progress|bool option.

withDealerTimeout()

Rpc & wamp::Rpc::withDealerTimeout

(

UInt

milliseconds

)

Requests that the dealer cancel the call after the specified timeout duration in milliseconds.

This sets the CALL.Options.timeout|integer option.

withDiscloseMe()

Rpc & wamp::Rpc::withDiscloseMe

(

bool

disclosed = true

)

Requests that the identity (session ID) of this session be disclosed in the call invocation.

This sets the CALL.Options.disclose_me|bool option.

---

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

• cppwamp/peerdata.hpp
• cppwamp/internal/peerdata.ipp