libiec61850
1.5.3
|
Typedefs | |
typedef void(* | IedConnectionIndicationHandler) (IedServer self, ClientConnection connection, bool connected, void *parameter) |
User provided callback function that is invoked whenever a new client connects or an existing connection is closed or detected as lost. More... | |
Functions | |
LIB61850_API void | IedServer_setAuthenticator (IedServer self, AcseAuthenticator authenticator, void *authenticatorParameter) |
set the authenticator for this server More... | |
LIB61850_API const char * | ClientConnection_getPeerAddress (ClientConnection self) |
get the peer address of this connection as string More... | |
LIB61850_API const char * | ClientConnection_getLocalAddress (ClientConnection self) |
get the local address of this connection as string More... | |
LIB61850_API void * | ClientConnection_getSecurityToken (ClientConnection self) |
Get the security token associated with this connection. More... | |
LIB61850_API void | IedServer_setConnectionIndicationHandler (IedServer self, IedConnectionIndicationHandler handler, void *parameter) |
set a callback function that will be called on connection events (open or close). More... | |
typedef void(* IedConnectionIndicationHandler) (IedServer self, ClientConnection connection, bool connected, void *parameter) |
User provided callback function that is invoked whenever a new client connects or an existing connection is closed or detected as lost.
self | the instance of IedServer where the connection event occured. |
connection | the new or closed client connect object |
connected | true if a new connection is indicated, false if the connection has been closed or detected as lost. |
parameter | a user provided parameter |
LIB61850_API const char* ClientConnection_getLocalAddress | ( | ClientConnection | self | ) |
get the local address of this connection as string
Note: the returned string is only valid as long as the client connection exists. It is save to use the string inside of the connection indication callback function.
self | the ClientConnection instance |
LIB61850_API const char* ClientConnection_getPeerAddress | ( | ClientConnection | self | ) |
get the peer address of this connection as string
Note: the returned string is only valid as long as the client connection exists. It is save to use the string inside of the connection indication callback function.
self | the ClientConnection instance |
LIB61850_API void* ClientConnection_getSecurityToken | ( | ClientConnection | self | ) |
Get the security token associated with this connection.
The security token is an opaque handle that is associated with the connection. It is provided by the authenticator (if one is present). If no security token is used then this function returns NULL
self | the ClientConnection instance |
LIB61850_API void IedServer_setAuthenticator | ( | IedServer | self, |
AcseAuthenticator | authenticator, | ||
void * | authenticatorParameter | ||
) |
set the authenticator for this server
This function sets a user specified authenticator that is used to identify and authenticate clients that wants to connect. The authenticator is called on each connection attempt. Depending on the return value of the authenticator the client connection is accepted or refused. If no authenticator is set all client connections are accepted.
self | the instance of IedServer to operate on. |
authenticator | the user provided authenticator callback |
authenticatorParameter | user provided parameter that is passed to the authenticator |
LIB61850_API void IedServer_setConnectionIndicationHandler | ( | IedServer | self, |
IedConnectionIndicationHandler | handler, | ||
void * | parameter | ||
) |
set a callback function that will be called on connection events (open or close).
self | the instance of IedServer to operate on. |
handler | the user provided callback function |
parameter | a user provided parameter that is passed to the callback function. |