dds::rpc::ClientParams Class Reference

<<value-type>> The parameters used to configure a ClientEndpoint More...

#include <dds/rpc/ClientEndpoint.hpp>

Inherits rti::request::detail::EntityParamsWithSetters< ActualEntity >.

Public Member Functions
	ClientParams (dds::domain::DomainParticipant participant)
	Construct a new Client Params object. More...
ClientParams &	function_call_max_wait (const dds::core::Duration &max_wait)
	Specifies the maximum wait time for all the remote calls. More...
dds::core::Duration	function_call_max_wait () const
	Returns the maximum wait time. More...

Detailed Description

<<value-type>> The parameters used to configure a ClientEndpoint

Since clients use a rti::request::Requester to communicate with a service, the ClientParams type contains the same parameters as an rti::request::RequesterParams, plus function_call_max_wait.

Constructor & Destructor Documentation

ClientParams()

dds::rpc::ClientParams::ClientParams ( dds::domain::DomainParticipant  participant )

inline

Construct a new Client Params object.

Parameters

participant

The DomainParticipant is a required parameter

Member Function Documentation

function_call_max_wait() [1/2]

ClientParams& dds::rpc::ClientParams::function_call_max_wait ( const dds::core::Duration &  max_wait )

inline

Specifies the maximum wait time for all the remote calls.

Parameters

max_wait

The maximum wait time for all remote calls made by a client

Returns

This object

function_call_max_wait() [2/2]

dds::core::Duration dds::rpc::ClientParams::function_call_max_wait ( ) const

inline

Returns the maximum wait time.

References dds::core::Duration::infinite().