iec61850_client.h

Go to the documentation of this file.

/*
 *  iec61850_client.h
 *
 *  Copyright 2013-2021 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 IEC61850_CLIENT_H_
#define IEC61850_CLIENT_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "libiec61850_common_api.h"
#include "iec61850_common.h"
#include "mms_value.h"
#include "mms_client_connection.h"
#include "linked_list.h"
 
typedef struct sClientDataSet* ClientDataSet;
 
typedef struct sClientReport* ClientReport;
 
typedef struct sClientReportControlBlock* ClientReportControlBlock;
 
typedef struct sClientGooseControlBlock* ClientGooseControlBlock;
 
typedef struct sIedConnection* IedConnection;
 
typedef struct
{
    int ctlNum;
    ControlLastApplError error;
    ControlAddCause addCause;
} LastApplError;
 
typedef enum
{
    IED_STATE_CLOSED = 0,
    IED_STATE_CONNECTING,
    IED_STATE_CONNECTED,
    IED_STATE_CLOSING
} IedConnectionState;
 
typedef enum {
    /* general errors */
 
    IED_ERROR_OK = 0,
 
    IED_ERROR_NOT_CONNECTED = 1,
 
    IED_ERROR_ALREADY_CONNECTED = 2,
 
    IED_ERROR_CONNECTION_LOST = 3,
 
    IED_ERROR_SERVICE_NOT_SUPPORTED = 4,
 
    IED_ERROR_CONNECTION_REJECTED = 5,
 
    IED_ERROR_OUTSTANDING_CALL_LIMIT_REACHED = 6,
 
    /* client side errors */
 
    IED_ERROR_USER_PROVIDED_INVALID_ARGUMENT = 10,
 
    IED_ERROR_ENABLE_REPORT_FAILED_DATASET_MISMATCH = 11,
 
    IED_ERROR_OBJECT_REFERENCE_INVALID = 12,
 
    IED_ERROR_UNEXPECTED_VALUE_RECEIVED = 13,
 
    /* service error - error reported by server */
 
    IED_ERROR_TIMEOUT = 20,
 
    IED_ERROR_ACCESS_DENIED = 21,
 
    IED_ERROR_OBJECT_DOES_NOT_EXIST = 22,
 
    IED_ERROR_OBJECT_EXISTS = 23,
 
    IED_ERROR_OBJECT_ACCESS_UNSUPPORTED = 24,
 
    IED_ERROR_TYPE_INCONSISTENT = 25,
 
    IED_ERROR_TEMPORARILY_UNAVAILABLE = 26,
 
    IED_ERROR_OBJECT_UNDEFINED = 27,
 
    IED_ERROR_INVALID_ADDRESS = 28,
 
    IED_ERROR_HARDWARE_FAULT = 29,
 
    IED_ERROR_TYPE_UNSUPPORTED = 30,
 
    IED_ERROR_OBJECT_ATTRIBUTE_INCONSISTENT = 31,
 
    IED_ERROR_OBJECT_VALUE_INVALID = 32,
 
    IED_ERROR_OBJECT_INVALIDATED = 33,
 
    IED_ERROR_MALFORMED_MESSAGE = 34,
 
    IED_ERROR_SERVICE_NOT_IMPLEMENTED = 98,
 
    IED_ERROR_UNKNOWN = 99
} IedClientError;
 
/**************************************************
 * Connection creation and destruction
 **************************************************/
 
LIB61850_API IedConnection
IedConnection_create(void);
 
LIB61850_API IedConnection
IedConnection_createEx(TLSConfiguration tlsConfig, bool useThreads);
 
LIB61850_API IedConnection
IedConnection_createWithTlsSupport(TLSConfiguration tlsConfig);
 
LIB61850_API void
IedConnection_destroy(IedConnection self);
 
LIB61850_API void
IedConnection_setLocalAddress(IedConnection self, const char* localIpAddress, int localPort);
 
LIB61850_API void
IedConnection_setConnectTimeout(IedConnection self, uint32_t timeoutInMs);
 
LIB61850_API void
IedConnection_setRequestTimeout(IedConnection self, uint32_t timeoutInMs);
 
LIB61850_API uint32_t
IedConnection_getRequestTimeout(IedConnection self);
 
LIB61850_API void
IedConnection_setTimeQuality(IedConnection self, bool leapSecondKnown, bool clockFailure, bool clockNotSynchronized, int subsecondPrecision);
 
LIB61850_API bool
IedConnection_tick(IedConnection self);
 
typedef void
(*IedConnection_GenericServiceHandler) (uint32_t invokeId, void* parameter, IedClientError err);
 
/**************************************************
 * Association service
 **************************************************/
 
LIB61850_API void
IedConnection_connect(IedConnection self, IedClientError* error, const char* hostname, int tcpPort);
 
LIB61850_API void
IedConnection_connectAsync(IedConnection self, IedClientError* error, const char* hostname, int tcpPort);
 
LIB61850_API void
IedConnection_abort(IedConnection self, IedClientError* error);
 
LIB61850_API void
IedConnection_abortAsync(IedConnection self, IedClientError* error);
 
LIB61850_API void
IedConnection_release(IedConnection self, IedClientError* error);
 
