libIEC61850  0.8.3
Open-source IEC 61850 MMS/GOOSE server and client library
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Classes | Typedefs | Functions
mms_client_connection.h File Reference
#include "libiec61850_common_api.h"
#include "mms_common.h"
#include "mms_type_spec.h"
#include "mms_value.h"
#include "iso_connection_parameters.h"
#include "linked_list.h"

Go to the source code of this file.

Classes

struct  MmsConnectionParameters
 
struct  MmsServerIdentity
 

Typedefs

typedef void(* MmsInformationReportHandler )(void *parameter, char *domainName, char *variableListName, MmsValue *value, bool isVariableListName)
 
typedef struct sMmsConnection * MmsConnection
 
typedef void(* MmsConnectionLostHandler )(MmsConnection connection, void *parameter)
 User provided handler function that will be called if the connection to the server is lost. More...
 
typedef void(* MmsFileDirectoryHandler )(void *parameter, char *filename, uint32_t size, uint64_t lastModified)
 
typedef void(* MmsFileReadHandler )(void *parameter, int32_t frsmId, uint8_t *buffer, uint32_t bytesReceived)
 

Functions

MmsConnection MmsConnection_create (void)
 Create a new MmsConnection instance. More...
 
void MmsConnection_setRequestTimeout (MmsConnection self, uint32_t timeoutInMs)
 Set the request timeout in ms for this connection. More...
 
void MmsConnection_setConnectTimeout (MmsConnection self, uint32_t timeoutInMs)
 Set the connect timeout in ms for this connection instance. More...
 
void MmsConnection_setInformationReportHandler (MmsConnection self, MmsInformationReportHandler handler, void *parameter)
 Install a handler function for MMS information reports (unsolicited messages from the server). More...
 
IsoConnectionParameters MmsConnection_getIsoConnectionParameters (MmsConnection self)
 Get the connection parameters for an MmsConnection instance. More...
 
void MmsConnection_setConnectionLostHandler (MmsConnection self, MmsConnectionLostHandler handler, void *handlerParameter)
 Install a callback function that will be called by the client stack if the MMS connection to the server is lost. More...
 
void MmsConnection_setIsoConnectionParameters (MmsConnection self, IsoConnectionParameters *params)
 Set the ISO connection parameters for a MmsConnection instance. More...
 
void MmsConnection_destroy (MmsConnection self)
 Destroy an MmsConnection instance and release all resources. More...
 
bool MmsConnection_connect (MmsConnection self, MmsError *mmsError, const char *serverName, int serverPort)
 Connect to an MMS server. More...
 
void MmsConnection_close (MmsConnection self)
 Close the connection - not recommended. More...
 
void MmsConnection_abort (MmsConnection self, MmsError *mmsError)
 Uses the MMS/ACSE abort service to close the connection to the server. More...
 
void MmsConnection_conclude (MmsConnection self, MmsError *mmsError)
 Uses the MMS conclude service to close the connection to the server. More...
 
LinkedList MmsConnection_getVMDVariableNames (MmsConnection self, MmsError *mmsError)
 Get the names of all VMD scope variables of the server. More...
 
LinkedList MmsConnection_getDomainNames (MmsConnection self, MmsError *mmsError)
 Get the domains names for all domains of the server. More...
 
LinkedList MmsConnection_getDomainVariableNames (MmsConnection self, MmsError *mmsError, const char *domainId)
 Get the names of all variables present in a MMS domain of the server. More...
 
LinkedList MmsConnection_getDomainVariableListNames (MmsConnection self, MmsError *mmsError, const char *domainId)
 Get the names of all named variable lists present in a MMS domain of the server. More...
 
LinkedList MmsConnection_getVariableListNamesAssociationSpecific (MmsConnection self, MmsError *mmsError)
 Get the names of all named variable lists associated with this client connection. More...
 
MmsValueMmsConnection_readVariable (MmsConnection self, MmsError *mmsError, const char *domainId, const char *itemId)
 Read a single variable from the server. More...
 
MmsValueMmsConnection_readArrayElements (MmsConnection self, MmsError *mmsError, const char *domainId, const char *itemId, uint32_t startIndex, uint32_t numberOfElements)
 Read an element of a single array variable from the server. More...
 
MmsValueMmsConnection_readMultipleVariables (MmsConnection self, MmsError *mmsError, const char *domainId, LinkedListitems)
 Read multiple variables of a domain from the server with one request message. More...
 
void MmsConnection_writeVariable (MmsConnection self, MmsError *mmsError, const char *domainId, const char *itemId, MmsValue *value)
 Write a single variable to the server. More...
 
