iec61850_server.h

Go to the documentation of this file.

/*
 *  iec61850_server.h
 *
 *  IEC 61850 server API for libiec61850.
 *
 *  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 IED_SERVER_API_H_
#define IED_SERVER_API_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "mms_server.h"
#include "iec61850_dynamic_model.h"
#include "iec61850_model.h"
#include "hal_filesystem.h"
#include "iec61850_config_file_parser.h"

typedef struct sIedServer* IedServer;

typedef struct sClientConnection* ClientConnection;

IedServer
IedServer_create(IedModel* dataModel);

IedServer
IedServer_createWithTlsSupport(IedModel* dataModel, TLSConfiguration tlsConfiguration);

void
IedServer_destroy(IedServer self);

void
IedServer_setLocalIpAddress(IedServer self, const char* localIpAddress);

void
IedServer_setFilestoreBasepath(IedServer self, const char* basepath);

void
IedServer_start(IedServer self, int tcpPort);

void
IedServer_stop(IedServer self);

void
IedServer_startThreadless(IedServer self, int tcpPort);

int
IedServer_waitReady(IedServer self, unsigned int timeoutMs);

void
IedServer_processIncomingData(IedServer self);

void
IedServer_performPeriodicTasks(IedServer self);

void
IedServer_stopThreadless(IedServer self);

IedModel*
IedServer_getDataModel(IedServer self);

bool
IedServer_isRunning(IedServer self);

MmsServer
IedServer_getMmsServer(IedServer self);

void
IedServer_enableGoosePublishing(IedServer self);

void
IedServer_disableGoosePublishing(IedServer self);

void
IedServer_setGooseInterfaceId(IedServer self, const char* interfaceId);

void
IedServer_setAuthenticator(IedServer self, AcseAuthenticator authenticator, void* authenticatorParameter);



const char*
ClientConnection_getPeerAddress(ClientConnection self);

void*
ClientConnection_getSecurityToken(ClientConnection self);

typedef void (*IedConnectionIndicationHandler) (IedServer self, ClientConnection connection, bool connected, void* parameter);

void
IedServer_setConnectionIndicationHandler(IedServer self, IedConnectionIndicationHandler handler, void* parameter);


void
IedServer_lockDataModel(IedServer self);

void
IedServer_unlockDataModel(IedServer self);

MmsValue*
IedServer_getAttributeValue(IedServer self, DataAttribute* dataAttribute);

bool
IedServer_getBooleanAttributeValue(IedServer self, const DataAttribute* dataAttribute);

int32_t
IedServer_getInt32AttributeValue(IedServer self, const DataAttribute* dataAttribute);

int64_t
IedServer_getInt64AttributeValue(IedServer self, const DataAttribute* dataAttribute);

uint32_t
IedServer_getUInt32AttributeValue(IedServer self, const DataAttribute* dataAttribute);

float
IedServer_getFloatAttributeValue(IedServer self, const DataAttribute* dataAttribute);

uint64_t
IedServer_getUTCTimeAttributeValue(IedServer self, const DataAttribute* dataAttribute);

uint32_t
IedServer_getBitStringAttributeValue(IedServer self, const DataAttribute* dataAttribute);

const char*
IedServer_getStringAttributeValue(IedServer self, const DataAttribute* dataAttribute);


MmsValue*
IedServer_getFunctionalConstrainedData(IedServer self, DataObject* dataObject, FunctionalConstraint fc);

void
IedServer_updateAttributeValue(IedServer self, DataAttribute* dataAttribute, MmsValue* value);

void
IedServer_updateFloatAttributeValue(IedServer self, DataAttribute* dataAttribute, float value);

void
IedServer_updateInt32AttributeValue(IedServer self, DataAttribute* dataAttribute, int32_t value);

void
IedServer_udpateDbposValue(IedServer self, DataAttribute* dataAttribute, Dbpos value);

void
IedServer_updateInt64AttributeValue(IedServer self, DataAttribute* dataAttribute, int64_t value);

void
IedServer_updateUnsignedAttributeValue(IedServer self, DataAttribute* dataAttribute, uint32_t value);

void
IedServer_updateBitStringAttributeValue(IedServer self, DataAttribute* dataAttribute, uint32_t value);

void
IedServer_updateBooleanAttributeValue(IedServer self, DataAttribute* dataAttribute, bool value);

void
IedServer_updateVisibleStringAttributeValue(IedServer self, DataAttribute* dataAttribute, char *value);

void
IedServer_updateUTCTimeAttributeValue(IedServer self, DataAttribute* dataAttribute, uint64_t value);

void
IedServer_updateTimestampAttributeValue(IedServer self, DataAttribute* dataAttribute, Timestamp* timestamp);

void
IedServer_updateQuality(IedServer self, DataAttribute* dataAttribute, Quality quality);

void
IedServer_setLogStorage(IedServer self, const char* logRef, LogStorage logStorage);

void
IedServer_changeActiveSettingGroup(IedServer self, SettingGroupControlBlock* sgcb, uint8_t newActiveSg);

uint8_t
IedServer_getActiveSettingGroup(IedServer self, SettingGroupControlBlock* sgcb);

typedef bool (*ActiveSettingGroupChangedHandler) (void* parameter, SettingGroupControlBlock* sgcb,
        uint8_t newActSg, ClientConnection connection);

void
IedServer_setActiveSettingGroupChangedHandler(IedServer self, SettingGroupControlBlock* sgcb,
        ActiveSettingGroupChangedHandler handler, void* parameter);

typedef bool (*EditSettingGroupChangedHandler) (void* parameter, SettingGroupControlBlock* sgcb,
        uint8_t newEditSg, ClientConnection connection);

void
IedServer_setEditSettingGroupChangedHandler(IedServer self, SettingGroupControlBlock* sgcb,
        EditSettingGroupChangedHandler handler, void* parameter);

typedef void (*EditSettingGroupConfirmationHandler) (void* parameter, SettingGroupControlBlock* sgcb,
        uint8_t editSg);

void
IedServer_setEditSettingGroupConfirmationHandler(IedServer self, SettingGroupControlBlock* sgcb,
        EditSettingGroupConfirmationHandler handler, void* parameter);

typedef enum {
    CONTROL_ACCEPTED = -1, 
    CONTROL_HARDWARE_FAULT = 1, 
    CONTROL_TEMPORARILY_UNAVAILABLE = 2, 
    CONTROL_OBJECT_ACCESS_DENIED = 3, 
    CONTROL_OBJECT_UNDEFINED = 4, 
    CONTROL_VALUE_INVALID = 11 
} CheckHandlerResult;

typedef enum {
    CONTROL_RESULT_FAILED = 0, 
    CONTROL_RESULT_OK = 1,     
    CONTROL_RESULT_WAITING = 2 
} ControlHandlerResult;

typedef CheckHandlerResult (*ControlPerformCheckHandler) (void* parameter, MmsValue* ctlVal, bool test, bool interlockCheck,
        ClientConnection connection);

typedef ControlHandlerResult (*ControlWaitForExecutionHandler) (void* parameter, MmsValue* ctlVal, bool test, bool synchroCheck);

typedef ControlHandlerResult (*ControlHandler) (void* parameter, MmsValue* ctlVal, bool test);

void
IedServer_setControlHandler(IedServer self, DataObject* node, ControlHandler handler, void* parameter);

void
IedServer_setPerformCheckHandler(IedServer self, DataObject* node, ControlPerformCheckHandler handler, void* parameter);

void
IedServer_setWaitForExecutionHandler(IedServer self, DataObject* node, ControlWaitForExecutionHandler handler, void* parameter);

#define IEC61850_SVCB_EVENT_ENABLE 1

#define IEC61850_SVCB_EVENT_DISABLE 0

typedef void (*SVCBEventHandler) (SVControlBlock* svcb, int event, void* parameter);

void
IedServer_setSVCBHandler(IedServer self, SVControlBlock* svcb, SVCBEventHandler handler, void* parameter);

/***************************************************************************
 * Access control
 **************************************************************************/

typedef MmsDataAccessError
(*WriteAccessHandler) (DataAttribute* dataAttribute, MmsValue* value, ClientConnection connection, void* parameter);

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

typedef enum {
    ACCESS_POLICY_ALLOW,
    ACCESS_POLICY_DENY
} AccessPolicy;

void
IedServer_setWriteAccessPolicy(IedServer self, FunctionalConstraint fc, AccessPolicy policy);

#ifdef __cplusplus
}
#endif

#endif /* IED_SERVER_API_H_ */