![]() |
eRPC API Reference
Rev. 1.9.0
NXP Semiconductors
|
Base client implementation. More...
#include <erpc_client_manager.h>
Inheritance diagram for erpc::ClientManager:
Collaboration diagram for erpc::ClientManager:Public Member Functions | |
| ClientManager (void) | |
| Constructor. More... | |
| virtual | ~ClientManager (void) |
| ClientManager destructor. | |
| void | setMessageBufferFactory (MessageBufferFactory *factory) |
| This function sets message buffer factory to use. More... | |
| void | setCodecFactory (CodecFactory *factory) |
| This function sets codec factory to use. More... | |
| void | setTransport (Transport *transport) |
| This function sets transport layer to use. More... | |
| virtual RequestContext | createRequest (bool isOneway) |
| This function creates request context. More... | |
| virtual void | performRequest (RequestContext &request) |
| This function performs request. More... | |
| virtual void | releaseRequest (RequestContext &request) |
| This function releases request context. More... | |
| void | setErrorHandler (client_error_handler_t error_handler) |
| This function sets error handler function for infrastructure errors. More... | |
| void | callErrorHandler (erpc_status_t err, uint32_t functionID) |
| This function calls error handler callback function with given status. More... | |
Public Member Functions inherited from erpc::ClientServerCommon | |
| ClientServerCommon (void) | |
| ClientServerCommon constructor. | |
| ~ClientServerCommon (void) | |
| ClientServerCommon destructor. | |
Protected Member Functions | |
| virtual void | performClientRequest (RequestContext &request) |
| This function performs request. More... | |
| virtual void | verifyReply (RequestContext &request) |
| Validate that an incoming message is a reply. | |
| Codec * | createBufferAndCodec (void) |
| Create message buffer and codec. More... | |
Protected Attributes | |
| MessageBufferFactory * | m_messageFactory |
| Message buffer factory to use. | |
| CodecFactory * | m_codecFactory |
| Codec to use. | |
| Transport * | m_transport |
| Transport layer to use. | |
| uint32_t | m_sequence |
| Sequence number. | |
| client_error_handler_t | m_errorHandler |
| Pointer to function error handler. | |
Base client implementation.
|
inline |
Constructor.
This function initializes object attributes.
|
inline |
This function sets message buffer factory to use.
| [in] | factory | Message buffer factory to use. |
|
inline |
This function sets codec factory to use.
| [in] | factory | Codec factory to use. |
| void ClientManager::setTransport | ( | Transport * | transport | ) |
This function sets transport layer to use.
It also set messageBufferFactory to the same as in transport layer.
| [in] | transport | Transport layer to use. |
|
virtual |
This function creates request context.
| [in] | isOneway | True if need send data only, else false. |
|
virtual |
This function performs request.
| [in] | request | Request context to perform. |
|
virtual |
This function releases request context.
| [in] | request | Request context to release. |
|
inline |
This function sets error handler function for infrastructure errors.
| [in] | error_handler | Pointer to error handler function. |
| void ClientManager::callErrorHandler | ( | erpc_status_t | err, |
| uint32_t | functionID | ||
| ) |
This function calls error handler callback function with given status.
Function is called in client shim code at the end of function when error occurred.
| [in] | err | Specify function status at the end of eRPC call. |
| [in] | functionID | Specify eRPC function call. |
|
protectedvirtual |
This function performs request.
Should be called in non server context (do not call another eRPC function in server remote call implementation).
| [in] | request | Request context to perform. |
Reimplemented in erpc::ArbitratedClientManager.
|
protected |
Create message buffer and codec.
The new codec is set to use the new message buffer. Both codec and buffer are allocated with the relevant factories.