ActionMessageDefintions.hpp

/*
Copyright (c) 2017-2026,
Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Energy
Innovation LLC.  See the top-level NOTICE for additional details. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause
*/
#pragma once
 
#include "../helics_enums.h"
 
#include <cstdint>
namespace helics {
namespace action_message_def {
    constexpr int32_t cmd_info_basis = 0x10000000;
 
    enum class action_t : int32_t {
        // priority commands ALL priority commands have a negative code
        cmd_priority_disconnect =
            -3,  
        cmd_fed_ack =
            -25,  
 
        cmd_broker_ack = -27,  // a reply to the connect command with a global route id
        cmd_add_route = -32,  
        cmd_route_ack = -16,  
        cmd_register_route = -15,  
        cmd_reg_fed = -105,  
        cmd_priority_ack =
            -254,  
        cmd_query = -cmd_info_basis - 37,  
        cmd_query_ordered =
            937,  
        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_info_basis - 40,  
        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 =
            38,  
        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 =
            145,  
        cmd_add_interdependency =
            148,  
        cmd_remove_interdependency =
            149,  
 
        cmd_data_link =
            cmd_info_basis + 707,  
        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 =
            202,  
        cmd_fed_configure_int =
            203,  
        cmd_fed_configure_flag =
            204,  
        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 =
            10427,  
        null_info_command =
            cmd_info_basis - 1,  
        priority_null_info_command = -cmd_info_basis - 1,
        // commands that require the extra info allocation have numbers greater than cmd_info_basis
        cmd_time_request = 500,  
        cmd_force_time_grant =
            525,  
 
