helics  2.8.1
Enumerations | Variables
helics::action_message_def Namespace Reference

Enumerations

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

register an endpoint

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