LIB61850_API void
IedConnection_releaseAsync(IedConnection self, IedClientError* error);
 
LIB61850_API void
IedConnection_close(IedConnection self);
 
LIB61850_API IedConnectionState
IedConnection_getState(IedConnection self);
 
LIB61850_API LastApplError
IedConnection_getLastApplError(IedConnection self);
 
typedef void
(*IedConnectionClosedHandler) (void* parameter, IedConnection connection);
 
LIB61850_API void
IedConnection_installConnectionClosedHandler(IedConnection self, IedConnectionClosedHandler handler,
        void* parameter);
 
typedef void
(*IedConnection_StateChangedHandler) (void* parameter, IedConnection connection, IedConnectionState newState);
 
LIB61850_API void
IedConnection_installStateChangedHandler(IedConnection self, IedConnection_StateChangedHandler handler, void* parameter);
 
LIB61850_API MmsConnection
IedConnection_getMmsConnection(IedConnection self);
 
#define IEC61850_SV_OPT_REFRESH_TIME 1
 
#define IEC61850_SV_OPT_SAMPLE_SYNC 2
 
#define IEC61850_SV_OPT_SAMPLE_RATE 4
 
#define IEC61850_SV_OPT_DATA_SET 8
 
#define IEC61850_SV_OPT_SECURITY 16
 
#define IEC61850_SV_SMPMOD_SAMPLES_PER_PERIOD 0
 
#define IEC61850_SV_SMPMOD_SAMPLES_PER_SECOND 1
 
#define IEC61850_SV_SMPMOD_SECONDS_PER_SAMPLE 2
 
 
typedef struct sClientSVControlBlock* ClientSVControlBlock;
 
LIB61850_API ClientSVControlBlock
ClientSVControlBlock_create(IedConnection connection, const char* reference);
 
LIB61850_API void
ClientSVControlBlock_destroy(ClientSVControlBlock self);
 
LIB61850_API bool
ClientSVControlBlock_isMulticast(ClientSVControlBlock self);
 
LIB61850_API IedClientError
ClientSVControlBlock_getLastComError(ClientSVControlBlock self);
 
 
LIB61850_API bool
ClientSVControlBlock_setSvEna(ClientSVControlBlock self, bool value);
 
LIB61850_API bool
ClientSVControlBlock_getSvEna(ClientSVControlBlock self);
 
LIB61850_API bool
ClientSVControlBlock_setResv(ClientSVControlBlock self, bool value);
 
LIB61850_API bool
ClientSVControlBlock_getResv(ClientSVControlBlock self);
 
LIB61850_API char*
ClientSVControlBlock_getMsvID(ClientSVControlBlock self);
 
LIB61850_API char*
ClientSVControlBlock_getDatSet(ClientSVControlBlock self);
 
LIB61850_API uint32_t
ClientSVControlBlock_getConfRev(ClientSVControlBlock self);
 
LIB61850_API uint16_t
ClientSVControlBlock_getSmpRate(ClientSVControlBlock self);
 
 
LIB61850_API PhyComAddress
ClientSVControlBlock_getDstAddress(ClientSVControlBlock self);
 
LIB61850_API int
ClientSVControlBlock_getOptFlds(ClientSVControlBlock self);
 
LIB61850_API uint8_t
ClientSVControlBlock_getSmpMod(ClientSVControlBlock self);
 
LIB61850_API int
ClientSVControlBlock_getNoASDU(ClientSVControlBlock self);
 
 
/*********************************************************
 * GOOSE services handling (MMS part)
 ********************************************************/
 
#define GOCB_ELEMENT_GO_ENA       1
 
#define GOCB_ELEMENT_GO_ID        2
 
#define GOCB_ELEMENT_DATSET       4
 
#define GOCB_ELEMENT_CONF_REV     8
 
#define GOCB_ELEMENT_NDS_COMM    16
 
#define GOCB_ELEMENT_DST_ADDRESS 32
 
#define GOCB_ELEMENT_MIN_TIME    64
 
#define GOCB_ELEMENT_MAX_TIME   128
 
#define GOCB_ELEMENT_FIXED_OFFS 256
 
#define GOCB_ELEMENT_ALL        511
 
 
/**************************************************
 * ClientGooseControlBlock class
 **************************************************/
 
LIB61850_API ClientGooseControlBlock
ClientGooseControlBlock_create(const char* dataAttributeReference);
 
LIB61850_API void
ClientGooseControlBlock_destroy(ClientGooseControlBlock self);
 
LIB61850_API bool
ClientGooseControlBlock_getGoEna(ClientGooseControlBlock self);
 
LIB61850_API void
ClientGooseControlBlock_setGoEna(ClientGooseControlBlock self, bool goEna);
 
LIB61850_API const char*
ClientGooseControlBlock_getGoID(ClientGooseControlBlock self);
 
LIB61850_API void
ClientGooseControlBlock_setGoID(ClientGooseControlBlock self, const char* goID);
 
LIB61850_API const char*
ClientGooseControlBlock_getDatSet(ClientGooseControlBlock self);
 
LIB61850_API void
ClientGooseControlBlock_setDatSet(ClientGooseControlBlock self, const char* datSet);
 
