| helics 3.6.1

ActionMessageDefintions.hpp
1 /*
2 Copyright (c) 2017-2025,
3 Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable
4 Energy, LLC. See the top-level NOTICE for additional details. All rights reserved.
5 SPDX-License-Identifier: BSD-3-Clause
6 */
7 #pragma once
8
9 #include "../helics_enums.h"
10
11 #include <cstdint>
12 namespace helics {
14 namespace action_message_def {
15 constexpr int32_t cmd_info_basis = 0x10000000;
16
20 enum class action_t : int32_t {
21 // priority commands ALL priority commands have a negative code
22 cmd_priority_disconnect =
23 -3,
24 cmd_fed_ack =
25 -25,
26
27 cmd_broker_ack = -27, // a reply to the connect command with a global route id
28 cmd_add_route = -32,
29 cmd_route_ack = -16,
30 cmd_register_route = -15,
31 cmd_reg_fed = -105,
32 cmd_priority_ack =
33 -254,
35 cmd_query = -cmd_info_basis - 37,
36 cmd_query_ordered =
37 937,
38 cmd_set_global = -cmd_info_basis - 55,
39 cmd_broker_query = -37,
40 cmd_interface_query = -39,
41 cmd_broker_query_ordered = 939,
42 cmd_query_reply = -cmd_info_basis - 38,
43 cmd_query_reply_ordered = 942,
44 cmd_reg_broker =
45 -cmd_info_basis - 40,
46 cmd_broker_location = cmd_info_basis - 57,
47
48 cmd_send_command = -95,
49 cmd_command_response = -98,
50 cmd_send_command_ordered = 95,
51 cmd_command_response_ordered = 98,
52 cmd_broker_setup = -1,
53 cmd_ignore = 0,
54 cmd_tick = 1,
55 cmd_user_disconnect = 2,
56 cmd_disconnect = 3,
57 cmd_disconnect_name = 4,
58 cmd_disconnect_check = 5,
59 cmd_disconnect_fed = 6,
60 cmd_broadcast_disconnect = 7,
61 cmd_disconnect_core = 8,
62 cmd_disconnect_broker = 9,
63 cmd_global_disconnect = 1002,
64 cmd_timeout_disconnect = 1003,
65 cmd_disconnect_fed_ack = 1006,
66 cmd_disconnect_core_ack = 1008,
67 cmd_disconnect_broker_ack = 1009,
68 cmd_check_connections = 297,
69 cmd_ping = 298,
70 cmd_ping_priority = -298,
71 cmd_ping_reply = 299,
72 cmd_broker_ping = 306,
73 cmd_init = 10,
74 cmd_init_grant = 11,
75 cmd_init_not_ready = 12,
76 cmd_exec_request = 20,
77 cmd_exec_grant = 22,
78 cmd_exec_check = 24,
79 cmd_ack = 254,
80 cmd_timing_info = 310,
81
82 cmd_stop = 30,
83 cmd_terminate_immediately = 31,
84
85 cmd_time_grant = 35,
86 cmd_time_check = 36,
87 cmd_request_current_time =
88 38,
89 cmd_grant_timeout_check = 439,
91 cmd_user_return = 535,
92 cmd_time_block = 40,
93 cmd_time_unblock = 41,
94 cmd_time_barrier_request = 42,
95 cmd_time_barrier = 43,
96 cmd_time_barrier_clear = 44,
97
98 cmd_pub = 52,
99 cmd_bye = 2000,
100 cmd_log = 55,
101 cmd_remote_log = 2055,
102 cmd_warning = 9990,
103 cmd_error = 10000,
104 cmd_local_error = 10003,
105 cmd_global_error = 10005,
107 cmd_error_check = 10001,
108 cmd_invalid = 1010101,
109 cmd_send_route = 75,
110 cmd_search_dependency = 1464,
111 cmd_add_dependency = 140,
112 cmd_remove_dependency = 141,
113 cmd_add_dependent = 144,
114 cmd_remove_dependent =
115 145,
116 cmd_add_interdependency =
117 148,
118 cmd_remove_interdependency =
119 149,
120
121 cmd_data_link =
122 cmd_info_basis + 707,
123 cmd_filter_link = cmd_info_basis + 709,
124 cmd_endpoint_link = cmd_info_basis + 711,
125 cmd_add_alias = cmd_info_basis + 715,
126
127 cmd_fed_configure_time =
128 202,
129 cmd_fed_configure_int =
130 203,
131 cmd_fed_configure_flag =
132 204,
133 cmd_core_configure = 207,
134 cmd_interface_configure = 209,
135 cmd_broker_configure = 211,
136 cmd_base_configure = 213,
137
138 cmd_interface_tag = 218,
139
140 cmd_core_tag = 220,
141 cmd_broker_tag = 222,
142
143 cmd_profiler_data = 496,
144 cmd_set_profiler_flag = 498,
145 cmd_update_filter_op =
146 10427,
147 null_info_command =
148 cmd_info_basis - 1,
150 priority_null_info_command = -cmd_info_basis - 1,
151 // commands that require the extra info allocation have numbers greater than cmd_info_basis
152 cmd_time_request = 500,
153 cmd_force_time_grant =
154 525,
155
156 cmd_send_message = cmd_info_basis + 20,
157 cmd_null_message = 726,
158 cmd_null_dest_message = 730,
159 cmd_send_for_filter = cmd_info_basis +
160 30,
161 cmd_send_for_dest_filter_return =
162 cmd_info_basis + 31,
163 cmd_send_for_filter_return =
164 cmd_info_basis + 35,
165 cmd_filter_result =
166 cmd_info_basis + 40,
167 cmd_dest_filter_result = cmd_info_basis +
168 41,
169 cmd_reg_pub = cmd_info_basis + 50,
170 cmd_add_publisher = 50,
171 cmd_reg_filter = cmd_info_basis + 60,
172 cmd_add_filter = 62,
173 cmd_reg_input = cmd_info_basis + 70,
174 cmd_add_subscriber = 70,
175 cmd_reg_translator = cmd_info_basis + 80,
176
177 cmd_reg_end = cmd_info_basis + 90,
178 cmd_reg_datasink = cmd_info_basis + 95,
179 cmd_add_endpoint = 90,
180
181 cmd_add_named_input = 104,
182 cmd_add_named_filter = 105,
183 cmd_add_named_publication = 106,
184 cmd_add_named_endpoint = 107,
185
186 cmd_remove_named_input = 124,
187 cmd_remove_named_filter = 125,
188 cmd_remove_named_publication =
189 126,
190 cmd_remove_named_endpoint = 127,
191
192 cmd_remove_subscriber = 134,
193 cmd_remove_filter = 135,
194 cmd_remove_publication = 136,
195 cmd_remove_endpoint = 137,
196
197 cmd_close_interface = 133,
198 cmd_multi_message = 1037,
199
200 cmd_connection_error = 2034,
201
202 cmd_protocol_priority =
203 -60000,
204 cmd_protocol = 60000,
205 cmd_protocol_big = cmd_info_basis +
206 60000,
207 cmd_resend = 121212
208 };
209
210 } // namespace action_message_def
211
212 #define CMD_IGNORE action_message_def::action_t::cmd_ignore
213 #define CMD_INVALID action_message_def::action_t::cmd_invalid
214 #define CMD_TICK action_message_def::action_t::cmd_tick
215 #define CMD_REG_BROKER action_message_def::action_t::cmd_reg_broker
216 #define CMD_PRIORITY_DISCONNECT action_message_def::action_t::cmd_priority_disconnect
217 #define CMD_USER_DISCONNECT action_message_def::action_t::cmd_user_disconnect
218 #define CMD_TIMEOUT_DISCONNECT action_message_def::action_t::cmd_timeout_disconnect
219 #define CMD_GLOBAL_DISCONNECT action_message_def::action_t::cmd_global_disconnect
220 #define CMD_DISCONNECT action_message_def::action_t::cmd_disconnect
221 #define CMD_DISCONNECT_NAME action_message_def::action_t::cmd_disconnect_name
222 #define CMD_DISCONNECT_CHECK action_message_def::action_t::cmd_disconnect_check
223 #define CMD_DISCONNECT_FED action_message_def::action_t::cmd_disconnect_fed
224 #define CMD_BROADCAST_DISCONNECT action_message_def::action_t::cmd_broadcast_disconnect
225
226 #define CMD_DISCONNECT_CORE action_message_def::action_t::cmd_disconnect_core
227 #define CMD_DISCONNECT_BROKER action_message_def::action_t::cmd_disconnect_broker
228 #define CMD_DISCONNECT_FED_ACK action_message_def::action_t::cmd_disconnect_fed_ack
229 #define CMD_DISCONNECT_CORE_ACK action_message_def::action_t::cmd_disconnect_core_ack
230 #define CMD_DISCONNECT_BROKER_ACK action_message_def::action_t::cmd_disconnect_broker_ack
231 #define CMD_CONNECTION_ERROR action_message_def::action_t::cmd_connection_error
232
233 #define CMD_CHECK_CONNECTIONS action_message_def::action_t::cmd_check_connections
234 #define CMD_PING action_message_def::action_t::cmd_ping
235 #define CMD_PING_PRIORITY action_message_def::action_t::cmd_ping_priority
236
237 #define CMD_BROKER_PING action_message_def::action_t::cmd_broker_setup
238 #define CMD_PING_REPLY action_message_def::action_t::cmd_ping_reply
239 #define CMD_BROKER_SETUP action_message_def::action_t::cmd_broker_setup
240 #define CMD_BROKER_LOCATION action_message_def::action_t::cmd_broker_location
241
242 #define CMD_INIT action_message_def::action_t::cmd_init
243 #define CMD_INIT_NOT_READY action_message_def::action_t::cmd_init_not_ready
244 #define CMD_INIT_GRANT action_message_def::action_t::cmd_init_grant
245 #define CMD_TIMING_INFO action_message_def::action_t::cmd_timing_info
246 #define CMD_EXEC_REQUEST action_message_def::action_t::cmd_exec_request
247 #define CMD_EXEC_GRANT action_message_def::action_t::cmd_exec_grant
248 #define CMD_EXEC_CHECK action_message_def::action_t::cmd_exec_check
249 #define CMD_REG_ROUTE action_message_def::action_t::cmd_register_route
250 #define CMD_ROUTE_ACK action_message_def::action_t::cmd_route_ack
251 #define CMD_STOP action_message_def::action_t::cmd_stop
252 #define CMD_TERMINATE_IMMEDIATELY action_message_def::action_t::cmd_terminate_immediately
253 #define CMD_TIME_REQUEST action_message_def::action_t::cmd_time_request
254 #define CMD_TIME_GRANT action_message_def::action_t::cmd_time_grant
255 #define CMD_FORCE_TIME_GRANT action_message_def::action_t::cmd_force_time_grant
256 #define CMD_TIME_CHECK action_message_def::action_t::cmd_time_check
257 #define CMD_GRANT_TIMEOUT_CHECK action_message_def::action_t::cmd_grant_timeout_check
258 #define CMD_REQUEST_CURRENT_TIME action_message_def::action_t::cmd_request_current_time
259 #define CMD_USER_RETURN action_message_def::action_t::cmd_user_return
260
261 #define CMD_TIME_BLOCK action_message_def::action_t::cmd_time_block
262 #define CMD_TIME_UNBLOCK action_message_def::action_t::cmd_time_unblock
263
264 #define CMD_TIME_BARRIER_REQUEST action_message_def::action_t::cmd_time_barrier_request
265 #define CMD_TIME_BARRIER action_message_def::action_t::cmd_time_barrier
266 #define CMD_TIME_BARRIER_CLEAR action_message_def::action_t::cmd_time_barrier_clear
267
268 #define CMD_SEND_MESSAGE action_message_def::action_t::cmd_send_message
269 #define CMD_SEND_FOR_FILTER action_message_def::action_t::cmd_send_for_filter
270 #define CMD_SEND_FOR_FILTER_AND_RETURN action_message_def::action_t::cmd_send_for_filter_return
271 #define CMD_SEND_FOR_DEST_FILTER_AND_RETURN \
272 action_message_def::action_t::cmd_send_for_dest_filter_return
273 #define CMD_NULL_MESSAGE action_message_def::action_t::cmd_null_message
274 #define CMD_NULL_DEST_MESSAGE action_message_def::action_t::cmd_null_dest_message
275 #define CMD_FILTER_RESULT action_message_def::action_t::cmd_filter_result
276 #define CMD_DEST_FILTER_RESULT action_message_def::action_t::cmd_dest_filter_result
277
278 #define CMD_PUB action_message_def::action_t::cmd_pub
279 #define CMD_LOG action_message_def::action_t::cmd_log
280 #define CMD_REMOTE_LOG action_message_def::action_t::cmd_remote_log
281 #define CMD_WARNING action_message_def::action_t::cmd_warning
282 #define CMD_ERROR action_message_def::action_t::cmd_error
283 #define CMD_GLOBAL_ERROR action_message_def::action_t::cmd_global_error
284 #define CMD_LOCAL_ERROR action_message_def::action_t::cmd_local_error
285 #define CMD_ERROR_CHECK action_message_def::action_t::cmd_error_check
286
287 #define CMD_RESEND action_message_def::action_t::cmd_resend
288
289 #define CMD_REG_PUB action_message_def::action_t::cmd_reg_pub
290 #define CMD_ADD_PUBLISHER action_message_def::action_t::cmd_add_publisher
291 #define CMD_REG_INPUT action_message_def::action_t::cmd_reg_input
292 #define CMD_ADD_SUBSCRIBER action_message_def::action_t::cmd_add_subscriber
293
294 #define CMD_REG_TRANSLATOR action_message_def::action_t::cmd_reg_translator
295
296 #define CMD_ADD_NAMED_ENDPOINT action_message_def::action_t::cmd_add_named_endpoint
297 #define CMD_ADD_NAMED_FILTER action_message_def::action_t::cmd_add_named_filter
298 #define CMD_ADD_NAMED_PUBLICATION action_message_def::action_t::cmd_add_named_publication
299 #define CMD_ADD_NAMED_INPUT action_message_def::action_t::cmd_add_named_input
300
301 #define CMD_REMOVE_NAMED_ENDPOINT action_message_def::action_t::cmd_remove_named_endpoint
302 #define CMD_REMOVE_NAMED_FILTER action_message_def::action_t::cmd_remove_named_filter
303 #define CMD_REMOVE_NAMED_PUBLICATION action_message_def::action_t::cmd_remove_named_publication
304 #define CMD_REMOVE_NAMED_INPUT action_message_def::action_t::cmd_remove_named_input
305
306 #define CMD_REMOVE_ENDPOINT action_message_def::action_t::cmd_remove_endpoint
307 #define CMD_REMOVE_FILTER action_message_def::action_t::cmd_remove_filter
308 #define CMD_REMOVE_PUBLICATION action_message_def::action_t::cmd_remove_publication
309 #define CMD_REMOVE_SUBSCRIBER action_message_def::action_t::cmd_remove_subscriber
310
311 #define CMD_CLOSE_INTERFACE action_message_def::action_t::cmd_close_interface
312
313 #define CMD_DATA_LINK action_message_def::action_t::cmd_data_link
314 #define CMD_FILTER_LINK action_message_def::action_t::cmd_filter_link
315 #define CMD_ENDPOINT_LINK action_message_def::action_t::cmd_endpoint_link
316 #define CMD_ADD_ALIAS action_message_def::action_t::cmd_add_alias
317
318 #define CMD_REMOVE_NAMED_TARGET action_message_def::action_t::cmd_remove_named_target
319 #define CMD_REMOVE_TARGET action_message_def::action_t::cmd_remove_target
320
321 #define CMD_REG_ENDPOINT action_message_def::action_t::cmd_reg_end
322 #define CMD_ADD_ENDPOINT action_message_def::action_t::cmd_add_endpoint
323
324 #define CMD_REG_DATASINK action_message_def::action_t::cmd_reg_datasink
325
326 #define CMD_REG_FILTER action_message_def::action_t::cmd_reg_filter
327 #define CMD_ADD_FILTER action_message_def::action_t::cmd_add_filter
328
329 #define CMD_SEARCH_DEPENDENCY action_message_def::action_t::cmd_search_dependency
330 #define CMD_ADD_DEPENDENCY action_message_def::action_t::cmd_add_dependency
331 #define CMD_REMOVE_DEPENDENCY action_message_def::action_t::cmd_remove_dependency
332 #define CMD_ADD_DEPENDENT action_message_def::action_t::cmd_add_dependent
333 #define CMD_REMOVE_DEPENDENT action_message_def::action_t::cmd_remove_dependent
334 #define CMD_ADD_INTERDEPENDENCY action_message_def::action_t::cmd_add_interdependency
335 #define CMD_REMOVE_INTERDEPENDENCY action_message_def::action_t::cmd_remove_interdependency
336
337 #define CMD_REG_FED action_message_def::action_t::cmd_reg_fed
338 #define CMD_BROKER_ACK action_message_def::action_t::cmd_broker_ack
339 #define CMD_FED_ACK action_message_def::action_t::cmd_fed_ack
340 #define CMD_PROTOCOL_PRIORITY action_message_def::action_t::cmd_protocol_priority
341 #define CMD_PROTOCOL action_message_def::action_t::cmd_protocol
342 #define CMD_PROTOCOL_BIG action_message_def::action_t::cmd_protocol_big
343
344 #define CMD_FED_CONFIGURE_TIME action_message_def::action_t::cmd_fed_configure_time
345 #define CMD_FED_CONFIGURE_INT action_message_def::action_t::cmd_fed_configure_int
346 #define CMD_FED_CONFIGURE_FLAG action_message_def::action_t::cmd_fed_configure_flag
347 #define CMD_INTERFACE_CONFIGURE action_message_def::action_t::cmd_interface_configure
348
349 #define CMD_CORE_CONFIGURE action_message_def::action_t::cmd_core_configure
350 #define CMD_BROKER_CONFIGURE action_message_def::action_t::cmd_broker_configure
351 #define CMD_BASE_CONFIGURE action_message_def::action_t::cmd_base_configure
352 #define CMD_INTERFACE_TAG action_message_def::action_t::cmd_interface_tag
353 #define CMD_CORE_TAG action_message_def::action_t::cmd_core_tag
354 #define CMD_BROKER_TAG action_message_def::action_t::cmd_broker_tag
355 #define CMD_PROFILER_DATA action_message_def::action_t::cmd_profiler_data
356 #define CMD_SET_PROFILER_FLAG action_message_def::action_t::cmd_set_profiler_flag
357
358 #define CMD_ACK action_message_def::action_t::cmd_ack
359 #define CMD_PRIORITY_ACK action_message_def::action_t::cmd_priority_ack
360
361 #define CMD_QUERY action_message_def::action_t::cmd_query
362 #define CMD_QUERY_ORDERED action_message_def::action_t::cmd_query_ordered
363 #define CMD_BROKER_QUERY action_message_def::action_t::cmd_broker_query
364 #define CMD_BROKER_QUERY_ORDERED action_message_def::action_t::cmd_broker_query_ordered
365 #define CMD_INTERFACE_QUERY action_message_def::action_t::cmd_interface_query
366 #define CMD_QUERY_REPLY action_message_def::action_t::cmd_query_reply
367 #define CMD_QUERY_REPLY_ORDERED action_message_def::action_t::cmd_query_reply_ordered
368 #define CMD_SET_GLOBAL action_message_def::action_t::cmd_set_global
369
370 #define CMD_SEND_COMMAND action_message_def::action_t::cmd_send_command
371 #define CMD_SEND_COMMAND_ORDERED action_message_def::action_t::cmd_send_command_ordered
372 #define CMD_COMMAND_RESPONSE action_message_def::action_t::cmd_command_response
373 #define CMD_COMMAND_RESPONSE_ORDERED action_message_def::action_t::cmd_command_response_ordered
374
375 #define CMD_MULTI_MESSAGE action_message_def::action_t::cmd_multi_message
376
377 // definitions for the protocol options
378 #define PROTOCOL_PING 10
379 #define PROTOCOL_PONG 11
380 #define CLOSE_RECEIVER 23425215
382 #define PAUSE_TRANSMITTER 453623
383 #define ALLOW_MESSAGES 453624
384 #define UNPAUSE_TRANSMITTER 453625
385 // routing information
386 #define NEW_ROUTE 233
387 #define REMOVE_ROUTE 244
388 #define CONNECTION_INFORMATION 299
389 #define CONNECTION_REQUEST 301
390 #define CONNECTION_ACK 304
391 #define CONNECTION_TEST 307
392 #define NEW_BROKER_INFORMATION 333
393 #define DISCONNECT 2523
394 #define DISCONNECT_ERROR 2623
395 #define DELAY_CONNECTION 3795
396
397 #define NAME_NOT_FOUND 2726
398 #define RECONNECT_TRANSMITTER 1997
399 #define RECONNECT_RECEIVER 1999
400 // for requesting port definitions on a computer
401 #define PORT_DEFINITIONS 1451
402 #define QUERY_PORTS 1453
403 #define REQUEST_PORTS 1455
404 #define SET_USED_PORTS 1457
405 #define NULL_REPLY 0;
406
407 // definitions related to Core Configure
408 #define UPDATE_FILTER_OPERATOR 572
409 #define UPDATE_TRANSLATOR_OPERATOR 574
410 #define UPDATE_FEDERATE_OPERATOR 576
411 #define UPDATE_QUERY_CALLBACK 581
412 #define UPDATE_LOGGING_CALLBACK 592
413 #define UPDATE_LOGGING_FILE 594
414 #define REQUEST_TICK_FORWARDING 607
415
420 const char* actionMessageType(action_message_def::action_t action);
421
422 enum CommandErrorCodes : int {
423 lost_server_connection_code = -5,
424 connection_error_code = -2,
425 already_init_error_code = 5,
426 duplicate_federate_name_error_code = 6,
427 duplicate_broker_name_error_code = 7,
428 mismatch_broker_key_error_code = 9,
429 max_federate_count_exceeded = 11,
430 max_broker_count_exceeded = 13,
431 broker_terminating = 14,
432 multiple_wait_for_current_time_flags = 15,
433 duplicate_federate_id = 17
434 };
435
440 const char* commandErrorString(int errorCode);
441
442 } // namespace helics
helics::action_message_def::action_t
action_t
Definition: ActionMessageDefintions.hpp:20
helics::action_message_def::action_t::cmd_interface_query
@ cmd_interface_query
send a query to a core
helics::action_message_def::action_t::cmd_user_return
@ cmd_user_return
return from processing
helics::action_message_def::action_t::cmd_update_filter_op
@ cmd_update_filter_op
command to update a filter op [should only used internal to a core]
helics::action_message_def::action_t::cmd_ping
@ cmd_ping
request for an Echo response
helics::action_message_def::action_t::cmd_search_dependency
@ cmd_search_dependency
command to add a dependency by name
helics::action_message_def::action_t::cmd_disconnect_fed
@ cmd_disconnect_fed
disconnect a federate
helics::action_message_def::action_t::cmd_add_dependency
@ cmd_add_dependency
command to send a federate dependency information
helics::action_message_def::action_t::cmd_local_error
@ cmd_local_error
indicate a local error within a federate/core/broker
helics::action_message_def::action_t::cmd_send_command
@ cmd_send_command
command to send a command to a command interface
helics::action_message_def::action_t::cmd_disconnect_core
@ cmd_disconnect_core
disconnect a core
helics::action_message_def::action_t::cmd_command_response_ordered
@ cmd_command_response_ordered
command containing a response to a command
helics::action_message_def::action_t::cmd_ignore
@ cmd_ignore
null command
helics::action_message_def::action_t::cmd_disconnect_broker
@ cmd_disconnect_broker
disconnect a broker
helics::action_message_def::action_t::cmd_remove_subscriber
@ cmd_remove_subscriber
cmd to remove a target from connection
helics::action_message_def::action_t::cmd_add_dependent
@ cmd_add_dependent
command to add a dependent to a federate
helics::action_message_def::action_t::cmd_global_disconnect
@ cmd_global_disconnect
disconnect a federation
helics::action_message_def::action_t::cmd_command_response
@ cmd_command_response
command containing a response to a command
helics::action_message_def::action_t::cmd_global_error
@ cmd_global_error
helics::action_message_def::action_t::cmd_error
@ cmd_error
indicate an error with a federate
helics::action_message_def::action_t::cmd_resend
@ cmd_resend
command to resend some data
helics::action_message_def::action_t::cmd_time_grant
@ cmd_time_grant
grant a time or iteration
helics::action_message_def::action_t::cmd_fed_configure_flag
@ cmd_fed_configure_flag
command to update the configuration of a federate a flag parameter
helics::action_message_def::action_t::cmd_init_not_ready
@ cmd_init_not_ready
retract an init ready command
helics::action_message_def::action_t::cmd_fed_configure_time
@ cmd_fed_configure_time
command to update the configuration of a federate a time parameter
helics::action_message_def::action_t::cmd_check_connections
@ cmd_check_connections
command to check for any connections
helics::action_message_def::action_t::cmd_reg_pub
@ cmd_reg_pub
register a publication
helics::action_message_def::action_t::cmd_disconnect_fed_ack
@ cmd_disconnect_fed_ack
federate disconnect ack
helics::action_message_def::action_t::cmd_core_tag
@ cmd_core_tag
command to update a tag on a core
helics::action_message_def::action_t::cmd_set_global
@ cmd_set_global
set a global value
helics::action_message_def::action_t::cmd_warning
@ cmd_warning
indicate some sort of warning
helics::action_message_def::action_t::cmd_time_barrier_request
@ cmd_time_barrier_request
request a time barrier
helics::action_message_def::action_t::cmd_route_ack
@ cmd_route_ack
acknowledge reply to a route registration
helics::action_message_def::action_t::cmd_ping_priority
@ cmd_ping_priority
request for an Echo response on priority channel
helics::action_message_def::action_t::cmd_query_ordered
@ cmd_query_ordered
send a query along the synchronous paths instead of priority channels
helics::action_message_def::action_t::cmd_add_named_input
@ cmd_add_named_input
command to add a named input as a target
helics::action_message_def::action_t::cmd_multi_message
@ cmd_multi_message
cmd that encapsulates a bunch of messages in its payload
helics::action_message_def::action_t::cmd_interface_configure
@ cmd_interface_configure
command to update the configuration of an interface
helics::action_message_def::action_t::cmd_query
@ cmd_query
send a query this is a priority command
helics::action_message_def::action_t::cmd_reg_fed
@ cmd_reg_fed
register a federate
helics::action_message_def::action_t::cmd_exec_grant
@ cmd_exec_grant
grant entry to exec mode or iterate
helics::action_message_def::action_t::cmd_remove_named_publication
@ cmd_remove_named_publication
cmd to remove a publication from connection by name
helics::action_message_def::action_t::cmd_reg_input
@ cmd_reg_input
register an input interface
helics::action_message_def::action_t::cmd_disconnect_broker_ack
@ cmd_disconnect_broker_ack
ack for broker disconnect
helics::action_message_def::action_t::cmd_reg_end
@ cmd_reg_end
register an endpoint
helics::action_message_def::action_t::cmd_disconnect_name
@ cmd_disconnect_name
disconnect a broker or core by name vs id
helics::action_message_def::action_t::cmd_query_reply
@ cmd_query_reply
response to a query
helics::action_message_def::action_t::cmd_reg_broker
@ cmd_reg_broker
for a broker to connect with a higher level broker
helics::action_message_def::action_t::cmd_fed_configure_int
@ cmd_fed_configure_int
command to update the configuration of a federate an int parameter
helics::action_message_def::action_t::cmd_broker_location
@ cmd_broker_location
command to define a new broker location
helics::action_message_def::action_t::cmd_request_current_time
@ cmd_request_current_time
command to request the current time status of a federate
helics::action_message_def::action_t::priority_null_info_command
@ priority_null_info_command
helics::action_message_def::action_t::cmd_disconnect_check
@ cmd_disconnect_check
check for a disconnect
helics::action_message_def::action_t::cmd_init_grant
@ cmd_init_grant
grant entry to initialization mode
helics::action_message_def::action_t::cmd_terminate_immediately
@ cmd_terminate_immediately
immediate halt no-disconnect;
helics::action_message_def::action_t::cmd_remove_interdependency
@ cmd_remove_interdependency
command to remove a federate as both dependent and a dependency
helics::action_message_def::action_t::cmd_disconnect_core_ack
@ cmd_disconnect_core_ack
ack for core disconnect
helics::action_message_def::action_t::cmd_register_route
@ cmd_register_route
instructions to create a direct route to another federate
helics::action_message_def::action_t::cmd_protocol_big
@ cmd_protocol_big
command used in the protocol stacks with the additional info
helics::action_message_def::action_t::cmd_time_check
@ cmd_time_check
command to run a check on whether time can be granted
helics::action_message_def::action_t::cmd_add_named_endpoint
@ cmd_add_named_endpoint
command to add a named endpoint as a target
helics::action_message_def::action_t::null_info_command
@ null_info_command
biggest command that doesn't have the info structure
helics::action_message_def::action_t::cmd_add_subscriber
@ cmd_add_subscriber
notify of a subscription
helics::action_message_def::action_t::cmd_timing_info
@ cmd_timing_info
send some information to dependents on timing
helics::action_message_def::action_t::cmd_log
@ cmd_log
log a message with the root broker
helics::action_message_def::action_t::cmd_add_named_filter
@ cmd_add_named_filter
command to add named filter as a target
helics::action_message_def::action_t::cmd_close_interface
@ cmd_close_interface
cmd to close all communications from an interface
helics::action_message_def::action_t::cmd_interface_tag
@ cmd_interface_tag
command to update a tag on an interface
helics::action_message_def::action_t::cmd_reg_translator
@ cmd_reg_translator
register a translator
helics::action_message_def::action_t::cmd_stop
@ cmd_stop
halt execution
helics::action_message_def::action_t::cmd_force_time_grant
@ cmd_force_time_grant
command to force grant a time regardless of other considerations
helics::action_message_def::action_t::cmd_query_reply_ordered
@ cmd_query_reply_ordered
response to a query on normal paths
helics::action_message_def::action_t::cmd_timeout_disconnect
@ cmd_timeout_disconnect
command specifying a disconnect from a timeout
helics::action_message_def::action_t::cmd_bye
@ cmd_bye
message stating this is the last communication from a federate
helics::action_message_def::action_t::cmd_protocol_priority
@ cmd_protocol_priority
priority command used by protocol stacks and ignored by core
helics::action_message_def::action_t::cmd_remove_filter
@ cmd_remove_filter
cmd to remove a filter from connection
helics::action_message_def::action_t::cmd_null_message
@ cmd_null_message
used when a filter drops a message but it needs to return
helics::action_message_def::action_t::cmd_broker_setup
@ cmd_broker_setup
command to load the setup information for a broker
helics::action_message_def::action_t::cmd_tick
@ cmd_tick
command for a timer tick
helics::action_message_def::action_t::cmd_time_barrier_clear
@ cmd_time_barrier_clear
clear a global time barrier
helics::action_message_def::action_t::cmd_time_barrier
@ cmd_time_barrier
setup a global time barrier
helics::action_message_def::action_t::cmd_remove_named_input
@ cmd_remove_named_input
cmd to remove a target from connection by name
helics::action_message_def::action_t::cmd_connection_error
@ cmd_connection_error
cmd indicating a connection error with a broker/federate
helics::action_message_def::action_t::cmd_broker_tag
@ cmd_broker_tag
command to update a tag on a broker
helics::action_message_def::action_t::cmd_protocol
@ cmd_protocol
command used in the protocol stacks and ignored by the core
helics::action_message_def::action_t::cmd_dest_filter_result
@ cmd_dest_filter_result
the result of a destination filter going back to its originator
helics::action_message_def::action_t::cmd_profiler_data
@ cmd_profiler_data
command for profiler data
helics::action_message_def::action_t::cmd_error_check
@ cmd_error_check
check some status for error and error timeouts
helics::action_message_def::action_t::cmd_send_for_filter
@ cmd_send_for_filter
send a message to be filtered and forward on to the destination
helics::action_message_def::action_t::cmd_send_for_filter_return
@ cmd_send_for_filter_return
send a message back to its originator after filtering
helics::action_message_def::action_t::cmd_ping_reply
@ cmd_ping_reply
response to a ping request
helics::action_message_def::action_t::cmd_null_dest_message
@ cmd_null_dest_message
used when a destination filter drops a message
helics::action_message_def::action_t::cmd_add_interdependency
@ cmd_add_interdependency
command to add a federate as both dependent and a dependency
helics::action_message_def::action_t::cmd_grant_timeout_check
@ cmd_grant_timeout_check
helics::action_message_def::action_t::cmd_send_route
@ cmd_send_route
command to define a route information
helics::action_message_def::action_t::cmd_remove_publication
@ cmd_remove_publication
cmd to remove a publication from connection
helics::action_message_def::action_t::cmd_priority_disconnect
@ cmd_priority_disconnect
command to disconnect a broker from a higher level broker
helics::action_message_def::action_t::cmd_time_block
@ cmd_time_block
prevent a federate from granting time until the block is cleared
helics::action_message_def::action_t::cmd_data_link
@ cmd_data_link
command to connect a publication with an endpoint
helics::action_message_def::action_t::cmd_add_publisher
@ cmd_add_publisher
notify of a publication
helics::action_message_def::action_t::cmd_remove_endpoint
@ cmd_remove_endpoint
cmd to remove an endpoint
helics::action_message_def::action_t::cmd_add_endpoint
@ cmd_add_endpoint
notify of a source endpoint
helics::action_message_def::action_t::cmd_reg_datasink
@ cmd_reg_datasink
register a sink interface
helics::action_message_def::action_t::cmd_set_profiler_flag
@ cmd_set_profiler_flag
command to activate profiling
helics::action_message_def::action_t::cmd_reg_filter
@ cmd_reg_filter
register a filter
helics::action_message_def::action_t::cmd_exec_request
@ cmd_exec_request
request an iteration or entry to execution mode
helics::action_message_def::action_t::cmd_user_disconnect
@ cmd_user_disconnect
command specifying that a user has issued a disconnect signal
helics::action_message_def::action_t::cmd_core_configure
@ cmd_core_configure
command to update the configuration of a core
helics::action_message_def::action_t::cmd_send_message
@ cmd_send_message
send a message
helics::action_message_def::action_t::cmd_remove_dependent
@ cmd_remove_dependent
command to remove a dependent from a federates consideration
helics::action_message_def::action_t::cmd_invalid
@ cmd_invalid
indicates that command has generated an invalid state
helics::action_message_def::action_t::cmd_remove_named_endpoint
@ cmd_remove_named_endpoint
cmd to remove an endpoint
helics::action_message_def::action_t::cmd_send_command_ordered
@ cmd_send_command_ordered
command to send a command to a command interface
helics::action_message_def::action_t::cmd_remote_log
@ cmd_remote_log
send a log message to a remote host
helics::action_message_def::action_t::cmd_broadcast_disconnect
@ cmd_broadcast_disconnect
a broadcast disconnect message
helics::action_message_def::action_t::cmd_remove_dependency
@ cmd_remove_dependency
command to remove a dependency
helics::action_message_def::action_t::cmd_filter_result
@ cmd_filter_result
the results of a filter message going back to its originator
helics::action_message_def::action_t::cmd_add_filter
@ cmd_add_filter
notify of a destination filter
helics::action_message_def::action_t::cmd_time_unblock
@ cmd_time_unblock
clear a time block
helics::action_message_def::action_t::cmd_exec_check
@ cmd_exec_check
command to run a check on execution entry
helics::action_message_def::action_t::cmd_add_named_publication
@ cmd_add_named_publication
command to add a named publication as a target
helics::action_message_def::action_t::cmd_disconnect
@ cmd_disconnect
disconnect command
helics::action_message_def::action_t::cmd_broker_query_ordered
@ cmd_broker_query_ordered
send a query to a core
helics::action_message_def::action_t::cmd_base_configure
@ cmd_base_configure
command to update the configuration of a broker/core base
helics::action_message_def::action_t::cmd_fed_ack
@ cmd_fed_ack
a reply with the global id or an error if the fed registration failed
helics::action_message_def::action_t::cmd_time_request
@ cmd_time_request
request a time or iteration
helics::action_message_def::action_t::cmd_ack
@ cmd_ack
acknowledge command to for various purposes
helics::action_message_def::action_t::cmd_priority_ack
@ cmd_priority_ack
doesn't do anything
helics::action_message_def::action_t::cmd_init
@ cmd_init
request entry to init mode
helics::action_message_def::action_t::cmd_send_for_dest_filter_return
@ cmd_send_for_dest_filter_return
send a message to a destination filter for processing
helics::action_message_def::action_t::cmd_add_route
@ cmd_add_route
command to define a route
helics::action_message_def::action_t::cmd_pub
@ cmd_pub
publish a value
helics::action_message_def::action_t::cmd_add_alias
@ cmd_add_alias
command to add an alias for an interface
helics::action_message_def::action_t::cmd_filter_link
@ cmd_filter_link
command to add a target to a filter
helics::action_message_def::action_t::cmd_broker_configure
@ cmd_broker_configure
command to update the configuration of a broker
helics::action_message_def::action_t::cmd_broker_query
@ cmd_broker_query
send a query to a core
helics::action_message_def::action_t::cmd_remove_named_filter
@ cmd_remove_named_filter
cmd to remove a filter from connection by name
helics::action_message_def::action_t::cmd_endpoint_link
@ cmd_endpoint_link
command to link endpoints
helics::action_message_def::action_t::cmd_broker_ping
@ cmd_broker_ping
ping to send to a broker to also ping subbrokers and cores
helics
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition: AsyncFedCallInfo.hpp:14
helics::commandErrorString
const char * commandErrorString(int errorCode)
Definition: ActionMessage.cpp:874
helics::actionMessageType
const char * actionMessageType(action_message_def::action_t action)
Definition: ActionMessage.cpp:857