CoreDX DDS C# Reference Manual
Public Member Functions | Protected Member Functions | List of all members
ClientEndpoint< TReq, TRep > Class Template Reference
Inheritance diagram for ClientEndpoint< TReq, TRep >:
ServiceProxy< TReq, TRep > RPCEntity

Public Member Functions

 ClientEndpoint (ClientParams cparams)
ClientParams get_client_params ()
- Public Member Functions inherited from ServiceProxy< TReq, TRep >
void close ()
bool is_null ()
void bind (String i_name)
void unbind ()
bool is_bound ()
String get_bound_instance_name ()
List< String > get_discovered_service_instances ()
ReturnCode_t wait_for_service ()
ReturnCode_t wait_for_service (Duration_t maxWait)
ReturnCode_t wait_for_service (String instanceName)
ReturnCode_t wait_for_service (Duration_t max_wait, String instanceName)
ReturnCode_t wait_for_services (uint count)
ReturnCode_t wait_for_services (Duration_t max_wait, uint count)
ReturnCode_t wait_for_services (List< String > instanceNames)
ReturnCode_t wait_for_services (Duration_t max_wait, List< String > instanceNames)

Protected Member Functions

ReturnCode_t send_request (TReq request)
bool receive_reply (Sample< TRep > reply, SampleIdentity_t relatedRequestId)

Detailed Description

A ClientEndpoint provides functions to obtain the underlying DDS entities at the client side. ClientEndpoint inherits from ServiceProxy. A ClientEndpoint shall not be instantiated directly; it can be obtained from a Client object.

Type Constraints
TReq :RequestType 
TReq :new() 
TRep :ReplyType 
TRep :new() 

Constructor & Destructor Documentation

ClientEndpoint ( ClientParams  cparams)

Default constructor

Member Function Documentation

ClientParams get_client_params ( )

Access the ClientParams defining the configuration of this ClientEndpoint.

bool receive_reply ( Sample< TRep >  reply,
SampleIdentity_t  relatedRequestId 

Attempts to access a received reply.

This method accepts a parameter of Sample<TRep> & and a SampleIdentity_t. The call will block until a specific reply is found that matches the identity provided the 'relatedRequestId' parameter.

Return values
boolindicating if a reply was found (true) or not (false).
ReturnCode_t send_request ( TReq  request)

Transmits a request to any matched instances of this service This method accepts a parameter of TReq. Populates request.requestHeader

© 2009-2017 Twin Oaks Computing, Inc
Castle Rock, CO 80108
All rights reserved.