LIB61850_API uint32_t
ClientGooseControlBlock_getConfRev(ClientGooseControlBlock self);
 
LIB61850_API bool
ClientGooseControlBlock_getNdsComm(ClientGooseControlBlock self);
 
LIB61850_API uint32_t
ClientGooseControlBlock_getMinTime(ClientGooseControlBlock self);
 
LIB61850_API uint32_t
ClientGooseControlBlock_getMaxTime(ClientGooseControlBlock self);
 
LIB61850_API bool
ClientGooseControlBlock_getFixedOffs(ClientGooseControlBlock self);
 
LIB61850_API PhyComAddress
ClientGooseControlBlock_getDstAddress(ClientGooseControlBlock self);
 
LIB61850_API void
ClientGooseControlBlock_setDstAddress(ClientGooseControlBlock self, PhyComAddress value);
 
LIB61850_API DEPRECATED MmsValue* /* MMS_OCTET_STRING */
ClientGooseControlBlock_getDstAddress_addr(ClientGooseControlBlock self);
 
LIB61850_API DEPRECATED void
ClientGooseControlBlock_setDstAddress_addr(ClientGooseControlBlock self, MmsValue* macAddr);
 
LIB61850_API DEPRECATED uint8_t
ClientGooseControlBlock_getDstAddress_priority(ClientGooseControlBlock self);
 
LIB61850_API DEPRECATED void
ClientGooseControlBlock_setDstAddress_priority(ClientGooseControlBlock self, uint8_t priorityValue);
 
LIB61850_API DEPRECATED uint16_t
ClientGooseControlBlock_getDstAddress_vid(ClientGooseControlBlock self);
 
LIB61850_API DEPRECATED void
ClientGooseControlBlock_setDstAddress_vid(ClientGooseControlBlock self, uint16_t vidValue);
 
LIB61850_API DEPRECATED uint16_t
ClientGooseControlBlock_getDstAddress_appid(ClientGooseControlBlock self);
 
LIB61850_API DEPRECATED void
ClientGooseControlBlock_setDstAddress_appid(ClientGooseControlBlock self, uint16_t appidValue);
 
 
/*********************************************************
 * GOOSE services (access to GOOSE Control Blocks (GoCB))
 ********************************************************/
 
LIB61850_API ClientGooseControlBlock
IedConnection_getGoCBValues(IedConnection self, IedClientError* error, const char* goCBReference, ClientGooseControlBlock updateGoCB);
 
LIB61850_API void
IedConnection_setGoCBValues(IedConnection self, IedClientError* error, ClientGooseControlBlock goCB,
        uint32_t parametersMask, bool singleRequest);
 
/****************************************
 * Data model access services
 ****************************************/
 
LIB61850_API MmsValue*
IedConnection_readObject(IedConnection self, IedClientError* error, const char* dataAttributeReference, FunctionalConstraint fc);
 
typedef void
(*IedConnection_ReadObjectHandler) (uint32_t invokeId, void* parameter, IedClientError err, MmsValue* value);
 
LIB61850_API uint32_t
IedConnection_readObjectAsync(IedConnection self, IedClientError* error, const char* objRef, FunctionalConstraint fc,
        IedConnection_ReadObjectHandler handler, void* parameter);
 
LIB61850_API void
IedConnection_writeObject(IedConnection self, IedClientError* error, const char* dataAttributeReference, FunctionalConstraint fc,
        MmsValue* value);
 
LIB61850_API uint32_t
IedConnection_writeObjectAsync(IedConnection self, IedClientError* error, const char* objectReference,
        FunctionalConstraint fc, MmsValue* value, IedConnection_GenericServiceHandler handler, void* parameter);
 
LIB61850_API bool
IedConnection_readBooleanValue(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc);
 
LIB61850_API float
IedConnection_readFloatValue(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc);
 
LIB61850_API char*
IedConnection_readStringValue(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc);
 
LIB61850_API int32_t
IedConnection_readInt32Value(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc);
 
LIB61850_API int64_t
IedConnection_readInt64Value(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc);
 
LIB61850_API uint32_t
IedConnection_readUnsigned32Value(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc);
 
LIB61850_API Timestamp*
IedConnection_readTimestampValue(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc,
        Timestamp* timeStamp);
 
LIB61850_API Quality
IedConnection_readQualityValue(IedConnection self, IedClientError* error, const char* objectReference, FunctionalConstraint fc);
 
LIB61850_API void
IedConnection_writeBooleanValue(IedConnection self, IedClientError* error, const char* objectReference,
        FunctionalConstraint fc, bool value);
 
LIB61850_API void
IedConnection_writeInt32Value(IedConnection self, IedClientError* error, const char* objectReference,
        FunctionalConstraint fc, int32_t value);
 
LIB61850_API void
IedConnection_writeUnsigned32Value(IedConnection self, IedClientError* error, const char* objectReference,
        FunctionalConstraint fc, uint32_t value);
 
LIB61850_API void
IedConnection_writeFloatValue(IedConnection self, IedClientError* error, const char* objectReference,
        FunctionalConstraint fc, float value);
 
