| helics 3.6.1

Enumerations | Variables
helics::action_message_def Namespace Reference

## Enumerations
enum class | action_t : int32_t { cmd_priority_disconnect , cmd_fed_ack , cmd_broker_ack = -27 , cmd_add_route = -32 , cmd_route_ack = -16 , cmd_register_route = -15 , cmd_reg_fed = -105 , cmd_priority_ack , cmd_query = -cmd_info_basis - 37 , cmd_query_ordered , cmd_set_global = -cmd_info_basis - 55 , cmd_broker_query = -37 , cmd_interface_query = -39 , cmd_broker_query_ordered = 939 , cmd_query_reply = -cmd_info_basis - 38 , cmd_query_reply_ordered = 942 , cmd_reg_broker , cmd_broker_location = cmd_info_basis - 57 , cmd_send_command = -95 , cmd_command_response = -98 , cmd_send_command_ordered = 95 , cmd_command_response_ordered = 98 , cmd_broker_setup = -1 , cmd_ignore = 0 , cmd_tick = 1 , cmd_user_disconnect = 2 , cmd_disconnect = 3 , cmd_disconnect_name = 4 , cmd_disconnect_check = 5 , cmd_disconnect_fed = 6 , cmd_broadcast_disconnect = 7 , cmd_disconnect_core = 8 , cmd_disconnect_broker = 9 , cmd_global_disconnect = 1002 , cmd_timeout_disconnect = 1003 , cmd_disconnect_fed_ack = 1006 , cmd_disconnect_core_ack = 1008 , cmd_disconnect_broker_ack = 1009 , cmd_check_connections = 297 , cmd_ping = 298 , cmd_ping_priority = -298 , cmd_ping_reply = 299 , cmd_broker_ping = 306 , cmd_init = 10 , cmd_init_grant = 11 , cmd_init_not_ready = 12 , cmd_exec_request = 20 , cmd_exec_grant = 22 , cmd_exec_check = 24 , cmd_ack = 254 , cmd_timing_info = 310 , cmd_stop = 30 , cmd_terminate_immediately = 31 , cmd_time_grant = 35 , cmd_time_check = 36 , cmd_request_current_time , cmd_grant_timeout_check = 439 , cmd_user_return = 535 , cmd_time_block = 40 , cmd_time_unblock = 41 , cmd_time_barrier_request = 42 , cmd_time_barrier = 43 , cmd_time_barrier_clear = 44 , cmd_pub = 52 , cmd_bye = 2000 , cmd_log = 55 , cmd_remote_log = 2055 , cmd_warning = 9990 , cmd_error = 10000 , cmd_local_error = 10003 , cmd_global_error = 10005 , cmd_error_check = 10001 , cmd_invalid = 1010101 , cmd_send_route = 75 , cmd_search_dependency = 1464 , cmd_add_dependency = 140 , cmd_remove_dependency = 141 , cmd_add_dependent = 144 , cmd_remove_dependent , cmd_add_interdependency , cmd_remove_interdependency , cmd_data_link , cmd_filter_link = cmd_info_basis + 709 , cmd_endpoint_link = cmd_info_basis + 711 , cmd_add_alias = cmd_info_basis + 715 , cmd_fed_configure_time , cmd_fed_configure_int , cmd_fed_configure_flag , cmd_core_configure = 207 , cmd_interface_configure = 209 , cmd_broker_configure = 211 , cmd_base_configure = 213 , cmd_interface_tag = 218 , cmd_core_tag = 220 , cmd_broker_tag = 222 , cmd_profiler_data = 496 , cmd_set_profiler_flag = 498 , cmd_update_filter_op , null_info_command , priority_null_info_command = -cmd_info_basis - 1 , cmd_time_request = 500 , cmd_force_time_grant , cmd_send_message = cmd_info_basis + 20 , cmd_null_message = 726 , cmd_null_dest_message = 730 , cmd_send_for_filter , cmd_send_for_dest_filter_return , cmd_send_for_filter_return , cmd_filter_result , cmd_dest_filter_result , cmd_reg_pub = cmd_info_basis + 50 , cmd_add_publisher = 50 , cmd_reg_filter = cmd_info_basis + 60 , cmd_add_filter = 62 , cmd_reg_input = cmd_info_basis + 70 , cmd_add_subscriber = 70 , cmd_reg_translator = cmd_info_basis + 80 , cmd_reg_end = cmd_info_basis + 90 , cmd_reg_datasink = cmd_info_basis + 95 , cmd_add_endpoint = 90 , cmd_add_named_input = 104 , cmd_add_named_filter = 105 , cmd_add_named_publication = 106 , cmd_add_named_endpoint = 107 , cmd_remove_named_input = 124 , cmd_remove_named_filter = 125 , cmd_remove_named_publication , cmd_remove_named_endpoint = 127 , cmd_remove_subscriber = 134 , cmd_remove_filter = 135 , cmd_remove_publication = 136 , cmd_remove_endpoint = 137 , cmd_close_interface = 133 , cmd_multi_message = 1037 , cmd_connection_error = 2034 , cmd_protocol_priority , cmd_protocol = 60000 , cmd_protocol_big , cmd_resend = 121212 }

