libiec61850  1.6.0
Typedefs | Enumerations | Functions
Server side report control block (RCB) handling

Functions and callbacks to handle report control blocks (RCBs) on the server side. More...

Typedefs

typedef void(* IedServer_RCBEventHandler) (void *parameter, ReportControlBlock *rcb, ClientConnection connection, IedServer_RCBEventType event, const char *parameterName, MmsDataAccessError serviceError)
 Callback that is called in case of RCB event. More...
 

Enumerations

enum  IedServer_RCBEventType {
  RCB_EVENT_GET_PARAMETER , RCB_EVENT_SET_PARAMETER , RCB_EVENT_UNRESERVED , RCB_EVENT_RESERVED ,
  RCB_EVENT_ENABLE , RCB_EVENT_DISABLE , RCB_EVENT_GI , RCB_EVENT_PURGEBUF ,
  RCB_EVENT_OVERFLOW , RCB_EVENT_REPORT_CREATED
}
 

Functions

LIB61850_API void IedServer_setRCBEventHandler (IedServer self, IedServer_RCBEventHandler handler, void *parameter)
 Set a handler for report control block (RCB) events. More...
 

Detailed Description

Functions and callbacks to handle report control blocks (RCBs) on the server side.

Typedef Documentation

◆ IedServer_RCBEventHandler

typedef void(* IedServer_RCBEventHandler) (void *parameter, ReportControlBlock *rcb, ClientConnection connection, IedServer_RCBEventType event, const char *parameterName, MmsDataAccessError serviceError)

Callback that is called in case of RCB event.

Parameters
parameteruser provided parameter
rcbaffected report control block
connectionclient connection that is involved
eventevent type
parameterNamename of the parameter in case of RCB_EVENT_SET_PARAMETER
serviceErrorservice error in case of RCB_EVENT_SET_PARAMETER

Enumeration Type Documentation

◆ IedServer_RCBEventType

Enumerator
RCB_EVENT_GET_PARAMETER 
RCB_EVENT_SET_PARAMETER 
RCB_EVENT_UNRESERVED 
RCB_EVENT_RESERVED 
RCB_EVENT_ENABLE 
RCB_EVENT_DISABLE 
RCB_EVENT_GI 
RCB_EVENT_PURGEBUF 
RCB_EVENT_OVERFLOW 
RCB_EVENT_REPORT_CREATED 

Function Documentation

◆ IedServer_setRCBEventHandler()

LIB61850_API void IedServer_setRCBEventHandler ( IedServer  self,
IedServer_RCBEventHandler  handler,
void *  parameter 
)

Set a handler for report control block (RCB) events.

Parameters
selfthe instance of IedServer to operate on.
handlerthe event handler to be used
parametera user provided parameter that is passed to the handler.