LIB61850_API void
IedConnection_writeVisibleStringValue(IedConnection self, IedClientError* error, const char* objectReference,
        FunctionalConstraint fc, char* value);
 
LIB61850_API void
IedConnection_writeOctetString(IedConnection self, IedClientError* error, const char* objectReference,
        FunctionalConstraint fc, uint8_t* value, int valueLength);
 
/********************************************
 * Reporting services
 ********************************************/
 
LIB61850_API ClientReportControlBlock
IedConnection_getRCBValues(IedConnection self, IedClientError* error, const char* rcbReference,
        ClientReportControlBlock updateRcb);
 
typedef void
(*IedConnection_GetRCBValuesHandler) (uint32_t invokeId, void* parameter, IedClientError err, ClientReportControlBlock rcb);
 
LIB61850_API uint32_t
IedConnection_getRCBValuesAsync(IedConnection self, IedClientError* error, const char* rcbReference, ClientReportControlBlock updateRcb,
        IedConnection_GetRCBValuesHandler handler, void* parameter);
 
typedef int ReasonForInclusion;
 
#define IEC61850_REASON_NOT_INCLUDED 0
 
#define IEC61850_REASON_DATA_CHANGE 1
 
#define IEC61850_REASON_QUALITY_CHANGE 2
 
#define IEC61850_REASON_DATA_UPDATE 4
 
#define IEC61850_REASON_INTEGRITY 8
 
#define IEC61850_REASON_GI 16
 
#define IEC61850_REASON_UNKNOWN 32
 
#define REASON_NOT_INCLUDED IEC61850_REASON_NOT_INCLUDED
#define REASON_DATA_CHANGE IEC61850_REASON_DATA_CHANGE
#define REASON_QUALITY_CHANGE IEC61850_REASON_QUALITY_CHANGE
#define REASON_DATA_UPDATE IEC61850_REASON_DATA_UPDATE
#define REASON_INTEGRITY IEC61850_REASON_INTEGRITY
#define REASON_GI IEC61850_REASON_GI
#define REASON_UNKNOWN IEC61850_REASON_UNKNOWN
 
 
/* Element encoding mask values for ClientReportControlBlock */
 
#define RCB_ELEMENT_RPT_ID            1
 
#define RCB_ELEMENT_RPT_ENA           2
 
#define RCB_ELEMENT_RESV              4
 
#define RCB_ELEMENT_DATSET            8
 
#define RCB_ELEMENT_CONF_REV         16
 
#define RCB_ELEMENT_OPT_FLDS         32
 
#define RCB_ELEMENT_BUF_TM           64
 
#define RCB_ELEMENT_SQ_NUM          128
 
#define RCB_ELEMENT_TRG_OPS         256
 
#define RCB_ELEMENT_INTG_PD         512
 
#define RCB_ELEMENT_GI             1024
 
#define RCB_ELEMENT_PURGE_BUF      2048
 
#define RCB_ELEMENT_ENTRY_ID       4096
 
#define RCB_ELEMENT_TIME_OF_ENTRY  8192
 
#define RCB_ELEMENT_RESV_TMS      16384
 
#define RCB_ELEMENT_OWNER         32768
 
LIB61850_API void
IedConnection_setRCBValues(IedConnection self, IedClientError* error, ClientReportControlBlock rcb,
        uint32_t parametersMask, bool singleRequest);
 
LIB61850_API uint32_t
IedConnection_setRCBValuesAsync(IedConnection self, IedClientError* error, ClientReportControlBlock rcb,
        uint32_t parametersMask, bool singleRequest, IedConnection_GenericServiceHandler handler, void* parameter);
 
typedef void (*ReportCallbackFunction) (void* parameter, ClientReport report);
 
LIB61850_API void
IedConnection_installReportHandler(IedConnection self, const char* rcbReference, const char* rptId, ReportCallbackFunction handler,
        void* handlerParameter);
 
LIB61850_API void
IedConnection_uninstallReportHandler(IedConnection self, const char* rcbReference);
 
LIB61850_API void
IedConnection_triggerGIReport(IedConnection self, IedClientError* error, const char* rcbReference);
 
/****************************************
 * Access to received reports
 ****************************************/
 
LIB61850_API const char*
ClientReport_getDataSetName(ClientReport self);
 
LIB61850_API MmsValue*
ClientReport_getDataSetValues(ClientReport self);
 
LIB61850_API char*
ClientReport_getRcbReference(ClientReport self);
 
LIB61850_API char*
ClientReport_getRptId(ClientReport self);
 
LIB61850_API ReasonForInclusion
ClientReport_getReasonForInclusion(ClientReport self, int elementIndex);
 
LIB61850_API MmsValue*
ClientReport_getEntryId(ClientReport self);
 
LIB61850_API bool
ClientReport_hasTimestamp(ClientReport self);
 
LIB61850_API bool
ClientReport_hasSeqNum(ClientReport self);
 
LIB61850_API uint16_t
ClientReport_getSeqNum(ClientReport self);
 
LIB61850_API bool
ClientReport_hasDataSetName(ClientReport self);
 
LIB61850_API bool
ClientReport_hasReasonForInclusion(ClientReport self);
 
