iceoryx_binding_c  2.0.2
response_header.h
1 // Copyright (c) 2022 by Apex.AI Inc. All rights reserved.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 //
15 // SPDX-License-Identifier: Apache-2.0
16 
17 #ifndef IOX_BINDING_C_RESPONSE_HEADER_H
18 #define IOX_BINDING_C_RESPONSE_HEADER_H
19 
20 #include "iceoryx_binding_c/chunk.h"
21 #include "iceoryx_binding_c/internal/c2cpp_binding.h"
22 
24 typedef CLASS ResponseHeader* iox_response_header_t;
25 
27 typedef const CLASS ResponseHeader* iox_const_response_header_t;
28 
32 iox_response_header_t iox_response_header_from_payload(void* const payload);
33 
37 iox_const_response_header_t iox_response_header_from_payload_const(const void* const payload);
38 
41 void iox_response_header_set_server_error(iox_response_header_t const self);
42 
46 bool iox_response_header_has_server_error(iox_response_header_t const self);
47 
51 bool iox_response_header_has_server_error_const(iox_const_response_header_t const self);
52 
56 uint8_t iox_response_header_get_rpc_header_version(iox_response_header_t const self);
57 
61 uint8_t iox_response_header_get_rpc_header_version_const(iox_const_response_header_t const self);
62 
66 int64_t iox_response_header_get_sequence_id(iox_response_header_t const self);
67 
71 int64_t iox_response_header_get_sequence_id_const(iox_const_response_header_t const self);
72 
76 void* iox_response_header_get_user_payload(iox_response_header_t const self);
77 
81 const void* iox_response_header_get_user_payload_const(iox_const_response_header_t const self);
82 
86 iox_chunk_header_t* iox_response_header_get_chunk_header(iox_response_header_t const self);
87 
91 const iox_chunk_header_t* iox_response_header_get_chunk_header_const(iox_const_response_header_t const self);
92 
93 #endif
handle of the chunk header
Definition: types.h:66