mms_server.h

Go to the documentation of this file.

/*
 *  mms_server.h
 *
 *  Copyright 2013, 2014 Michael Zillgith
 *
 *  This file is part of libIEC61850.
 *
 *  libIEC61850 is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  libIEC61850 is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with libIEC61850.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  See COPYING file for the complete license text.
 */

#ifndef MMS_SERVER_H_
#define MMS_SERVER_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "mms_device_model.h"
#include "mms_value.h"
#include "iso_server.h"

typedef enum {
        MMS_SERVER_NEW_CONNECTION, MMS_SERVER_CONNECTION_CLOSED
} MmsServerEvent;

typedef struct sMmsServer* MmsServer;

typedef struct sMmsServerConnection* MmsServerConnection;

typedef enum {
    MMS_DOMAIN_SPECIFIC,
    MMS_ASSOCIATION_SPECIFIC,
    MMS_VMD_SPECIFIC
} MmsVariableListType;

typedef MmsValue* (*MmsReadVariableHandler)(void* parameter, MmsDomain* domain,
                char* variableId, MmsServerConnection connection);

typedef MmsDataAccessError (*MmsReadAccessHandler) (void* parameter, MmsDomain* domain,
        char* variableId, MmsServerConnection connection);

typedef MmsDataAccessError (*MmsWriteVariableHandler)(void* parameter,
                MmsDomain* domain, char* variableId, MmsValue* value,
                MmsServerConnection connection);

typedef void (*MmsConnectionHandler)(void* parameter,
                MmsServerConnection connection, MmsServerEvent event);

MmsServer
MmsServer_create(MmsDevice* device, TLSConfiguration tlsConfiguration);

void
MmsServer_destroy(MmsServer self);

void
MmsServer_installReadHandler(MmsServer self, MmsReadVariableHandler,
                void* parameter);

void
MmsServer_installReadAccessHandler(MmsServer self, MmsReadAccessHandler, void* parameter);

void
MmsServer_installWriteHandler(MmsServer self, MmsWriteVariableHandler,
                void* parameter);

void
MmsServer_setLocalIpAddress(MmsServer self, const char* localIpAddress);

bool
MmsServer_isRunning(MmsServer self);

void
MmsServer_installConnectionHandler(MmsServer self, MmsConnectionHandler,
                void* parameter);

void
MmsServer_setClientAuthenticator(MmsServer self, AcseAuthenticator authenticator, void* authenticatorParameter);

MmsDevice*
MmsServer_getDevice(MmsServer self);

MmsValue*
MmsServer_getValueFromCache(MmsServer self, MmsDomain* domain, const char* itemId);

bool
MmsServer_isLocked(MmsServer self);

typedef MmsError (*MmsNamedVariableListChangedHandler)(void* parameter, bool create, MmsVariableListType listType, MmsDomain* domain,
        char* listName, MmsServerConnection connection);

void
MmsServer_installVariableListChangedHandler(MmsServer self, MmsNamedVariableListChangedHandler handler, void* parameter);

typedef bool (*MmsObtainFileHandler)(void* parameter, MmsServerConnection connection, const char* sourceFilename, const char* destinationFilename);

void
MmsServer_installObtainFileHandler(MmsServer self, MmsObtainFileHandler handler, void* parameter);

typedef void (*MmsGetFileCompleteHandler)(void* parameter, MmsServerConnection connection, const char* destinationFilename);

void
MmsServer_installGetFileCompleteHandler(MmsServer self, MmsGetFileCompleteHandler handler, void* parameter);


typedef  enum {
    MMS_FILE_ACCESS_TYPE_READ_DIRECTORY,
    MMS_FILE_ACCESS_TYPE_OPEN,
    MMS_FILE_ACCESS_TYPE_OBTAIN,
    MMS_FILE_ACCESS_TYPE_DELETE,
    MMS_FILE_ACCESS_TYPE_RENAME
} MmsFileServiceType;

typedef MmsError (*MmsFileAccessHandler) (void* parameter, MmsServerConnection connection, MmsFileServiceType service,
                                          const char* localFilename, const char* otherFilename);


void
MmsServer_installFileAccessHandler(MmsServer self, MmsFileAccessHandler handler, void* parameter);

void
MmsServer_setFilestoreBasepath(MmsServer self, const char* basepath);

void
MmsServer_lockModel(MmsServer self);

void
MmsServer_unlockModel(MmsServer self);

void
MmsServer_insertIntoCache(MmsServer self, MmsDomain* domain, char* itemId,
                MmsValue* value);

/***************************************************
 * Functions for multi-threaded operation mode
 ***************************************************/

void
MmsServer_startListening(MmsServer self, int tcpPort);

void
MmsServer_stopListening(MmsServer self);

/***************************************************
 * Functions for threadless operation mode
 ***************************************************/

void
MmsServer_startListeningThreadless(MmsServer self, int tcpPort);

int
MmsServer_waitReady(MmsServer self, unsigned int timeoutMs);

void
MmsServer_handleIncomingMessages(MmsServer self);

void
MmsServer_handleBackgroundTasks(MmsServer self);

void
MmsServer_stopListeningThreadless(MmsServer self);


/***************************************************
 * Functions for MMS identify service
 ***************************************************/

void
MmsServer_setServerIdentity(MmsServer self, char* vendorName, char* modelName, char* revision);

char*
MmsServer_getVendorName(MmsServer self);

char*
MmsServer_getModelName(MmsServer self);

char*
MmsServer_getRevision(MmsServer self);

/***************************************************
 * Functions for MMS status service
 ***************************************************/

#define MMS_LOGICAL_STATE_STATE_CHANGES_ALLOWED 0
#define MMS_LOGICAL_STATE_NO_STATE_CHANGES_ALLOWED 1
#define MMS_LOGICAL_STATE_LIMITED_SERVICES_PERMITTED 2
#define MMS_LOGICAL_STATE_SUPPORT_SERVICES_ALLOWED 3

#define MMS_PHYSICAL_STATE_OPERATIONAL 0
#define MMS_PHYSICAL_STATE_PARTIALLY_OPERATIONAL 1
#define MMS_PHYSICAL_STATE_INOPERATIONAL 2
#define MMS_PHYSICAL_STATE_NEEDS_COMMISSIONING 3

typedef void (*MmsStatusRequestListener)(void* parameter, MmsServer mmsServer, MmsServerConnection connection, bool extendedDerivation);

void
MmsServer_setVMDStatus(MmsServer self, int vmdLogicalStatus, int vmdPhysicalStatus);

int
MmsServer_getVMDLogicalStatus(MmsServer self);

int
MmsServer_getVMDPhysicalStatus(MmsServer self);

void
MmsServer_setStatusRequestListener(MmsServer self, MmsStatusRequestListener listener, void* parameter);

char*
MmsServerConnection_getClientAddress(MmsServerConnection self);

IsoConnection
MmsServerConnection_getIsoConnection(MmsServerConnection self);


#ifdef __cplusplus
}
#endif

#endif /* MMS_SERVER_H_ */