VLCB SDK
An opinionated SDK for VLCB protocol
Loading...
Searching...
No Matches
module.h File Reference
#include "vlcb/common/node.h"
#include "vlcb/module/param.h"
#include "vlcb/module/state.h"
#include "vlcb/module/ui.h"
#include "vlcb/net/iface.h"
#include "vlcb/net/socket/datagram.h"
#include "vlcb/platform/time.h"
#include <stdint.h>
Include dependency graph for module/inc/vlcb/module.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  VlcbModuleConfig
 
struct  VlcbModule
 

Typedefs

typedef uint8_t VlcbModulePersistedState
 
typedef uint8_t VlcbModuleOpFlags
 
typedef void(* RestartRequestHandler) (void)
 

Enumerations

enum  VlcbPersistedModuleState { VLCB_MODULE_PERSISTED_STATE_UNINITIALIZED = 1 , VLCB_MODULE_PERSISTED_STATE_NORMAL }
 
enum  VlcbModuleOpFlags { VLCB_MODULE_FLAGS_HEARTBEAT = 0x01 , VLCB_MODULE_FLAGS_EVENT_ACK = 0x02 }
 

Functions

VlcbModule vlcb_module_New (const char *const name, VlcbNetIface *const iface, VlcbNetSocketDatagram *const socket, const IVlcbModuleUi ui, VlcbModuleParams *const params, RestartRequestHandler reboot)
 
void vlcb_module_Init (VlcbModule *const module, const clock_t now)
 
void vlcb_module_Poll (VlcbModule *const module, const clock_t now)
 

Typedef Documentation

◆ RestartRequestHandler

typedef void(* RestartRequestHandler) (void)

Definition at line 56 of file module/inc/vlcb/module.h.

◆ VlcbModuleOpFlags

typedef uint8_t VlcbModuleOpFlags

Definition at line 43 of file module/inc/vlcb/module.h.

◆ VlcbModulePersistedState

typedef uint8_t VlcbModulePersistedState

Module state for persistent storage

Module can enter states that should not be persisted

Definition at line 37 of file module/inc/vlcb/module.h.

Enumeration Type Documentation

◆ VlcbModuleOpFlags

Enumerator
VLCB_MODULE_FLAGS_HEARTBEAT 
VLCB_MODULE_FLAGS_EVENT_ACK 

Definition at line 44 of file module/inc/vlcb/module.h.

◆ VlcbPersistedModuleState

Enumerator
VLCB_MODULE_PERSISTED_STATE_UNINITIALIZED 
VLCB_MODULE_PERSISTED_STATE_NORMAL 

Definition at line 38 of file module/inc/vlcb/module.h.

Function Documentation

◆ vlcb_module_Init()

void vlcb_module_Init ( VlcbModule *const module,
const clock_t now )

Definition at line 242 of file module.c.

Here is the call graph for this function:

◆ vlcb_module_New()

VlcbModule vlcb_module_New ( const char *const name,
VlcbNetIface *const iface,
VlcbNetSocketDatagram *const socket,
const IVlcbModuleUi ui,
VlcbModuleParams *const params,
RestartRequestHandler reboot )

Definition at line 219 of file module.c.

◆ vlcb_module_Poll()

void vlcb_module_Poll ( VlcbModule *const module,
const clock_t now )

Definition at line 249 of file module.c.

Here is the call graph for this function: