openlcb_main_statemachine.h

Go to the documentation of this file.

 
#ifndef __OPENLCB_OPENLCB_MAIN_STATEMACHINE__
#define __OPENLCB_OPENLCB_MAIN_STATEMACHINE__
 
#include <stdbool.h>
#include <stdint.h>
 
#include "openlcb_types.h"
 
typedef struct {
 
    // =========================================================================
    // Resource Management (all REQUIRED)
    // =========================================================================
 
    void (*lock_shared_resources)(void);
 
    void (*unlock_shared_resources)(void);
 
    bool (*send_openlcb_msg)(openlcb_msg_t *outgoing_msg);
 
    // =========================================================================
    // Clock Access (REQUIRED)
    // =========================================================================
 
    uint8_t (*get_current_tick)(void);
 
    // =========================================================================
    // Node Enumeration (all REQUIRED)
    // =========================================================================
 
    openlcb_node_t *(*openlcb_node_get_first)(uint8_t key);
 
    openlcb_node_t *(*openlcb_node_get_next)(uint8_t key);
 
    bool (*openlcb_node_is_last)(uint8_t key);
 
    uint16_t (*openlcb_node_get_count)(void);
 
    // =========================================================================
    // Core Handlers (all REQUIRED)
    // =========================================================================
 
    void (*load_interaction_rejected)(openlcb_statemachine_info_t *statemachine_info);
 
    // =========================================================================
    // Required Message Network Protocol Handlers
    // =========================================================================
 
    void (*message_network_initialization_complete)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*message_network_initialization_complete_simple)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*message_network_verify_node_id_addressed)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*message_network_verify_node_id_global)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*message_network_verified_node_id)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*message_network_optional_interaction_rejected)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*message_network_terminate_due_to_error)(openlcb_statemachine_info_t *statemachine_info);
 
    // =========================================================================
    // Required Protocol Support (PIP) Handlers
    // =========================================================================
 
    void (*message_network_protocol_support_inquiry)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*message_network_protocol_support_reply)(openlcb_statemachine_info_t *statemachine_info);
 
    // =========================================================================
    // Internal functions (exposed for unit testing)
    // =========================================================================
 
    void (*process_main_statemachine)(openlcb_statemachine_info_t *statemachine_info);
 
    bool (*does_node_process_msg)(openlcb_statemachine_info_t *statemachine_info);
 
    bool (*handle_outgoing_openlcb_message)(void);
 
    bool (*handle_try_reenumerate)(void);
 
    bool (*handle_try_pop_next_incoming_openlcb_message)(void);
 
    bool (*handle_try_enumerate_first_node)(void);
 
    bool (*handle_try_enumerate_next_node)(void);
 
    // =========================================================================
    // Optional SNIP Handlers (NULL = Interaction Rejected)
    // =========================================================================
 
    void (*snip_simple_node_info_request)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*snip_simple_node_info_reply)(openlcb_statemachine_info_t *statemachine_info);
 
    // =========================================================================
    // Optional Event Transport Handlers (NULL = Interaction Rejected)
    // =========================================================================
 
    void (*event_transport_consumer_identify)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_consumer_range_identified)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_consumer_identified_unknown)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_consumer_identified_set)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_consumer_identified_clear)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_consumer_identified_reserved)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_producer_identify)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_producer_range_identified)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_producer_identified_unknown)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_producer_identified_set)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_producer_identified_clear)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_producer_identified_reserved)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_identify_dest)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_identify)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_learn)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_pc_report)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*event_transport_pc_report_with_payload)(openlcb_statemachine_info_t *statemachine_info);
 
    // =========================================================================
    // Optional Train Protocol Handlers (NULL = Interaction Rejected)
    // =========================================================================
 
    void (*train_control_command)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*train_control_reply)(openlcb_statemachine_info_t *statemachine_info);
 
    // =========================================================================
    // Optional Train SNIP Handlers (NULL = Interaction Rejected)
    // =========================================================================
 
    void (*simple_train_node_ident_info_request)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*simple_train_node_ident_info_reply)(openlcb_statemachine_info_t *statemachine_info);
 
    // =========================================================================
    // Optional Datagram Handlers (NULL = Interaction Rejected)
    // =========================================================================
 
    void (*datagram)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*datagram_ok_reply)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*load_datagram_rejected)(openlcb_statemachine_info_t *statemachine_info, uint16_t error_code);
 
    void (*datagram_rejected_reply)(openlcb_statemachine_info_t *statemachine_info);
 
    // =========================================================================
    // Optional Stream Handlers (NULL = Interaction Rejected)
    // =========================================================================
 
    void (*stream_initiate_request)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*stream_initiate_reply)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*stream_send_data)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*stream_data_proceed)(openlcb_statemachine_info_t *statemachine_info);
 
    void (*stream_data_complete)(openlcb_statemachine_info_t *statemachine_info);
 
    // =========================================================================
    // Optional Broadcast Time Handler (NULL = not implemented)
    // =========================================================================
 
    void (*broadcast_time_event_handler)(openlcb_statemachine_info_t *statemachine_info, event_id_t event_id);
 
    // =========================================================================
    // Optional Train Search Handler (NULL = not implemented)
    // =========================================================================
 
    void (*train_search_event_handler)(openlcb_statemachine_info_t *statemachine_info, event_id_t event_id);
 
    void (*train_search_no_match_handler)(openlcb_statemachine_info_t *statemachine_info, event_id_t event_id);
 
    // =========================================================================
    // Optional Train Emergency Event Handler (NULL = not implemented)
    // =========================================================================
 
    void (*train_emergency_event_handler)(openlcb_statemachine_info_t *statemachine_info, event_id_t event_id);
 
} interface_openlcb_main_statemachine_t;
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
    extern void OpenLcbMainStatemachine_initialize(
            const interface_openlcb_main_statemachine_t *interface_openlcb_main_statemachine);
 
    extern void OpenLcbMainStatemachine_run(void);
 
    extern void OpenLcbMainStatemachine_load_interaction_rejected(
            openlcb_statemachine_info_t *statemachine_info);
 
    // ---- Internal functions exposed for unit testing ----
 
    extern bool OpenLcbMainStatemachine_handle_outgoing_openlcb_message(void);
 
    extern bool OpenLcbMainStatemachine_handle_try_reenumerate(void);
 
    extern bool OpenLcbMainStatemachine_handle_try_pop_next_incoming_openlcb_message(void);
 
    extern bool OpenLcbMainStatemachine_handle_try_enumerate_first_node(void);
 
    extern bool OpenLcbMainStatemachine_handle_try_enumerate_next_node(void);
 
    extern void OpenLcbMainStatemachine_process_main_statemachine(
            openlcb_statemachine_info_t *statemachine_info);
 
    extern bool OpenLcbMainStatemachine_does_node_process_msg(
            openlcb_statemachine_info_t *statemachine_info);
 
    extern openlcb_statemachine_info_t *OpenLcbMainStatemachine_get_statemachine_info(void);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* __OPENLCB_OPENLCB_MAIN_STATEMACHINE__ */