eRPC API Reference
Rev. 1.12.0
NXP Semiconductors
|
Client side setup functions. More...
Client side setup functions.
Files | |
file | erpc_arbitrated_client_setup.h |
file | erpc_client_setup.h |
Arbitrated client setup | |
erpc_client_t | erpc_arbitrated_client_init (erpc_transport_t transport, erpc_mbf_t message_buffer_factory, erpc_transport_t *arbitrator) |
Initializes a client that shares its transport with the server. More... | |
void | erpc_arbitrated_client_set_error_handler (erpc_client_t client, client_error_handler_t error_handler) |
This function sets error handler function. More... | |
void | erpc_arbitrated_client_set_crc (erpc_client_t client, uint32_t crcStart) |
Can be used to set own crcStart number. More... | |
void | erpc_arbitrated_client_deinit (erpc_client_t client) |
This function de-initializes client. More... | |
Client setup | |
erpc_client_t | erpc_client_init (erpc_transport_t transport, erpc_mbf_t message_buffer_factory) |
This function initializes client. More... | |
void | erpc_client_set_error_handler (erpc_client_t client, client_error_handler_t error_handler) |
This function sets error handler function. More... | |
void | erpc_client_set_crc (erpc_client_t client, uint32_t crcStart) |
Can be used to set own crcStart number. More... | |
void | erpc_client_deinit (erpc_client_t client) |
This function de-initializes client. More... | |
erpc_client_t erpc_arbitrated_client_init | ( | erpc_transport_t | transport, |
erpc_mbf_t | message_buffer_factory, | ||
erpc_transport_t * | arbitrator | ||
) |
Initializes a client that shares its transport with the server.
This function initializes a client with all components necessary for sending client requests using the same transport instance as used by a server. Only one instance of the shared transport should be created. The transport arbitrator that wraps the shared transport is returned. This arbitrator, not the shared transport, should be passed to the server setup routine.
Example use:
[in] | transport | Initiated transport. |
[in] | message_buffer_factory | Initiated message buffer factory. |
[out] | arbitrator | Transport arbitrator reference that should be passed to the server setup API. |
void erpc_arbitrated_client_set_error_handler | ( | erpc_client_t | client, |
client_error_handler_t | error_handler | ||
) |
This function sets error handler function.
Given error_handler function is called when error occur inside eRPC infrastructure.
[in] | client | Pointer to client structure. |
[in] | error_handler | Pointer to function error handler. |
void erpc_arbitrated_client_set_crc | ( | erpc_client_t | client, |
uint32_t | crcStart | ||
) |
Can be used to set own crcStart number.
For example can be used generated crc from erpcgen which is providing when annotation is used. Accessed can be through 'extern const uint32_t erpc_generated_crc;'
[in] | client | Pointer to client structure. |
[in] | crcStart | Set start number for crc. |
void erpc_arbitrated_client_deinit | ( | erpc_client_t | client | ) |
This function de-initializes client.
This function de-initializes client and all components which it own.
[in] | client | Pointer to client structure. |
erpc_client_t erpc_client_init | ( | erpc_transport_t | transport, |
erpc_mbf_t | message_buffer_factory | ||
) |
This function initializes client.
This function initializes client with all components necessary for serve client request.
[in] | transport | Initiated transport. |
[in] | message_buffer_factory | Initiated message buffer factory. |
void erpc_client_set_error_handler | ( | erpc_client_t | client, |
client_error_handler_t | error_handler | ||
) |
This function sets error handler function.
Given error_handler function is called when error occur inside eRPC infrastructure.
[in] | client | Pointer to client structure. |
[in] | error_handler | Pointer to function error handler. |
void erpc_client_set_crc | ( | erpc_client_t | client, |
uint32_t | crcStart | ||
) |
Can be used to set own crcStart number.
For example can be used generated crc from erpcgen which is providing when annotation is used. Accessed can be through 'extern const uint32_t erpc_generated_crc;'
[in] | client | Pointer to client structure. |
[in] | crcStart | Set start number for crc. |
void erpc_client_deinit | ( | erpc_client_t | client | ) |
This function de-initializes client.
This function de-initializes client and all components which it own.
[in] | client | Pointer to client structure. |