LIB61850_API bool
ClientReport_hasConfRev(ClientReport self);
 
LIB61850_API uint32_t
ClientReport_getConfRev(ClientReport self);
 
LIB61850_API bool
ClientReport_hasBufOvfl(ClientReport self);
 
LIB61850_API bool
ClientReport_getBufOvfl(ClientReport self);
 
LIB61850_API bool
ClientReport_hasDataReference(ClientReport self);
 
LIB61850_API const char*
ClientReport_getDataReference(ClientReport self, int elementIndex);
 
 
LIB61850_API uint64_t
ClientReport_getTimestamp(ClientReport self);
 
LIB61850_API bool
ClientReport_hasSubSeqNum(ClientReport self);
 
LIB61850_API uint16_t
ClientReport_getSubSeqNum(ClientReport self);
 
LIB61850_API bool
ClientReport_getMoreSeqmentsFollow(ClientReport self);
 
LIB61850_API char*
ReasonForInclusion_getValueAsString(ReasonForInclusion reasonCode);
 
/**************************************************
 * ClientReportControlBlock access class
 **************************************************/
 
LIB61850_API ClientReportControlBlock
ClientReportControlBlock_create(const char* rcbReference);
 
LIB61850_API void
ClientReportControlBlock_destroy(ClientReportControlBlock self);
 
LIB61850_API char*
ClientReportControlBlock_getObjectReference(ClientReportControlBlock self);
 
LIB61850_API bool
ClientReportControlBlock_isBuffered(ClientReportControlBlock self);
 
LIB61850_API const char*
ClientReportControlBlock_getRptId(ClientReportControlBlock self);
 
LIB61850_API void
ClientReportControlBlock_setRptId(ClientReportControlBlock self, const char* rptId);
 
LIB61850_API bool
ClientReportControlBlock_getRptEna(ClientReportControlBlock self);
 
LIB61850_API void
ClientReportControlBlock_setRptEna(ClientReportControlBlock self, bool rptEna);
 
LIB61850_API bool
ClientReportControlBlock_getResv(ClientReportControlBlock self);
 
LIB61850_API void
ClientReportControlBlock_setResv(ClientReportControlBlock self, bool resv);
 
LIB61850_API const char*
ClientReportControlBlock_getDataSetReference(ClientReportControlBlock self);
 
LIB61850_API void
ClientReportControlBlock_setDataSetReference(ClientReportControlBlock self, const char* dataSetReference);
 
LIB61850_API uint32_t
ClientReportControlBlock_getConfRev(ClientReportControlBlock self);
 
LIB61850_API int
ClientReportControlBlock_getOptFlds(ClientReportControlBlock self);
 
LIB61850_API void
ClientReportControlBlock_setOptFlds(ClientReportControlBlock self, int optFlds);
 
LIB61850_API uint32_t
ClientReportControlBlock_getBufTm(ClientReportControlBlock self);
 
LIB61850_API void
ClientReportControlBlock_setBufTm(ClientReportControlBlock self, uint32_t bufTm);
 
LIB61850_API uint16_t
ClientReportControlBlock_getSqNum(ClientReportControlBlock self);
 
LIB61850_API int
ClientReportControlBlock_getTrgOps(ClientReportControlBlock self);
 
LIB61850_API void
ClientReportControlBlock_setTrgOps(ClientReportControlBlock self, int trgOps);
 
LIB61850_API uint32_t
ClientReportControlBlock_getIntgPd(ClientReportControlBlock self);
 
LIB61850_API void
ClientReportControlBlock_setIntgPd(ClientReportControlBlock self, uint32_t intgPd);
 
LIB61850_API bool
ClientReportControlBlock_getGI(ClientReportControlBlock self);
 
LIB61850_API void
ClientReportControlBlock_setGI(ClientReportControlBlock self, bool gi);
 
LIB61850_API bool
ClientReportControlBlock_getPurgeBuf(ClientReportControlBlock self);
 
LIB61850_API void
ClientReportControlBlock_setPurgeBuf(ClientReportControlBlock self, bool purgeBuf);
 
LIB61850_API  bool
ClientReportControlBlock_hasResvTms(ClientReportControlBlock self);
 
LIB61850_API int16_t
ClientReportControlBlock_getResvTms(ClientReportControlBlock self);
 
LIB61850_API void
ClientReportControlBlock_setResvTms(ClientReportControlBlock self, int16_t resvTms);
 
LIB61850_API MmsValue* /* <MMS_OCTET_STRING> */
ClientReportControlBlock_getEntryId(ClientReportControlBlock self);
 
LIB61850_API void
ClientReportControlBlock_setEntryId(ClientReportControlBlock self, MmsValue* entryId);
 
LIB61850_API uint64_t
ClientReportControlBlock_getEntryTime(ClientReportControlBlock self);
 
LIB61850_API MmsValue* /* <MMS_OCTET_STRING> */
ClientReportControlBlock_getOwner(ClientReportControlBlock self);
 
 
/****************************************
 * Data set handling
 ****************************************/
 
LIB61850_API ClientDataSet
IedConnection_readDataSetValues(IedConnection self, IedClientError* error, const char* dataSetReference, ClientDataSet dataSet);
 
