eRPC API Reference  Rev. 1.12.0
NXP Semiconductors
erpc::RequestContext Class Reference

Encapsulates all information about a request. More...

#include <erpc_client_manager.h>

+ Collaboration diagram for erpc::RequestContext:

Public Member Functions

 RequestContext (uint32_t sequence, Codec *codec, bool argIsOneway)
 Constructor. More...
 
CodecgetCodec (void)
 Get inout codec (for writing). More...
 
uint32_t getSequence (void) const
 Get sequence number (be sure that reply belong to current request). More...
 
bool isOneway (void) const
 Returns information if request context is oneway or not. More...
 
void setIsOneway (bool oneway)
 Set request context to be oneway type (only send data). More...
 

Protected Attributes

uint32_t m_sequence
 Sequence number. To be sure that reply belong to current request.
 
Codecm_codec
 Inout codec. Codec for receiving and sending data.
 
bool m_oneway
 When true, request context will be oneway type (only send data).
 

Detailed Description

Encapsulates all information about a request.

Constructor & Destructor Documentation

erpc::RequestContext::RequestContext ( uint32_t  sequence,
Codec codec,
bool  argIsOneway 
)
inline

Constructor.

This function sets request context attributes.

Parameters
[in]sequenceSequence number.
[in]codecSet in inout codec.
[in]isOnewaySet information if codec is only oneway or bidirectional.

Member Function Documentation

Codec* erpc::RequestContext::getCodec ( void  )
inline

Get inout codec (for writing).

Returns
Inout codec.
uint32_t erpc::RequestContext::getSequence ( void  ) const
inline

Get sequence number (be sure that reply belong to current request).

Returns
Sequence number.
bool erpc::RequestContext::isOneway ( void  ) const
inline

Returns information if request context is oneway or not.

Return values
Truewhen request context is oneway direction, else false.
void erpc::RequestContext::setIsOneway ( bool  oneway)
inline

Set request context to be oneway type (only send data).

Returns
Set request context to be oneway.

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