void MmsConnection_writeMultipleVariables (MmsConnection self, MmsError *mmsError, const char *domainId, LinkedListitems, LinkedListvalues, LinkedList *accessResults)
 Write multiple variables to the server. More...
 
MmsVariableSpecification * MmsConnection_getVariableAccessAttributes (MmsConnection self, MmsError *mmsError, const char *domainId, const char *itemId)
 Get the variable access attributes of a MMS named variable of the server. More...
 
MmsValueMmsConnection_readNamedVariableListValues (MmsConnection self, MmsError *mmsError, const char *domainId, const char *listName, bool specWithResult)
 Read the values of a domain specific named variable list. More...
 
MmsValueMmsConnection_readNamedVariableListValuesAssociationSpecific (MmsConnection self, MmsError *mmsError, const char *listName, bool specWithResult)
 Read the values of a association specific named variable list. More...
 
void MmsConnection_defineNamedVariableList (MmsConnection self, MmsError *mmsError, const char *domainId, const char *listName, LinkedList variableSpecs)
 Define a new named variable list at the server. More...
 
void MmsConnection_defineNamedVariableListAssociationSpecific (MmsConnection self, MmsError *mmsError, const char *listName, LinkedList variableSpecs)
 Define a new association specific named variable list at the server. More...
 
LinkedList MmsConnection_readNamedVariableListDirectory (MmsConnection self, MmsError *mmsError, const char *domainId, const char *listName, bool *deletable)
 Read the entry list of a named variable list at the server. More...
 
LinkedList MmsConnection_readNamedVariableListDirectoryAssociationSpecific (MmsConnection self, MmsError *mmsError, const char *listName, bool *deletable)
 Read the entry list of an association specific named variable list at the server. More...
 
void MmsConnection_deleteNamedVariableList (MmsConnection self, MmsError *mmsError, const char *domainId, const char *listName)
 Delete a named variable list at the server. More...
 
void MmsConnection_deleteAssociationSpecificNamedVariableList (MmsConnection self, MmsError *mmsError, const char *listName)
 Delete an association specific named variable list at the server. More...
 
MmsVariableAccessSpecification * MmsVariableAccessSpecification_create (char *domainId, char *itemId)
 Create a new MmsVariableSpecification that can be used to define named variable lists. More...
 
MmsVariableAccessSpecification * MmsVariableAccessSpecification_createAlternateAccess (char *domainId, char *itemId, int32_t index, char *componentName)
 Create a new MmsVariableSpecification that can be used to define named variable lists. More...
 
void MmsVariableAccessSpecification_destroy (MmsVariableAccessSpecification *self)
 Delete the MmsVariableAccessSpecification data structure. More...
 
void MmsConnection_setLocalDetail (MmsConnection self, int32_t localDetail)
 Get the MMS local detail parameter (local detail means maximum MMS PDU size). More...
 
int32_t MmsConnection_getLocalDetail (MmsConnection self)
 
MmsServerIdentityMmsConnection_identify (MmsConnection self, MmsError *mmsError)
 get the identity of the connected server More...
 
void MmsServerIdentity_destroy (MmsServerIdentity *self)
 
void MmsConnection_getServerStatus (MmsConnection self, MmsError *mmsError, int *vmdLogicalStatus, int *vmdPhysicalStatus, bool extendedDerivation)
 get the VMD status of the connected server (is MMS status service) More...
 
int32_t MmsConnection_fileOpen (MmsConnection self, MmsError *mmsError, const char *filename, uint32_t initialPosition, uint32_t *fileSize, uint64_t *lastModified)
 open a file for read More...
 
bool MmsConnection_fileRead (MmsConnection self, MmsError *mmsError, int32_t frsmId, MmsFileReadHandler handler, void *handlerParameter)
 read the next data block from the file More...
 
void MmsConnection_fileClose (MmsConnection self, MmsError *mmsError, int32_t frsmId)
 close the file with the specified frsmID More...
 
void MmsConnection_fileDelete (MmsConnection self, MmsError *mmsError, const char *fileName)
 delete the file with the specified name More...
 
void MmsConnection_fileRename (MmsConnection self, MmsError *mmsError, const char *currentFileName, const char *newFileName)
 rename the file with the specified name More...
 
bool MmsConnection_getFileDirectory (MmsConnection self, MmsError *mmsError, const char *fileSpecification, const char *continueAfter, MmsFileDirectoryHandler handler, void *handlerParameter)
 get the file directory of the server. More...