Mistake on this page? Email us
client.h
Go to the documentation of this file.
1 /*
2  * ----------------------------------------------------------------------------
3  * Copyright 2018 ARM Ltd.
4  *
5  * SPDX-License-Identifier: Apache-2.0
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  * ----------------------------------------------------------------------------
19  */
20 
21 #ifndef PT_API_VERSION
22 #define PT_API_VERSION 1
23 #endif
24 #if PT_API_VERSION != 1
25 #error "Including mixed versions of Protocol API"
26 #endif
27 
28 #ifndef CLIENT_H_
29 #define CLIENT_H_
30 
31 #ifdef __GNUC__
32 #define DEPRECATED(func) func __attribute__((deprecated))
33 #else
34 #pragma message("WARNING: Implement DEPRECATED macro, it is missing.")
35 #define DEPRECATED(func) func
36 #endif
37 
38 #include "pt-client/pt_api.h"
39 
40 struct context;
41 
64  struct connection* connection_init(struct context *ctx,
65  client_data_t *client_data,
66  const protocol_translator_callbacks_t *pt_cbs,
67  void *userdata));
74 DEPRECATED(void pt_client_set_msg_id_generator(generate_msg_id generate_msg_id));
75 
83 DEPRECATED(void pt_client_final_cleanup());
84 
90 #endif /* CLIENT_H_ */
char *(* generate_msg_id)()
A prototype of the ID generation function.
Definition: default_message_id_generator.h:41
Definition: pt_api.h:334
A structure to hold the callbacks of the protocol translator.
Definition: pt_api.h:344
DEPRECATED(struct connection *connection_init(struct context *ctx, client_data_t *client_data, const protocol_translator_callbacks_t *pt_cbs, void *userdata))
Initializes the connection structure between Device Management Edge and the connected protocol transl...
**Deprecated** Protocol translator client for API v1.