MIRA
Public Member Functions | List of all members
BinaryRPCBackendTempl< BinaryFormatVersion >::ClientRequest Class Reference

Binary client-side request. More...

#include <rpc/BinaryRPCBackend.h>

Public Member Functions

 ClientRequest (ContainerType *buffer)
 
std::string generateCallID ()
 Generates a unique call ID for a client request of this backend. More...
 
void setHeader (const std::string &callId, const std::string &service, const RPCSignature &signature)
 Write the request header consisting of the call ID, the service name and the signature of the requested method. More...
 
template<typename P >
void setParameter (const P &param)
 Write the value of the next parameter to the request. More...
 

Detailed Description

template<uint8 BinaryFormatVersion>
class mira::BinaryRPCBackendTempl< BinaryFormatVersion >::ClientRequest

Binary client-side request.

The request is written into the buffer that is passed in the constructor.

See also
Backends

Constructor & Destructor Documentation

◆ ClientRequest()

ClientRequest ( ContainerType buffer)
inline

Member Function Documentation

◆ generateCallID()

std::string generateCallID ( )
inline

Generates a unique call ID for a client request of this backend.

As call id a random id is generated.

◆ setHeader()

void setHeader ( const std::string &  callId,
const std::string &  service,
const RPCSignature signature 
)
inline

Write the request header consisting of the call ID, the service name and the signature of the requested method.

This method is called first by the RPCClient when a new request is generated.

◆ setParameter()

void setParameter ( const P &  param)
inline

Write the value of the next parameter to the request.

This method is called multiple times after the setHeader() method for each parameter that is passed to the RPCClient::call() method.


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