typedef void
(*IedConnection_ReadDataSetHandler) (uint32_t invokeId, void* parameter, IedClientError err, ClientDataSet dataSet);
 
LIB61850_API uint32_t
IedConnection_readDataSetValuesAsync(IedConnection self, IedClientError* error, const char* dataSetReference, ClientDataSet dataSet,
        IedConnection_ReadDataSetHandler handler, void* parameter);
 
LIB61850_API void
IedConnection_createDataSet(IedConnection self, IedClientError* error, const char* dataSetReference, LinkedList /* char* */ dataSetElements);
 
LIB61850_API uint32_t
IedConnection_createDataSetAsync(IedConnection self, IedClientError* error, const char* dataSetReference, LinkedList /* char* */ dataSetElements,
        IedConnection_GenericServiceHandler handler, void* parameter);
 
LIB61850_API bool
IedConnection_deleteDataSet(IedConnection self, IedClientError* error, const char* dataSetReference);
 
LIB61850_API uint32_t
IedConnection_deleteDataSetAsync(IedConnection self, IedClientError* error, const char* dataSetReference,
        IedConnection_GenericServiceHandler handler, void* parameter);
 
LIB61850_API LinkedList /* <char*> */
IedConnection_getDataSetDirectory(IedConnection self, IedClientError* error, const char* dataSetReference, bool* isDeletable);
 
typedef void
(*IedConnection_GetDataSetDirectoryHandler) (uint32_t invokeId, void* parameter, IedClientError err, LinkedList /* <char*> */ dataSetDirectory, bool isDeletable);
 
LIB61850_API uint32_t
IedConnection_getDataSetDirectoryAsync(IedConnection self, IedClientError* error, const char* dataSetReference,
        IedConnection_GetDataSetDirectoryHandler handler, void* parameter);
 
LIB61850_API void
IedConnection_writeDataSetValues(IedConnection self, IedClientError* error, const char* dataSetReference,
        LinkedList/*<MmsValue*>*/ values, /* OUTPUT */LinkedList* /* <MmsValue*> */accessResults);
 
typedef void
(*IedConnection_WriteDataSetHandler) (uint32_t invokeId, void* parameter, IedClientError err, LinkedList /* <MmsValue*> */accessResults);
 
LIB61850_API uint32_t
IedConnection_writeDataSetValuesAsync(IedConnection self, IedClientError* error, const char* dataSetReference,
        LinkedList/*<MmsValue*>*/ values, IedConnection_WriteDataSetHandler handler, void* parameter);
 
 
/********************************************************
 * Data set object (local representation of a data set)
 *******************************************************/
 
LIB61850_API void
ClientDataSet_destroy(ClientDataSet self);
 
LIB61850_API MmsValue*
ClientDataSet_getValues(ClientDataSet self);
 
LIB61850_API char*
ClientDataSet_getReference(ClientDataSet self);
 
LIB61850_API int
ClientDataSet_getDataSetSize(ClientDataSet self);
 
/************************************
 *  Control service functions
 ************************************/
 
typedef struct sControlObjectClient* ControlObjectClient;
 
LIB61850_API ControlObjectClient
ControlObjectClient_create(const char* objectReference, IedConnection connection);
 
LIB61850_API ControlObjectClient
ControlObjectClient_createEx(const char* objectReference, IedConnection connection, ControlModel ctlModel, MmsVariableSpecification* controlObjectSpec);
 
LIB61850_API void
ControlObjectClient_destroy(ControlObjectClient self);
 
typedef enum
{
    CONTROL_ACTION_TYPE_SELECT = 0, 
    CONTROL_ACTION_TYPE_OPERATE = 1,  
    CONTROL_ACTION_TYPE_CANCEL = 2 
} ControlActionType;
 
typedef void
(*ControlObjectClient_ControlActionHandler) (uint32_t invokeId, void* parameter, IedClientError err, ControlActionType type, bool success);
 
LIB61850_API const char*
ControlObjectClient_getObjectReference(ControlObjectClient self);
 
LIB61850_API ControlModel
ControlObjectClient_getControlModel(ControlObjectClient self);
 
LIB61850_API void
ControlObjectClient_setControlModel(ControlObjectClient self, ControlModel ctlModel);
 
LIB61850_API void
ControlObjectClient_changeServerControlModel(ControlObjectClient self, ControlModel ctlModel);
 
LIB61850_API MmsType
ControlObjectClient_getCtlValType(ControlObjectClient self);
 
LIB61850_API IedClientError
ControlObjectClient_getLastError(ControlObjectClient self);
 
LIB61850_API bool
ControlObjectClient_operate(ControlObjectClient self, MmsValue* ctlVal, uint64_t operTime);
 
LIB61850_API bool
ControlObjectClient_select(ControlObjectClient self);
 
LIB61850_API bool
ControlObjectClient_selectWithValue(ControlObjectClient self, MmsValue* ctlVal);
 
LIB61850_API bool
ControlObjectClient_cancel(ControlObjectClient self);
 
 
LIB61850_API uint32_t
ControlObjectClient_operateAsync(ControlObjectClient self, IedClientError* err, MmsValue* ctlVal, uint64_t operTime,
        ControlObjectClient_ControlActionHandler handler, void* parameter);
 
