dds::rpc::ClientEndpoint< Request, Reply > Class Template Reference

<<reference-type>> Manages the DDS entities required to make remote function calls. More...

#include <dds/rpc/ClientEndpoint.hpp>

Inheritance diagram for dds::rpc::ClientEndpoint< Request, Reply >:

Public Types
using	RequestType = Request
	The type used to make function calls. More...
using	ReplyType = Reply
	The type used to receive the results of function calls. More...

Public Member Functions
	ClientEndpoint (const ClientParams &params)
	Creates a new ClientEndpoint. More...
void	close ()
	Destroyes the underlying requester and other resources. More...
bool	closed () const
	Whether this instance has been closed already. More...
bool	wait_for_service (const dds::core::Duration &max_wait=dds::core::Duration::infinite())
	Waits for one or more services to be discovered. This function takes advantage of enhanced discovery, making sure both the Client and the Service discover each other. More...
dds::pub::DataWriter< RequestType >	request_datawriter () const
	Accesses the underlying DataWriter that sends the requests (function calls) More...
dds::sub::DataReader< ReplyType >	reply_datareader () const
	Accesses the underlying DataReader that receives the replies (return values from the function calls) More...

Detailed Description

template<typename Request, typename Reply>
class dds::rpc::ClientEndpoint< Request, Reply >

<<reference-type>> Manages the DDS entities required to make remote function calls.

This class is always the base of a concrete client, such as rpc_example::RobotControlClient.

Member Typedef Documentation

RequestType

template<typename Request , typename Reply >

using dds::rpc::ClientEndpoint< Request, Reply >::RequestType = Request

The type used to make function calls.

ReplyType

template<typename Request , typename Reply >

using dds::rpc::ClientEndpoint< Request, Reply >::ReplyType = Reply

The type used to receive the results of function calls.

Constructor & Destructor Documentation

ClientEndpoint()

template<typename Request , typename Reply >

dds::rpc::ClientEndpoint< Request, Reply >::ClientEndpoint ( const ClientParams &  params )

inlineexplicit

Creates a new ClientEndpoint.

Member Function Documentation

close()

template<typename Request , typename Reply >

void dds::rpc::ClientEndpoint< Request, Reply >::close ( )

inline

Destroyes the underlying requester and other resources.

Any operation after close() throws dds::core::AlreadyClosedError

closed()

template<typename Request , typename Reply >

bool dds::rpc::ClientEndpoint< Request, Reply >::closed ( ) const

inline

Whether this instance has been closed already.

wait_for_service()

template<typename Request , typename Reply >

bool dds::rpc::ClientEndpoint< Request, Reply >::wait_for_service ( const dds::core::Duration &  max_wait = dds::core::Duration::infinite() )

inline

Waits for one or more services to be discovered. This function takes advantage of enhanced discovery, making sure both the Client and the Service discover each other.

Parameters

max_wait

The maximum time to wait. Default: dds::core::Duration::infinite() (unlimited period to wait).

Returns

True if a Service is discovered. False if a timeout occurs.

Exceptions

dds::core::AlreadyClosedError

if the Client is closed while waiting.

request_datawriter()

template<typename Request , typename Reply >

dds::pub::DataWriter< RequestType > dds::rpc::ClientEndpoint< Request, Reply >::request_datawriter ( ) const

inline

Accesses the underlying DataWriter that sends the requests (function calls)

Returns

The DataWriter

reply_datareader()

template<typename Request , typename Reply >

dds::sub::DataReader< ReplyType > dds::rpc::ClientEndpoint< Request, Reply >::reply_datareader ( ) const

inline

Accesses the underlying DataReader that receives the replies (return values from the function calls)

Returns

The DataReader