        cmd_send_message = cmd_info_basis + 20,  
        cmd_null_message = 726,  
        cmd_null_dest_message = 730,  
        cmd_send_for_filter = cmd_info_basis +
            30,  
        cmd_send_for_dest_filter_return =
            cmd_info_basis + 31,  
        cmd_send_for_filter_return =
            cmd_info_basis + 35,  
        cmd_filter_result =
            cmd_info_basis + 40,  
        cmd_dest_filter_result = cmd_info_basis +
            41,  
        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 =
            126,  
        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 =
            -60000,  
        cmd_protocol = 60000,  
        cmd_protocol_big = cmd_info_basis +
            60000,  
        cmd_resend = 121212  
    };
 
}  // namespace action_message_def
 
#define CMD_IGNORE action_message_def::action_t::cmd_ignore
#define CMD_INVALID action_message_def::action_t::cmd_invalid
#define CMD_TICK action_message_def::action_t::cmd_tick
#define CMD_REG_BROKER action_message_def::action_t::cmd_reg_broker
#define CMD_PRIORITY_DISCONNECT action_message_def::action_t::cmd_priority_disconnect
#define CMD_USER_DISCONNECT action_message_def::action_t::cmd_user_disconnect
#define CMD_TIMEOUT_DISCONNECT action_message_def::action_t::cmd_timeout_disconnect
#define CMD_GLOBAL_DISCONNECT action_message_def::action_t::cmd_global_disconnect
#define CMD_DISCONNECT action_message_def::action_t::cmd_disconnect
#define CMD_DISCONNECT_NAME action_message_def::action_t::cmd_disconnect_name
#define CMD_DISCONNECT_CHECK action_message_def::action_t::cmd_disconnect_check
#define CMD_DISCONNECT_FED action_message_def::action_t::cmd_disconnect_fed
#define CMD_BROADCAST_DISCONNECT action_message_def::action_t::cmd_broadcast_disconnect
 
#define CMD_DISCONNECT_CORE action_message_def::action_t::cmd_disconnect_core
#define CMD_DISCONNECT_BROKER action_message_def::action_t::cmd_disconnect_broker
#define CMD_DISCONNECT_FED_ACK action_message_def::action_t::cmd_disconnect_fed_ack
#define CMD_DISCONNECT_CORE_ACK action_message_def::action_t::cmd_disconnect_core_ack
#define CMD_DISCONNECT_BROKER_ACK action_message_def::action_t::cmd_disconnect_broker_ack
#define CMD_CONNECTION_ERROR action_message_def::action_t::cmd_connection_error
 
#define CMD_CHECK_CONNECTIONS action_message_def::action_t::cmd_check_connections
#define CMD_PING action_message_def::action_t::cmd_ping
#define CMD_PING_PRIORITY action_message_def::action_t::cmd_ping_priority
 
#define CMD_BROKER_PING action_message_def::action_t::cmd_broker_setup
#define CMD_PING_REPLY action_message_def::action_t::cmd_ping_reply
#define CMD_BROKER_SETUP action_message_def::action_t::cmd_broker_setup
#define CMD_BROKER_LOCATION action_message_def::action_t::cmd_broker_location
 
#define CMD_INIT action_message_def::action_t::cmd_init
#define CMD_INIT_NOT_READY action_message_def::action_t::cmd_init_not_ready
#define CMD_INIT_GRANT action_message_def::action_t::cmd_init_grant
#define CMD_TIMING_INFO action_message_def::action_t::cmd_timing_info
#define CMD_EXEC_REQUEST action_message_def::action_t::cmd_exec_request
#define CMD_EXEC_GRANT action_message_def::action_t::cmd_exec_grant
#define CMD_EXEC_CHECK action_message_def::action_t::cmd_exec_check
#define CMD_REG_ROUTE action_message_def::action_t::cmd_register_route
#define CMD_ROUTE_ACK action_message_def::action_t::cmd_route_ack
#define CMD_STOP action_message_def::action_t::cmd_stop
#define CMD_TERMINATE_IMMEDIATELY action_message_def::action_t::cmd_terminate_immediately
#define CMD_TIME_REQUEST action_message_def::action_t::cmd_time_request
#define CMD_TIME_GRANT action_message_def::action_t::cmd_time_grant
#define CMD_FORCE_TIME_GRANT action_message_def::action_t::cmd_force_time_grant
#define CMD_TIME_CHECK action_message_def::action_t::cmd_time_check
#define CMD_GRANT_TIMEOUT_CHECK action_message_def::action_t::cmd_grant_timeout_check
#define CMD_REQUEST_CURRENT_TIME action_message_def::action_t::cmd_request_current_time
#define CMD_USER_RETURN action_message_def::action_t::cmd_user_return
 
#define CMD_TIME_BLOCK action_message_def::action_t::cmd_time_block
#define CMD_TIME_UNBLOCK action_message_def::action_t::cmd_time_unblock
 
#define CMD_TIME_BARRIER_REQUEST action_message_def::action_t::cmd_time_barrier_request
#define CMD_TIME_BARRIER action_message_def::action_t::cmd_time_barrier
#define CMD_TIME_BARRIER_CLEAR action_message_def::action_t::cmd_time_barrier_clear
 
#define CMD_SEND_MESSAGE action_message_def::action_t::cmd_send_message
#define CMD_SEND_FOR_FILTER action_message_def::action_t::cmd_send_for_filter
#define CMD_SEND_FOR_FILTER_AND_RETURN action_message_def::action_t::cmd_send_for_filter_return
#define CMD_SEND_FOR_DEST_FILTER_AND_RETURN                                                        \
    action_message_def::action_t::cmd_send_for_dest_filter_return
#define CMD_NULL_MESSAGE action_message_def::action_t::cmd_null_message
#define CMD_NULL_DEST_MESSAGE action_message_def::action_t::cmd_null_dest_message
#define CMD_FILTER_RESULT action_message_def::action_t::cmd_filter_result
#define CMD_DEST_FILTER_RESULT action_message_def::action_t::cmd_dest_filter_result
 
#define CMD_PUB action_message_def::action_t::cmd_pub
#define CMD_LOG action_message_def::action_t::cmd_log
#define CMD_REMOTE_LOG action_message_def::action_t::cmd_remote_log
#define CMD_WARNING action_message_def::action_t::cmd_warning
#define CMD_ERROR action_message_def::action_t::cmd_error
#define CMD_GLOBAL_ERROR action_message_def::action_t::cmd_global_error
#define CMD_LOCAL_ERROR action_message_def::action_t::cmd_local_error
#define CMD_ERROR_CHECK action_message_def::action_t::cmd_error_check
 
#define CMD_RESEND action_message_def::action_t::cmd_resend
 
#define CMD_REG_PUB action_message_def::action_t::cmd_reg_pub
#define CMD_ADD_PUBLISHER action_message_def::action_t::cmd_add_publisher
#define CMD_REG_INPUT action_message_def::action_t::cmd_reg_input
#define CMD_ADD_SUBSCRIBER action_message_def::action_t::cmd_add_subscriber
 
#define CMD_REG_TRANSLATOR action_message_def::action_t::cmd_reg_translator
 
#define CMD_ADD_NAMED_ENDPOINT action_message_def::action_t::cmd_add_named_endpoint
#define CMD_ADD_NAMED_FILTER action_message_def::action_t::cmd_add_named_filter
#define CMD_ADD_NAMED_PUBLICATION action_message_def::action_t::cmd_add_named_publication
#define CMD_ADD_NAMED_INPUT action_message_def::action_t::cmd_add_named_input
 
#define CMD_REMOVE_NAMED_ENDPOINT action_message_def::action_t::cmd_remove_named_endpoint
#define CMD_REMOVE_NAMED_FILTER action_message_def::action_t::cmd_remove_named_filter
#define CMD_REMOVE_NAMED_PUBLICATION action_message_def::action_t::cmd_remove_named_publication
#define CMD_REMOVE_NAMED_INPUT action_message_def::action_t::cmd_remove_named_input
 
#define CMD_REMOVE_ENDPOINT action_message_def::action_t::cmd_remove_endpoint
#define CMD_REMOVE_FILTER action_message_def::action_t::cmd_remove_filter
#define CMD_REMOVE_PUBLICATION action_message_def::action_t::cmd_remove_publication
#define CMD_REMOVE_SUBSCRIBER action_message_def::action_t::cmd_remove_subscriber
 
#define CMD_CLOSE_INTERFACE action_message_def::action_t::cmd_close_interface
 
#define CMD_DATA_LINK action_message_def::action_t::cmd_data_link
#define CMD_FILTER_LINK action_message_def::action_t::cmd_filter_link
#define CMD_ENDPOINT_LINK action_message_def::action_t::cmd_endpoint_link
#define CMD_ADD_ALIAS action_message_def::action_t::cmd_add_alias
 
#define CMD_REMOVE_NAMED_TARGET action_message_def::action_t::cmd_remove_named_target
#define CMD_REMOVE_TARGET action_message_def::action_t::cmd_remove_target
 
#define CMD_REG_ENDPOINT action_message_def::action_t::cmd_reg_end
#define CMD_ADD_ENDPOINT action_message_def::action_t::cmd_add_endpoint
 
#define CMD_REG_DATASINK action_message_def::action_t::cmd_reg_datasink
 
#define CMD_REG_FILTER action_message_def::action_t::cmd_reg_filter
#define CMD_ADD_FILTER action_message_def::action_t::cmd_add_filter
 
#define CMD_SEARCH_DEPENDENCY action_message_def::action_t::cmd_search_dependency
#define CMD_ADD_DEPENDENCY action_message_def::action_t::cmd_add_dependency
#define CMD_REMOVE_DEPENDENCY action_message_def::action_t::cmd_remove_dependency
#define CMD_ADD_DEPENDENT action_message_def::action_t::cmd_add_dependent
#define CMD_REMOVE_DEPENDENT action_message_def::action_t::cmd_remove_dependent
#define CMD_ADD_INTERDEPENDENCY action_message_def::action_t::cmd_add_interdependency
#define CMD_REMOVE_INTERDEPENDENCY action_message_def::action_t::cmd_remove_interdependency
 
#define CMD_REG_FED action_message_def::action_t::cmd_reg_fed
#define CMD_BROKER_ACK action_message_def::action_t::cmd_broker_ack
#define CMD_FED_ACK action_message_def::action_t::cmd_fed_ack
#define CMD_PROTOCOL_PRIORITY action_message_def::action_t::cmd_protocol_priority
#define CMD_PROTOCOL action_message_def::action_t::cmd_protocol
#define CMD_PROTOCOL_BIG action_message_def::action_t::cmd_protocol_big
 
#define CMD_FED_CONFIGURE_TIME action_message_def::action_t::cmd_fed_configure_time
#define CMD_FED_CONFIGURE_INT action_message_def::action_t::cmd_fed_configure_int
#define CMD_FED_CONFIGURE_FLAG action_message_def::action_t::cmd_fed_configure_flag
#define CMD_INTERFACE_CONFIGURE action_message_def::action_t::cmd_interface_configure
 
#define CMD_CORE_CONFIGURE action_message_def::action_t::cmd_core_configure
#define CMD_BROKER_CONFIGURE action_message_def::action_t::cmd_broker_configure
#define CMD_BASE_CONFIGURE action_message_def::action_t::cmd_base_configure
#define CMD_INTERFACE_TAG action_message_def::action_t::cmd_interface_tag
#define CMD_CORE_TAG action_message_def::action_t::cmd_core_tag
#define CMD_BROKER_TAG action_message_def::action_t::cmd_broker_tag
#define CMD_PROFILER_DATA action_message_def::action_t::cmd_profiler_data
#define CMD_SET_PROFILER_FLAG action_message_def::action_t::cmd_set_profiler_flag
 
#define CMD_ACK action_message_def::action_t::cmd_ack
#define CMD_PRIORITY_ACK action_message_def::action_t::cmd_priority_ack
 
#define CMD_QUERY action_message_def::action_t::cmd_query
#define CMD_QUERY_ORDERED action_message_def::action_t::cmd_query_ordered
#define CMD_BROKER_QUERY action_message_def::action_t::cmd_broker_query
#define CMD_BROKER_QUERY_ORDERED action_message_def::action_t::cmd_broker_query_ordered
#define CMD_INTERFACE_QUERY action_message_def::action_t::cmd_interface_query
#define CMD_QUERY_REPLY action_message_def::action_t::cmd_query_reply
#define CMD_QUERY_REPLY_ORDERED action_message_def::action_t::cmd_query_reply_ordered
#define CMD_SET_GLOBAL action_message_def::action_t::cmd_set_global
 
#define CMD_SEND_COMMAND action_message_def::action_t::cmd_send_command
#define CMD_SEND_COMMAND_ORDERED action_message_def::action_t::cmd_send_command_ordered
#define CMD_COMMAND_RESPONSE action_message_def::action_t::cmd_command_response
#define CMD_COMMAND_RESPONSE_ORDERED action_message_def::action_t::cmd_command_response_ordered
 
#define CMD_MULTI_MESSAGE action_message_def::action_t::cmd_multi_message
 
// definitions for the protocol options
#define PROTOCOL_PING 10
#define PROTOCOL_PONG 11
#define CLOSE_RECEIVER 23425215
#define PAUSE_TRANSMITTER 453623
#define ALLOW_MESSAGES 453624
#define UNPAUSE_TRANSMITTER 453625
// routing information
#define NEW_ROUTE 233
#define REMOVE_ROUTE 244
#define CONNECTION_INFORMATION 299
#define CONNECTION_REQUEST 301
#define CONNECTION_ACK 304
#define CONNECTION_TEST 307
#define NEW_BROKER_INFORMATION 333
#define DISCONNECT 2523
#define DISCONNECT_ERROR 2623
#define DELAY_CONNECTION 3795
 
#define NAME_NOT_FOUND 2726
#define RECONNECT_TRANSMITTER 1997
#define RECONNECT_RECEIVER 1999
// for requesting port definitions on a computer
#define PORT_DEFINITIONS 1451
#define QUERY_PORTS 1453
#define REQUEST_PORTS 1455
#define SET_USED_PORTS 1457
#define NULL_REPLY 0;
 
// definitions related to Core Configure
#define UPDATE_FILTER_OPERATOR 572
#define UPDATE_TRANSLATOR_OPERATOR 574
#define UPDATE_FEDERATE_OPERATOR 576
#define UPDATE_QUERY_CALLBACK 581
#define UPDATE_LOGGING_CALLBACK 592
#define UPDATE_LOGGING_FILE 594
#define REQUEST_TICK_FORWARDING 607
 
const char* actionMessageType(action_message_def::action_t action);
 
enum CommandErrorCodes : int {
    lost_server_connection_code = -5,
    connection_error_code = -2,
    already_init_error_code = 5,
    duplicate_federate_name_error_code = 6,
    duplicate_broker_name_error_code = 7,
    mismatch_broker_key_error_code = 9,
    max_federate_count_exceeded = 11,
    max_broker_count_exceeded = 13,
    broker_terminating = 14,
    multiple_wait_for_current_time_flags = 15,
    duplicate_federate_id = 17
};
 
const char* commandErrorString(int errorCode);
 
}  // namespace helics