libosmovty  0.9.6.270-38c0
Osmocom VTY library
 All Data Structures Files Functions Variables Enumerations Enumerator Modules Pages
Fsm

VTY interface for Osmocom FSM. More...

Macros

#define SH_FSM_STR   SHOW_STR "Show information about finite state machines\n"
 
#define SH_FSMI_STR   SHOW_STR "Show information about finite state machine instances\n"
 

Functions

void vty_out_fsm (struct vty *vty, struct osmo_fsm *fsm)
 Print information about a FSM [class] to the given VTY. More...
 
void vty_out_fsm_inst (struct vty *vty, struct osmo_fsm_inst *fsmi)
 Print a FSM instance to the given VTY. More...
 
 DEFUN (show_fsms, show_fsms_cmd,"show fsm all", SH_FSM_STR"Display a list of all registered finite state machines\n")
 
 DEFUN (show_fsm, show_fsm_cmd,"show fsm NAME", SH_FSM_STR"Display information about a single named finite state machine\n")
 
 DEFUN (show_fsm_insts, show_fsm_insts_cmd,"show fsm-instances all", SH_FSMI_STR"Display a list of all FSM instances of all finite state machine")
 
 DEFUN (show_fsm_inst, show_fsm_inst_cmd,"show fsm-instances NAME", SH_FSMI_STR"Display a list of all FSM instances of the named finite state machine")
 
void osmo_fsm_vty_add_cmds (void)
 Install VTY commands for FSM introspection This installs a couple of VTY commands for introspection of FSM classes as well as FSM instances. Call this once from your application if you want to support those commands.
 

Variables

struct llist_head osmo_g_fsms
 

Detailed Description

VTY interface for Osmocom FSM.

This is code implementing generic VTY access to Osmocom FSMs from libosmocore. This means that any application can expose all state of all instances of all registered FSM classes by calling a single command during startup: osmo_fsm_vty_add_cmds

Function Documentation

void vty_out_fsm ( struct vty vty,
struct osmo_fsm *  fsm 
)

Print information about a FSM [class] to the given VTY.

Parameters
vtyThe VTY to which to print
[in]fsmThe FSM class to print

References vty_out().

void vty_out_fsm_inst ( struct vty vty,
struct osmo_fsm_inst *  fsmi 
)

Print a FSM instance to the given VTY.

Parameters
vtyThe VTY to which to print
[in]fsmiThe FSM instance to print

References vty_out().