help/html/openlcb__login__statemachine_8h_source.html

// This is a guard condition so that contents of this file are not included

// more than once.

#ifndef __OPENLCB_OPENLCB_LOGIN_STATEMACHINE__

#define    __OPENLCB_OPENLCB_LOGIN_STATEMACHINE__


#include "openlcb_types.h"


typedef struct {


    bool (*send_openlcb_msg)(openlcb_msg_t *outgoing_msg);


    openlcb_node_t *(*openlcb_node_get_first)(uint8_t key);


    openlcb_node_t *(*openlcb_node_get_next)(uint8_t key);


    void (*load_initialization_complete)(openlcb_login_statemachine_info_t *openlcb_statemachine_info);


    void (*load_producer_events)(openlcb_login_statemachine_info_t *openlcb_statemachine_info);


    void (*load_consumer_events)(openlcb_login_statemachine_info_t *openlcb_statemachine_info);


    // ---- Internal function pointers (exposed for unit testing) ----


    void (*process_login_statemachine)(openlcb_login_statemachine_info_t *statemachine_info);


    bool (*handle_outgoing_openlcb_message)(void);


    bool (*handle_try_reenumerate)(void);


    bool (*handle_try_enumerate_first_node)(void);


    bool (*handle_try_enumerate_next_node)(void);


    bool (*on_login_complete)(openlcb_node_t *openlcb_node);


} interface_openlcb_login_state_machine_t;


#ifdef    __cplusplus

extern "C" {

#endif /* __cplusplus */


    extern void OpenLcbLoginStateMachine_initialize(const interface_openlcb_login_state_machine_t *interface_openlcb_login_state_machine);


    extern void OpenLcbLoginMainStatemachine_run(void);


    extern void OpenLcbLoginStateMachine_process(openlcb_login_statemachine_info_t *openlcb_statemachine_info);


    extern bool OpenLcbLoginStatemachine_handle_outgoing_openlcb_message(void);


    extern bool OpenLcbLoginStatemachine_handle_try_reenumerate(void);


    extern bool OpenLcbLoginStatemachine_handle_try_enumerate_first_node(void);


    extern bool OpenLcbLoginStatemachine_handle_try_enumerate_next_node(void);


    extern openlcb_login_statemachine_info_t *OpenLcbLoginStatemachine_get_statemachine_info(void);


#ifdef    __cplusplus

}

#endif /* __cplusplus */


#endif    /* __OPENLCB_OPENLCB_LOGIN_STATEMACHINE__ */

OpenLcbLoginStateMachine_process
void OpenLcbLoginStateMachine_process(openlcb_login_statemachine_info_t *openlcb_statemachine_info)
Dispatches to the handler matching node->run_state. Exposed for unit testing.
Definition openlcb_login_statemachine.c:138

OpenLcbLoginStatemachine_handle_outgoing_openlcb_message
bool OpenLcbLoginStatemachine_handle_outgoing_openlcb_message(void)
Tries to send the pending message; returns true if one was pending. Exposed for unit testing.
Definition openlcb_login_statemachine.c:194

OpenLcbLoginStatemachine_handle_try_enumerate_next_node
bool OpenLcbLoginStatemachine_handle_try_enumerate_next_node(void)
Advances to the next node needing login. Exposed for unit testing.
Definition openlcb_login_statemachine.c:284

OpenLcbLoginStateMachine_initialize
void OpenLcbLoginStateMachine_initialize(const interface_openlcb_login_state_machine_t *interface_openlcb_login_state_machine)
Stores the callback interface. Call once at startup after OpenLcbLoginMessageHandler_initialize().
Definition openlcb_login_statemachine.c:108

OpenLcbLoginStatemachine_handle_try_reenumerate
bool OpenLcbLoginStatemachine_handle_try_reenumerate(void)
Re-enters the state processor if the enumerate flag is set. Exposed for unit testing.
Definition openlcb_login_statemachine.c:222

OpenLcbLoginMainStatemachine_run
void OpenLcbLoginMainStatemachine_run(void)
Runs one non-blocking step of login processing. Call from main loop.
Definition openlcb_login_statemachine.c:320

OpenLcbLoginStatemachine_handle_try_enumerate_first_node
bool OpenLcbLoginStatemachine_handle_try_enumerate_first_node(void)
Starts enumeration from the first node if none is active. Exposed for unit testing.
Definition openlcb_login_statemachine.c:247

OpenLcbLoginStatemachine_get_statemachine_info
openlcb_login_statemachine_info_t * OpenLcbLoginStatemachine_get_statemachine_info(void)
Returns pointer to internal static state machine info. For unit testing only — do not modify.
Definition openlcb_login_statemachine.c:353

openlcb_types.h
Core type definitions, structures, and configuration constants for the OpenLCB library.

interface_openlcb_login_state_machine_t
Callback interface for the login state machine. All pointers are REQUIRED unless noted....
Definition openlcb_login_statemachine.h:48

openlcb_login_statemachine_info_t
Login state machine context.
Definition openlcb_types.h:771

openlcb_msg_t
Core OpenLCB message structure.
Definition openlcb_types.h:480

openlcb_node_TAG
OpenLCB virtual node.
Definition openlcb_types.h:679