OpenSplice ISO C++ 2 FACE API  v6.x
OpenSplice Future Airborne Capability Environment (FACE) ISO C++ 2 API
Vortex_FACE.hpp
Go to the documentation of this file.
1 /*
2  * Vortex OpenSplice
3  *
4  * This software and documentation are Copyright 2006 to 2021 ADLINK
5  * Technology Limited, its affiliated companies and licensors. All rights
6  * reserved.
7  *
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  * http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  */
20 #ifndef VORTEX_FACE_ISOCPP2_Data_HPP_
21 #define VORTEX_FACE_ISOCPP2_Data_HPP_
22 
23 #include "Vortex_FACE.hpp"
24 #include "Vortex/FACE/Macros.hpp"
25 
26 namespace FACE {
27 namespace TS {
28 
45 void Initialize(
46  /* in */ const FACE::CONFIGURATION_RESOURCE &configuration,
47  /* out */ FACE::RETURN_CODE_TYPE &return_code);
48 
96  /* in */ const FACE::CONNECTION_NAME_TYPE &connection_name,
97  /* in */ const FACE::MESSAGING_PATTERN_TYPE &pattern,
98  /* out */ FACE::CONNECTION_ID_TYPE &connection_id,
99  /* out */ FACE::CONNECTION_DIRECTION_TYPE &connection_direction,
100  /* out */ FACE::MESSAGE_SIZE_TYPE &max_message_size,
101  /* in */ const FACE::TIMEOUT_TYPE &timeout,
102  /* out */ FACE::RETURN_CODE_TYPE &return_code);
103 
129 void Destroy_Connection(
130  /* in */ const FACE::CONNECTION_ID_TYPE &connection_id,
131  /* out */ FACE::RETURN_CODE_TYPE &return_code);
132 
159  /* inout */ FACE::CONNECTION_NAME_TYPE &connection_name,
160  /* inout */ FACE::CONNECTION_ID_TYPE &connection_id,
161  /* out */ FACE::TRANSPORT_CONNECTION_STATUS_TYPE &connection_status,
162  /* out */ FACE::RETURN_CODE_TYPE &return_code);
163 
176  /* in */ const FACE::CONNECTION_ID_TYPE &connection_id,
177  /* out */ FACE::RETURN_CODE_TYPE &return_code);
178 
220 void Receive_Message(
221  /* in */ const FACE::CONNECTION_ID_TYPE &connection_id,
222  /* in */ const FACE::TIMEOUT_TYPE &timeout,
223  /* inout */ FACE::TRANSACTION_ID_TYPE &transaction_id,
224  /* inout */ Data::Type &message,
225  /* inout */ FACE::MESSAGE_TYPE_GUID &message_type_id,
226  /* inout */ FACE::MESSAGE_SIZE_TYPE &message_size,
227  /* out */ FACE::RETURN_CODE_TYPE &return_code);
228 
275 void Send_Message(
276  /* in */ const FACE::CONNECTION_ID_TYPE &connection_id,
277  /* in */ const FACE::TIMEOUT_TYPE &timeout,
278  /* inout */ FACE::TRANSACTION_ID_TYPE &transaction_id,
279  /* inout */ Data::Type &message,
280  /* in */ const FACE::MESSAGE_TYPE_GUID &message_type_id,
281  /* in */ const FACE::MESSAGE_SIZE_TYPE &message_size,
282  /* out */ FACE::RETURN_CODE_TYPE &return_code);
283 
340 void Register_Callback(
341  /* in */ const FACE::CONNECTION_ID_TYPE &connection_id,
342  /* in */ const FACE::WAITSET_TYPE &waitset,
343  /* inout */ FACE::Read_Callback<Data::Type>::send_event data_callback,
344  /* in */ const FACE::MESSAGE_SIZE_TYPE &max_message_size,
345  /* out */ FACE::RETURN_CODE_TYPE &return_code);
346 
347 } /* namespace TS */
348 } /* namespace FACE */
349 
350 #endif /* VORTEX_FACE_ISOCPP2_Data_HPP_ */
void Register_Callback(const FACE::CONNECTION_ID_TYPE &connection_id, const FACE::WAITSET_TYPE &waitset, FACE::Read_Callback< Data::Type >::send_event data_callback, const FACE::MESSAGE_SIZE_TYPE &max_message_size, FACE::RETURN_CODE_TYPE &return_code)
void Unregister_Callback(const FACE::CONNECTION_ID_TYPE &connection_id, FACE::RETURN_CODE_TYPE &return_code)
void Get_Connection_Parameters(FACE::CONNECTION_NAME_TYPE &connection_name, FACE::CONNECTION_ID_TYPE &connection_id, FACE::TRANSPORT_CONNECTION_STATUS_TYPE &connection_status, FACE::RETURN_CODE_TYPE &return_code)
int64_t CONNECTION_ID_TYPE
RETURN_CODE_TYPE
Definition: FACE_common.h:54
void Destroy_Connection(const FACE::CONNECTION_ID_TYPE &connection_id, FACE::RETURN_CODE_TYPE &return_code)
void Create_Connection(const FACE::CONNECTION_NAME_TYPE &connection_name, const FACE::MESSAGING_PATTERN_TYPE &pattern, FACE::CONNECTION_ID_TYPE &connection_id, FACE::CONNECTION_DIRECTION_TYPE &connection_direction, FACE::MESSAGE_SIZE_TYPE &max_message_size, const FACE::TIMEOUT_TYPE &timeout, FACE::RETURN_CODE_TYPE &return_code)
int32_t MESSAGE_SIZE_TYPE
SYSTEM_TIME_TYPE TIMEOUT_TYPE
Definition: FACE_common.h:49
int64_t TRANSACTION_ID_TYPE
void Send_Message(const FACE::CONNECTION_ID_TYPE &connection_id, const FACE::TIMEOUT_TYPE &timeout, FACE::TRANSACTION_ID_TYPE &transaction_id, Data::Type &message, const FACE::MESSAGE_TYPE_GUID &message_type_id, const FACE::MESSAGE_SIZE_TYPE &message_size, FACE::RETURN_CODE_TYPE &return_code)
int64_t MESSAGE_TYPE_GUID
Char CONFIGURATION_RESOURCE[256]
Definition: FACE_common.h:52
dds::core::array< bool, 32 > WAITSET_TYPE
void Initialize(const FACE::CONFIGURATION_RESOURCE &configuration, FACE::RETURN_CODE_TYPE &return_code)
CONNECTION_DIRECTION_TYPE
void Receive_Message(const FACE::CONNECTION_ID_TYPE &connection_id, const FACE::TIMEOUT_TYPE &timeout, FACE::TRANSACTION_ID_TYPE &transaction_id, Data::Type &message, FACE::MESSAGE_TYPE_GUID &message_type_id, FACE::MESSAGE_SIZE_TYPE &message_size, FACE::RETURN_CODE_TYPE &return_code)
Char CONNECTION_NAME_TYPE[64]
MESSAGING_PATTERN_TYPE