## Variables
constexpr int32_t | cmd_info_basis = 0x10000000

## Detailed Description

namespace for message definitions

## Enumeration Type Documentation

## ◆ action_t

enum helics::action_message_def::action_t : int32_t
| strong

enumeration of globally recognized commands

they are explicitly numbered for debugging and to ensure the enumeration is constant across different compilers

Enumerator
cmd_priority_disconnect | command to disconnect a broker from a higher level broker
cmd_fed_ack | a reply with the global id or an error if the fed registration failed
cmd_add_route | command to define a route
cmd_route_ack | acknowledge reply to a route registration
cmd_register_route | instructions to create a direct route to another federate
cmd_reg_fed | register a federate
cmd_priority_ack | doesn't do anything priority commands usually do not have an ack this is an ack that
cmd_query | send a query this is a priority command
cmd_query_ordered | send a query along the synchronous paths instead of priority channels
cmd_set_global | set a global value
cmd_broker_query | send a query to a core
cmd_interface_query | send a query to a core
cmd_broker_query_ordered | send a query to a core
cmd_query_reply | response to a query
cmd_query_reply_ordered | response to a query on normal paths
cmd_reg_broker | for a broker to connect with a higher level broker
cmd_broker_location | command to define a new broker location
cmd_send_command | command to send a command to a command interface
cmd_command_response | command containing a response to a command
cmd_send_command_ordered | command to send a command to a command interface
cmd_command_response_ordered | command containing a response to a command
cmd_broker_setup | command to load the setup information for a broker
cmd_ignore | null command
cmd_tick | command for a timer tick
cmd_user_disconnect | command specifying that a user has issued a disconnect signal
cmd_disconnect | disconnect command
cmd_disconnect_name | disconnect a broker or core by name vs id
cmd_disconnect_check | check for a disconnect
cmd_disconnect_fed | disconnect a federate
cmd_broadcast_disconnect | a broadcast disconnect message
cmd_disconnect_core | disconnect a core
cmd_disconnect_broker | disconnect a broker
cmd_global_disconnect | disconnect a federation
cmd_timeout_disconnect | command specifying a disconnect from a timeout
cmd_disconnect_fed_ack | federate disconnect ack
cmd_disconnect_core_ack | ack for core disconnect
cmd_disconnect_broker_ack | ack for broker disconnect
cmd_check_connections | command to check for any connections
cmd_ping | request for an Echo response
cmd_ping_priority | request for an Echo response on priority channel
cmd_ping_reply | response to a ping request
cmd_broker_ping | ping to send to a broker to also ping subbrokers and cores
cmd_init | request entry to init mode
cmd_init_grant | grant entry to initialization mode
cmd_init_not_ready | retract an init ready command
cmd_exec_request | request an iteration or entry to execution mode
cmd_exec_grant | grant entry to exec mode or iterate
cmd_exec_check | command to run a check on execution entry
cmd_ack | acknowledge command to for various purposes
cmd_timing_info | send some information to dependents on timing
cmd_stop | halt execution
cmd_terminate_immediately | immediate halt no-disconnect;
cmd_time_grant | grant a time or iteration
cmd_time_check | command to run a check on whether time can be granted
cmd_request_current_time | command to request the current time status of a federate
cmd_grant_timeout_check | command to run a check on whether a timeout has been exceeded for granting time
cmd_user_return | return from processing
cmd_time_block | prevent a federate from granting time until the block is cleared
cmd_time_unblock | clear a time block
cmd_time_barrier_request | request a time barrier
cmd_time_barrier | setup a global time barrier
cmd_time_barrier_clear | clear a global time barrier
cmd_pub | publish a value
cmd_bye | message stating this is the last communication from a federate
cmd_log | log a message with the root broker
cmd_remote_log | send a log message to a remote host
cmd_warning | indicate some sort of warning
cmd_error | indicate an error with a federate
cmd_local_error | indicate a local error within a federate/core/broker
cmd_global_error | indicate a global error with a federate/core/broker and the federation should terminate
cmd_error_check | check some status for error and error timeouts
cmd_invalid | indicates that command has generated an invalid state
cmd_send_route | command to define a route information
cmd_search_dependency | command to add a dependency by name
cmd_add_dependency | command to send a federate dependency information
cmd_remove_dependency | command to remove a dependency
cmd_add_dependent | command to add a dependent to a federate
cmd_remove_dependent | command to remove a dependent from a federates consideration
cmd_add_interdependency | command to add a federate as both dependent and a dependency
cmd_remove_interdependency | command to remove a federate as both dependent and a dependency
cmd_data_link | command to connect a publication with an endpoint
cmd_filter_link | command to add a target to a filter
cmd_endpoint_link | command to link endpoints
cmd_add_alias | command to add an alias for an interface
cmd_fed_configure_time | command to update the configuration of a federate a time parameter
cmd_fed_configure_int | command to update the configuration of a federate an int parameter
cmd_fed_configure_flag | command to update the configuration of a federate a flag parameter
cmd_core_configure | command to update the configuration of a core
cmd_interface_configure | command to update the configuration of an interface
cmd_broker_configure | command to update the configuration of a broker
cmd_base_configure | command to update the configuration of a broker/core base
cmd_interface_tag | command to update a tag on an interface
cmd_core_tag | command to update a tag on a core
cmd_broker_tag | command to update a tag on a broker
cmd_profiler_data | command for profiler data
cmd_set_profiler_flag | command to activate profiling
cmd_update_filter_op | command to update a filter op [should only used internal to a core]
null_info_command | biggest command that doesn't have the info structure
priority_null_info_command | the biggest negative priority command
cmd_time_request | request a time or iteration
cmd_force_time_grant | command to force grant a time regardless of other considerations
cmd_send_message | send a message
cmd_null_message | used when a filter drops a message but it needs to return
cmd_null_dest_message | used when a destination filter drops a message
cmd_send_for_filter | send a message to be filtered and forward on to the destination
cmd_send_for_dest_filter_return | send a message to a destination filter for processing
cmd_send_for_filter_return | send a message back to its originator after filtering
cmd_filter_result | the results of a filter message going back to its originator
cmd_dest_filter_result | the result of a destination filter going back to its originator
cmd_reg_pub | register a publication
cmd_add_publisher | notify of a publication
cmd_reg_filter | register a filter
cmd_add_filter | notify of a destination filter
cmd_reg_input | register an input interface
cmd_add_subscriber | notify of a subscription
cmd_reg_translator | register a translator
cmd_reg_end | register an endpoint
cmd_reg_datasink | register a sink interface
cmd_add_endpoint | notify of a source endpoint
cmd_add_named_input | command to add a named input as a target
cmd_add_named_filter | command to add named filter as a target
cmd_add_named_publication | command to add a named publication as a target
cmd_add_named_endpoint | command to add a named endpoint as a target
cmd_remove_named_input | cmd to remove a target from connection by name
cmd_remove_named_filter | cmd to remove a filter from connection by name
cmd_remove_named_publication | cmd to remove a publication from connection by name
cmd_remove_named_endpoint | cmd to remove an endpoint
cmd_remove_subscriber | cmd to remove a target from connection
cmd_remove_filter | cmd to remove a filter from connection
cmd_remove_publication | cmd to remove a publication from connection
cmd_remove_endpoint | cmd to remove an endpoint
cmd_close_interface | cmd to close all communications from an interface
cmd_multi_message | cmd that encapsulates a bunch of messages in its payload
cmd_connection_error | cmd indicating a connection error with a broker/federate
cmd_protocol_priority | priority command used by protocol stacks and ignored by core
cmd_protocol | command used in the protocol stacks and ignored by the core
cmd_protocol_big | command used in the protocol stacks with the additional info
cmd_resend | command to resend some data