libIEC61850  0.8.2
Open-source IEC 61850 MMS/GOOSE server and client library
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Typedefs | Enumerations | Functions
Handle external access to data model and access control

Typedefs

typedef void(* AttributeChangedHandler )(DataAttribute *dataAttribute, ClientConnection connection)
 callback handler to monitor client access to data attributes More...
 
typedef bool(* WriteAccessHandler )(DataAttribute *dataAttribute, MmsValue *value, ClientConnection connection)
 callback handler to intercept/control client access to data attributes More...
 

Enumerations

enum  AccessPolicy { ACCESS_POLICY_ALLOW, ACCESS_POLICY_DENY }
 

Functions

void IedServer_observeDataAttribute (IedServer self, DataAttribute *dataAttribute, AttributeChangedHandler handler)
 Install an observer for a data attribute. More...
 
void IedServer_handleWriteAccess (IedServer self, DataAttribute *dataAttribute, WriteAccessHandler handler)
 Install a WriteAccessHandler for a data attribute. More...
 
void IedServer_setWriteAccessPolicy (IedServer self, FunctionalConstraint fc, AccessPolicy policy)
 Change the default write access policy for functional constraint data with a specific FC. More...
 

Detailed Description

Typedef Documentation

typedef void(* AttributeChangedHandler)(DataAttribute *dataAttribute, ClientConnection connection)

callback handler to monitor client access to data attributes

User provided callback function to observe (monitor) MMS client access to IEC 61850 data attributes. The application can install the same handler multiple times and distinguish data attributes by the dataAttribute parameter.

Parameters
thedata attribute that has been written by an MMS client.
connectionthe connection object of the client connection that invoked the write operation
typedef bool(* WriteAccessHandler)(DataAttribute *dataAttribute, MmsValue *value, ClientConnection connection)

callback handler to intercept/control client access to data attributes

User provided callback function to intercept/control MMS client access to IEC 61850 data attributes. The application can install the same handler multiple times and distinguish data attributes by the dataAttribute parameter. This handler can be used to perform write access control do data attributes. One application can be to allow write access only from a specific client. Another application could be to check if the value is in the allowed range before the write is accepted.

Parameters
thedata attribute that has been written by an MMS client.
thevalue the client want to write to the data attribtue
connectionthe connection object of the client connection that invoked the write operation
Returns
true if access is accepted, false if access is denied.

Enumeration Type Documentation

Enumerator
ACCESS_POLICY_ALLOW 
ACCESS_POLICY_DENY 

Function Documentation

void IedServer_handleWriteAccess ( IedServer  self,
DataAttribute *  dataAttribute,
WriteAccessHandler  handler 
)

Install a WriteAccessHandler for a data attribute.

This instructs the server to monitor write attempts by MMS clients to specific data attributes. If a client tries to write to the monitored data attribute the handler is invoked. The handler can decide if the write access will be allowed or denied. If a WriteAccessHandler is set for a specific data attribute - the default write access policy will not be performed for that data attribute.

Parameters
selfthe instance of IedServer to operate on.
dataAttributethe data attribute to monitor
handlerthe callback function that is invoked if a client tries to write to the monitored data attribute.
void IedServer_observeDataAttribute ( IedServer  self,
DataAttribute *  dataAttribute,
AttributeChangedHandler  handler 
)

Install an observer for a data attribute.

Deprecated:
Please use IedServer_handleWriteAccess instead!

This instructs the server to monitor write attempts by MMS clients to specific data attributes. If a successful write attempt happens the server will call the provided callback function to inform the application. This can be used to monitor important configuration values.

Parameters
selfthe instance of IedServer to operate on.
dataAttributethe data attribute to monitor
handlerthe callback function that is invoked if a client has written to the monitored data attribute.
void IedServer_setWriteAccessPolicy ( IedServer  self,
FunctionalConstraint  fc,
AccessPolicy  policy 
)

Change the default write access policy for functional constraint data with a specific FC.

Parameters
selfthe instance of IedServer to operate on.
fcthe FC for which to change the default write access policy.
policythe new policy to apply.