LIB61850_API uint32_t
ControlObjectClient_selectAsync(ControlObjectClient self, IedClientError* err, ControlObjectClient_ControlActionHandler handler, void* parameter);
 
LIB61850_API uint32_t
ControlObjectClient_selectWithValueAsync(ControlObjectClient self, IedClientError* err, MmsValue* ctlVal,
        ControlObjectClient_ControlActionHandler handler, void* parameter);
 
LIB61850_API uint32_t
ControlObjectClient_cancelAsync(ControlObjectClient self, IedClientError* err, ControlObjectClient_ControlActionHandler handler, void* parameter);
 
LIB61850_API LastApplError
ControlObjectClient_getLastApplError(ControlObjectClient self);
 
LIB61850_API void
ControlObjectClient_setTestMode(ControlObjectClient self, bool value);
 
LIB61850_API void
ControlObjectClient_setOrigin(ControlObjectClient self, const char* orIdent, int orCat);
 
LIB61850_API void
ControlObjectClient_useConstantT(ControlObjectClient self, bool useConstantT);
 
LIB61850_API DEPRECATED void
ControlObjectClient_enableInterlockCheck(ControlObjectClient self);
 
LIB61850_API DEPRECATED void
ControlObjectClient_enableSynchroCheck(ControlObjectClient self);
 
LIB61850_API DEPRECATED void
ControlObjectClient_setCtlNum(ControlObjectClient self, uint8_t ctlNum);
 
LIB61850_API void
ControlObjectClient_setInterlockCheck(ControlObjectClient self, bool value);
 
LIB61850_API void
ControlObjectClient_setSynchroCheck(ControlObjectClient self, bool value);
 
 
typedef void (*CommandTerminationHandler) (void* parameter, ControlObjectClient controlClient);
 
LIB61850_API void
ControlObjectClient_setCommandTerminationHandler(ControlObjectClient self, CommandTerminationHandler handler,
        void* handlerParameter);
 
/*************************************
 * Model discovery services
 ************************************/
 
LIB61850_API void
IedConnection_getDeviceModelFromServer(IedConnection self, IedClientError* error);
 
LIB61850_API LinkedList /*<char*>*/
IedConnection_getLogicalDeviceList(IedConnection self, IedClientError* error);
 
LIB61850_API LinkedList /*<char*>*/
IedConnection_getServerDirectory(IedConnection self, IedClientError* error, bool getFileNames);
 
LIB61850_API LinkedList /*<char*>*/
IedConnection_getLogicalDeviceDirectory(IedConnection self, IedClientError* error, const char* logicalDeviceName);
 
typedef enum {
    ACSI_CLASS_DATA_OBJECT,
    ACSI_CLASS_DATA_SET,
    ACSI_CLASS_BRCB,
    ACSI_CLASS_URCB,
    ACSI_CLASS_LCB,
    ACSI_CLASS_LOG,
    ACSI_CLASS_SGCB,
    ACSI_CLASS_GoCB,
    ACSI_CLASS_GsCB,
    ACSI_CLASS_MSVCB,
    ACSI_CLASS_USVCB
} ACSIClass;
 
LIB61850_API LinkedList /*<char*>*/
IedConnection_getLogicalNodeVariables(IedConnection self, IedClientError* error,
                const char* logicalNodeReference);
 
LIB61850_API LinkedList /*<char*>*/
IedConnection_getLogicalNodeDirectory(IedConnection self, IedClientError* error,
                const char* logicalNodeReference, ACSIClass acsiClass);
 
LIB61850_API LinkedList /*<char*>*/
IedConnection_getDataDirectory(IedConnection self, IedClientError* error, const char* dataReference);
 
LIB61850_API LinkedList /*<char*>*/
IedConnection_getDataDirectoryFC(IedConnection self, IedClientError* error, const char* dataReference);
 
LIB61850_API LinkedList
IedConnection_getDataDirectoryByFC(IedConnection self, IedClientError* error, const char* dataReference, FunctionalConstraint fc);
 
LIB61850_API MmsVariableSpecification*
IedConnection_getVariableSpecification(IedConnection self, IedClientError* error, const char* dataAttributeReference,
        FunctionalConstraint fc);
 
LIB61850_API LinkedList
IedConnection_getLogicalDeviceVariables(IedConnection self, IedClientError* error, const char* ldName);
 
LIB61850_API LinkedList
IedConnection_getLogicalDeviceDataSets(IedConnection self, IedClientError* error, const char* ldName);
 
/*****************************************
 * Asynchronous model discovery functions
 *****************************************/
 
typedef void
(*IedConnection_GetNameListHandler) (uint32_t invokeId, void* parameter, IedClientError err, LinkedList nameList, bool moreFollows);
 
LIB61850_API uint32_t
IedConnection_getServerDirectoryAsync(IedConnection self, IedClientError* error, const char* continueAfter, LinkedList result,
        IedConnection_GetNameListHandler handler, void* parameter);
 
LIB61850_API uint32_t
IedConnection_getLogicalDeviceVariablesAsync(IedConnection self, IedClientError* error, const char* ldName, const char* continueAfter, LinkedList result,
        IedConnection_GetNameListHandler handler, void* parameter);
 
