| eRPC API Reference Rev. 1.8.1 NXP Semiconductors

- Main Page
- API Reference
- Classes
- Files

- File List
- File Members

erpc_client_setup.h
Go to the documentation of this file.
1 /*
2 * Copyright (c) 2014-2016, Freescale Semiconductor, Inc.
3 * Copyright 2016-2017 NXP
4 * Copyright 2019 ACRIOS Systems s.r.o.
5 * All rights reserved.
6 *
7 *
8 * SPDX-License-Identifier: BSD-3-Clause
9 */
10
11 #ifndef _EMBEDDED_RPC__CLIENT_SETUP_H_
12 #define _EMBEDDED_RPC__CLIENT_SETUP_H_
13
14 #include "erpc_common.h"
15 #include "erpc_config_internal.h"
16 #include "erpc_mbf_setup.h"
17 #if ERPC_PRE_POST_ACTION
18 #include "erpc_pre_post_action.h"
19 #endif
20 #if ERPC_NESTED_CALLS
21 #include "erpc_server_setup.h"
22 #endif
23 #include "erpc_client_manager.h"
24 #include "erpc_transport_setup.h"
25
32 // API
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 #include <stdbool.h>
41 #include <stdint.h>
42
44
45
54 void erpc_client_init(erpc_transport_t transport, erpc_mbf_t message_buffer_factory);
55
63 void erpc_client_set_error_handler(client_error_handler_t error_handler);
64
74 void erpc_client_set_crc(uint32_t crcStart);
75
76 #if ERPC_NESTED_CALLS
77
82 void erpc_client_set_server(erpc_server_t server);
83
89 void erpc_client_set_server_thread_id(void *serverThreadId);
90 #endif
91
92 #if ERPC_MESSAGE_LOGGING
93
101 bool erpc_client_add_message_logger(erpc_transport_t transport);
102 #endif
103
104 #if ERPC_PRE_POST_ACTION
105
111 void erpc_client_add_pre_cb_action(pre_post_action_cb preCB);
112
119 void erpc_client_add_post_cb_action(pre_post_action_cb postCB);
120 #endif
121
127 void erpc_client_deinit(void);
128
130
131 #ifdef __cplusplus
132 }
133 #endif
134
137 #endif // _EMBEDDED_RPC__CLIENT_SETUP_H_
erpc_transport_t
struct ErpcTransport * erpc_transport_t
Opaque transport object type.
Definition: erpc_transport_setup.h:25
erpc_client_init
void erpc_client_init(erpc_transport_t transport, erpc_mbf_t message_buffer_factory)
This function initializes client.
Definition: erpc_client_setup.cpp:42
erpc_client_manager.h
erpc_mbf_setup.h
erpc_pre_post_action.h
erpc_mbf_t
struct ErpcMessageBufferFactory * erpc_mbf_t
Opaque MessageBufferFactory object type.
Definition: erpc_mbf_setup.h:26
erpc_client_set_error_handler
void erpc_client_set_error_handler(client_error_handler_t error_handler)
This function sets error handler function.
Definition: erpc_client_setup.cpp:62
erpc_transport_setup.h
erpc_server_setup.h
client_error_handler_t
void(* client_error_handler_t)(erpc_status_t err, uint32_t functionID)
Definition: erpc_client_manager.h:32
erpc_client_deinit
void erpc_client_deinit(void)
This function de-initializes client.
Definition: erpc_client_setup.cpp:127
erpc_client_set_crc
void erpc_client_set_crc(uint32_t crcStart)
Can be used to set own crcStart number.
Definition: erpc_client_setup.cpp:70
erpc_server_t
struct ServerType * erpc_server_t
Opaque server object type.
Definition: erpc_server_setup.h:40