LIB61850_API uint32_t
IedConnection_getLogicalDeviceDataSetsAsync(IedConnection self, IedClientError* error, const char* ldName, const char* continueAfter, LinkedList result,
        IedConnection_GetNameListHandler handler, void* parameter);
 
 
typedef void
(*IedConnection_GetVariableSpecificationHandler) (uint32_t invokeId, void* parameter, IedClientError err, MmsVariableSpecification* spec);
 
LIB61850_API uint32_t
IedConnection_getVariableSpecificationAsync(IedConnection self, IedClientError* error, const char* dataAttributeReference,
        FunctionalConstraint fc, IedConnection_GetVariableSpecificationHandler handler, void* parameter);
 
LIB61850_API LinkedList /* <MmsJournalEntry> */
IedConnection_queryLogByTime(IedConnection self, IedClientError* error, const char* logReference,
        uint64_t startTime, uint64_t endTime, bool* moreFollows);
 
LIB61850_API LinkedList /* <MmsJournalEntry> */
IedConnection_queryLogAfter(IedConnection self, IedClientError* error, const char* logReference,
        MmsValue* entryID, uint64_t timeStamp, bool* moreFollows);
 
 
typedef void
(*IedConnection_QueryLogHandler) (uint32_t invokeId, void* parameter, IedClientError mmsError, LinkedList /* <MmsJournalEntry> */ journalEntries, bool moreFollows);
 
LIB61850_API uint32_t
IedConnection_queryLogByTimeAsync(IedConnection self, IedClientError* error, const char* logReference,
        uint64_t startTime, uint64_t endTime, IedConnection_QueryLogHandler handler, void* parameter);
 
LIB61850_API uint32_t
IedConnection_queryLogAfterAsync(IedConnection self, IedClientError* error, const char* logReference,
        MmsValue* entryID, uint64_t timeStamp, IedConnection_QueryLogHandler handler, void* parameter);
 
typedef struct sFileDirectoryEntry* FileDirectoryEntry;
 
LIB61850_API FileDirectoryEntry
FileDirectoryEntry_create(const char* fileName, uint32_t fileSize, uint64_t lastModified);
 
LIB61850_API void
FileDirectoryEntry_destroy(FileDirectoryEntry self);
 
LIB61850_API const char*
FileDirectoryEntry_getFileName(FileDirectoryEntry self);
 
LIB61850_API uint32_t
FileDirectoryEntry_getFileSize(FileDirectoryEntry self);
 
LIB61850_API uint64_t
FileDirectoryEntry_getLastModified(FileDirectoryEntry self);
 
 
LIB61850_API LinkedList /*<FileDirectoryEntry>*/
IedConnection_getFileDirectory(IedConnection self, IedClientError* error, const char* directoryName);
 
 
LIB61850_API LinkedList /*<FileDirectoryEntry>*/
IedConnection_getFileDirectoryEx(IedConnection self, IedClientError* error, const char* directoryName, const char* continueAfter,
        bool* moreFollows);
 
typedef bool
(*IedConnection_FileDirectoryEntryHandler) (uint32_t invokeId, void* parameter, IedClientError err, char* filename, uint32_t size, uint64_t lastModfified,
        bool moreFollows);
 
LIB61850_API uint32_t
IedConnection_getFileDirectoryAsyncEx(IedConnection self, IedClientError* error, const char* directoryName, const char* continueAfter,
        IedConnection_FileDirectoryEntryHandler handler, void* parameter);
 
typedef bool
(*IedClientGetFileHandler) (void* parameter, uint8_t* buffer, uint32_t bytesRead);
 
LIB61850_API uint32_t
IedConnection_getFile(IedConnection self, IedClientError* error, const char* fileName, IedClientGetFileHandler handler,
        void* handlerParameter);
 
 
typedef bool
(*IedConnection_GetFileAsyncHandler) (uint32_t invokeId, void* parameter, IedClientError err, uint32_t originalInvokeId,
        uint8_t* buffer, uint32_t bytesRead, bool moreFollows);
 
 
LIB61850_API uint32_t
IedConnection_getFileAsync(IedConnection self, IedClientError* error, const char* fileName, IedConnection_GetFileAsyncHandler handler,
        void* parameter);
 
LIB61850_API void
IedConnection_setFilestoreBasepath(IedConnection, const char* basepath);
 
LIB61850_API void
IedConnection_setFile(IedConnection self, IedClientError* error, const char* sourceFilename, const char* destinationFilename);
 
LIB61850_API uint32_t
IedConnection_setFileAsync(IedConnection self, IedClientError* error, const char* sourceFilename, const char* destinationFilename,
        IedConnection_GenericServiceHandler handler, void* parameter);
 
LIB61850_API void
IedConnection_deleteFile(IedConnection self, IedClientError* error, const char* fileName);
 
LIB61850_API uint32_t
IedConnection_deleteFileAsync(IedConnection self, IedClientError* error, const char* fileName,
        IedConnection_GenericServiceHandler handler, void* parameter);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* IEC61850_CLIENT_H_ */