tase2_client.h

Go to the documentation of this file.

/*
 *  tase2_client.h
 *
 *  This file is part of libtase2
 *
 *  Copyright 2017-2019 MZ Automation GmbH
 *
 *  All rights reserved.
 */
 
#ifndef SRC_TASE2_CLIENT_TASE2_CLIENT_H_
#define SRC_TASE2_CLIENT_TASE2_CLIENT_H_
 
#include "tase2_common.h"
#include "tase2_endpoint.h"
#include "tls_config.h"
#include "linked_list.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct {
    int32_t major;
    int32_t minor;
} Tase2_Version;
 
typedef struct sTase2_ClientDSTransferSet* Tase2_ClientDSTransferSet;
 
typedef enum
{
    TASE2_CLIENT_STATE_IDLE,
    TASE2_CLIENT_STATE_CONNECTED,
    TASE2_CLIENT_STATE_CLOSED
} Tase2_ClientState;
 
typedef struct sTase2_ClientDataSet* Tase2_ClientDataSet;
 
typedef void
(*Tase2_DSTransferSetValueHandler) (void* parameter, Tase2_ClientDSTransferSet transferSet, const char* domainName, const char* pointName, Tase2_PointValue pointValue);
 
typedef void
(*Tase2_DSTransferSetReportHandler) (void* parameter, bool finished, uint32_t seq, Tase2_ClientDSTransferSet transferSet);
 
typedef void
(*Tase2_InformationMessageHandler) (void* parameter, int32_t infoRef, int32_t localRef, int32_t msgId, int32_t size, uint8_t* messageBuffer);
 
 
typedef void
(*Tase2_ConnectionClosedHandler) (void* parameter, Tase2_Client connection);
 
typedef void
(*Tase2_Client_StateChangedHandler) (void* parameter, Tase2_Client client, Tase2_ClientState newState);
 
 
TASE2_API Tase2_ClientDataSet
Tase2_Client_getDataSet(Tase2_Client self, Tase2_ClientError* err, const char* domainName, const char* dataSetName);
 
TASE2_API bool
Tase2_Client_createDataSet(Tase2_Client self, Tase2_ClientError* err,
        const char* domainName, const char* dataSetName,
        LinkedList /* <char*> */dataSetElements);
 
TASE2_API bool
Tase2_Client_deleteDataSet(Tase2_Client self, Tase2_ClientError* err, const char* domainName, const char* dataSetName);
 
TASE2_API const char*
Tase2_ClientDataSet_getDomainName(Tase2_ClientDataSet self);
 
TASE2_API const char*
Tase2_ClientDataSet_getDataSetName(Tase2_ClientDataSet self);
 
TASE2_API bool
Tase2_ClientDataSet_isDeletable(Tase2_ClientDataSet self);
 
TASE2_API int
Tase2_ClientDataSet_getSize(Tase2_ClientDataSet self);
 
TASE2_API Tase2_PointName
Tase2_ClientDataSet_getPointName(Tase2_ClientDataSet self, int index);
 
TASE2_API const char*
Tase2_ClientDataSet_getPointDomainName(Tase2_ClientDataSet self, int index);
 
TASE2_API const char*
Tase2_ClientDataSet_getPointVariableName(Tase2_ClientDataSet self, int index);
 
 
TASE2_API Tase2_PointValue
Tase2_ClientDataSet_getPointValue(Tase2_ClientDataSet self, int index);
 
TASE2_API Tase2_ClientError
Tase2_ClientDataSet_read(Tase2_ClientDataSet self, Tase2_Client client);
 
TASE2_API void
Tase2_ClientDataSet_destroy(Tase2_ClientDataSet self);
 
TASE2_API Tase2_ClientDSTransferSet
Tase2_Client_getNextDSTransferSet(Tase2_Client self, const char* domainName, Tase2_ClientError* err);
 
TASE2_API Tase2_ClientError
Tase2_ClientDSTransferSet_readValues(Tase2_ClientDSTransferSet self, Tase2_Client client);
 
TASE2_API Tase2_ClientError
Tase2_ClientDSTransferSet_writeValues(Tase2_ClientDSTransferSet self, Tase2_Client client);
 
TASE2_API const char*
Tase2_ClientDSTransferSet_getDomain(Tase2_ClientDSTransferSet self);
 
TASE2_API const char*
Tase2_ClientDSTransferSet_getName(Tase2_ClientDSTransferSet self);
 
TASE2_API const char*
Tase2_ClientDSTransferSet_getDataSetDomain(Tase2_ClientDSTransferSet self);
 
TASE2_API const char*
Tase2_ClientDSTransferSet_getDataSetName(Tase2_ClientDSTransferSet self);
 
TASE2_API Tase2_ClientDataSet
Tase2_ClientDSTransferSet_getDataSet(Tase2_ClientDSTransferSet self);
 
TASE2_API int32_t
Tase2_ClientDSTransferSet_getStartTime(Tase2_ClientDSTransferSet self);
 
TASE2_API int32_t
Tase2_ClientDSTransferSet_getInterval(Tase2_ClientDSTransferSet self);
 
TASE2_API int32_t
Tase2_ClientDSTransferSet_getTLE(Tase2_ClientDSTransferSet self);
 
TASE2_API int32_t
Tase2_ClientDSTransferSet_getBufferTime(Tase2_ClientDSTransferSet self);
 
TASE2_API int32_t
Tase2_ClientDSTransferSet_getIntegrityCheck(Tase2_ClientDSTransferSet self);
 
TASE2_API int
Tase2_ClientDSTransferSet_getDSConditionsRequested(Tase2_ClientDSTransferSet self);
 
TASE2_API bool
Tase2_ClientDSTransferSet_getBlockData(Tase2_ClientDSTransferSet self);
 
TASE2_API bool
Tase2_ClientDSTransferSet_getCritical(Tase2_ClientDSTransferSet self);
 
TASE2_API bool
Tase2_ClientDSTransferSet_getRBE(Tase2_ClientDSTransferSet self);
 
TASE2_API bool
Tase2_ClientDSTransferSet_getAllChangesReported(Tase2_ClientDSTransferSet self);
 
TASE2_API bool
Tase2_ClientDSTransferSet_getStatus(Tase2_ClientDSTransferSet self);
 
TASE2_API int16_t
Tase2_ClientDSTransferSet_getEventCodeRequested(Tase2_ClientDSTransferSet self);
 
TASE2_API void
Tase2_ClientDSTransferSet_setDataSetName(Tase2_ClientDSTransferSet self, const char* domainId, const char* dataSetId);
 
TASE2_API void
Tase2_ClientDSTransferSet_setDataSet(Tase2_ClientDSTransferSet self, Tase2_ClientDataSet dataSet);
 
TASE2_API void
Tase2_ClientDSTransferSet_setStartTime(Tase2_ClientDSTransferSet self, int32_t startTime);
 
TASE2_API void
Tase2_ClientDSTransferSet_setInterval(Tase2_ClientDSTransferSet self, int32_t interval);
 
TASE2_API void
Tase2_ClientDSTransferSet_setTLE(Tase2_ClientDSTransferSet self, int32_t tle);
 
TASE2_API void
Tase2_ClientDSTransferSet_setBufferTime(Tase2_ClientDSTransferSet self, int32_t bufferTime);
 
TASE2_API void
Tase2_ClientDSTransferSet_setIntegrityCheck(Tase2_ClientDSTransferSet self, int32_t integrityCheck);
 
TASE2_API void
Tase2_ClientDSTransferSet_setDSConditionsRequested(Tase2_ClientDSTransferSet self, int dsConditionsRequested);
 
TASE2_API void
Tase2_ClientDSTransferSet_setBlockData(Tase2_ClientDSTransferSet self, bool blockData);
 
TASE2_API void
Tase2_ClientDSTransferSet_setCritical(Tase2_ClientDSTransferSet self, bool critical);
 
TASE2_API void
Tase2_ClientDSTransferSet_setRBE(Tase2_ClientDSTransferSet self, bool rbe);
 
TASE2_API void
Tase2_ClientDSTransferSet_setAllChangesReported(Tase2_ClientDSTransferSet self, bool allChangesReported);
 
TASE2_API void
Tase2_ClientDSTransferSet_setStatus(Tase2_ClientDSTransferSet self, bool status);
 
TASE2_API Tase2_ClientError
Tase2_ClientDSTransferSet_writeDataSetName(Tase2_ClientDSTransferSet self, Tase2_Client client, const char* domainId, const char* dataSetId);
 
TASE2_API Tase2_ClientError
Tase2_ClientDSTransferSet_writeStartTime(Tase2_ClientDSTransferSet self, Tase2_Client client, int32_t startTime);
 
TASE2_API Tase2_ClientError
Tase2_ClientDSTransferSet_writeInterval(Tase2_ClientDSTransferSet self, Tase2_Client client, int32_t interval);
 
TASE2_API Tase2_ClientError
Tase2_ClientDSTransferSet_writeTLE(Tase2_ClientDSTransferSet self, Tase2_Client client, int32_t tle);
 
TASE2_API Tase2_ClientError
Tase2_ClientDSTransferSet_writeBufferTime(Tase2_ClientDSTransferSet self, Tase2_Client client, int32_t bufferTime);
 
TASE2_API Tase2_ClientError
Tase2_ClientDSTransferSet_writeIntegrityCheck(Tase2_ClientDSTransferSet self, Tase2_Client client, int32_t integrityCheck);
 
TASE2_API Tase2_ClientError
Tase2_ClientDSTransferSet_writeDSConditionsRequested(Tase2_ClientDSTransferSet self, Tase2_Client client, int dsConditionsRequested);
 
TASE2_API Tase2_ClientError
Tase2_ClientDSTransferSet_writeBlockData(Tase2_ClientDSTransferSet self, Tase2_Client client, bool blockData);
 
TASE2_API Tase2_ClientError
Tase2_ClientDSTransferSet_writeCritical(Tase2_ClientDSTransferSet self, Tase2_Client client, bool critical);
 
TASE2_API Tase2_ClientError
Tase2_ClientDSTransferSet_writeRBE(Tase2_ClientDSTransferSet self, Tase2_Client client, bool rbe);
 
TASE2_API Tase2_ClientError
Tase2_ClientDSTransferSet_writeAllChangesReported(Tase2_ClientDSTransferSet self, Tase2_Client client, bool allChangesReported);
 
TASE2_API Tase2_ClientError
Tase2_ClientDSTransferSet_writeStatus(Tase2_ClientDSTransferSet self, Tase2_Client client, bool status);
 
TASE2_API uint8_t
Tase2_ClientDSTransferSet_getDSConditionsDetected(Tase2_ClientDSTransferSet self);
 
TASE2_API int16_t
Tase2_ClientDSTransferSet_getEventCodeDetected(Tase2_ClientDSTransferSet self);
 
TASE2_API int32_t
Tase2_ClientDSTransferSet_getTransferSetTimestamp(Tase2_ClientDSTransferSet self);
 
TASE2_API void
Tase2_ClientDSTransferSet_destroy(Tase2_ClientDSTransferSet self);
 
TASE2_API Tase2_Client
Tase2_Client_create(TLSConfiguration tlsConfig);
 
TASE2_API Tase2_Client
Tase2_Client_createEx(Tase2_Endpoint endpoint);
 
TASE2_API Tase2_Endpoint
Tase2_Client_getEndpoint(Tase2_Client self);
 
TASE2_API void
Tase2_Client_destroy(Tase2_Client self);
 
TASE2_API Tase2_Statistics
Tase2_Client_getStatistics(Tase2_Client self);
 
TASE2_API void
Tase2_Client_setIdentity(Tase2_Client self, const char* vendor, const char* model, const char* revision);
 
TASE2_API void
Tase2_Client_installDSTransferSetValueHandler(Tase2_Client self, Tase2_DSTransferSetValueHandler handler, void* parameter);
 
TASE2_API void
Tase2_Client_installDSTransferSetReportHandler(Tase2_Client self, Tase2_DSTransferSetReportHandler handler, void* parameter);
 
TASE2_API void
Tase2_Client_installConnectionClosedHandler(Tase2_Client self, Tase2_ConnectionClosedHandler handler, void* parameter);
 
TASE2_API void
Tase2_Client_installStateChangedHandler(Tase2_Client self, Tase2_Client_StateChangedHandler handler, void* parameter);
 
TASE2_API void
Tase2_Client_setTcpPort(Tase2_Client self, int tcpPort);
 
TASE2_API void
Tase2_Client_setRemoteApplicationAddress(Tase2_Client self, Tase2_ApplicationAddress remoteAddress);
 
TASE2_API void
Tase2_Client_setRemoteApTitle(Tase2_Client self, const char* apTitle, int aeQualifier);
 
TASE2_API void
Tase2_Client_setRemoteAddresses(Tase2_Client self, Tase2_PSelector pSelector, Tase2_SSelector sSelector, Tase2_TSelector tSelector);
 
TASE2_API void
Tase2_Client_setRemoteApInvocationId(Tase2_Client self, int apInvocationId);
 
TASE2_API void
Tase2_Client_setRemoteAeInvocationId(Tase2_Client self, int aeInvocationId);
 
TASE2_API void
Tase2_Client_setLocalApTitle(Tase2_Client self, const char* apTitle, int aeQualifier);
 
TASE2_API void
Tase2_Client_setLocalAddresses(Tase2_Client self, Tase2_PSelector pSelector, Tase2_SSelector sSelector, Tase2_TSelector tSelector);
 
TASE2_API void
Tase2_Client_setLocalApInvocationId(Tase2_Client self, int apInvocationId);
 
TASE2_API void
Tase2_Client_setLocalAeInvocationId(Tase2_Client self, int aeInvocationId);
 
TASE2_API void
Tase2_Client_setMaxOutstandingCalls(Tase2_Client self, int calling, int called);
 
TASE2_API Tase2_ClientError
Tase2_Client_connect(Tase2_Client self, const char* hostname, const char* apTitle, int aeQualifier);
 
TASE2_API Tase2_ClientError
Tase2_Client_connectEx(Tase2_Client self);
 
TASE2_API void
Tase2_Client_disconnect(Tase2_Client self);
 
TASE2_API Tase2_ClientState
Tase2_Client_getState(Tase2_Client self);
 
TASE2_API char*
Tase2_Client_getBilateralTableId(Tase2_Client self, Tase2_ClientError* err, const char* domainName);
 
TASE2_API Tase2_Version
Tase2_Client_getServerVersion(Tase2_Client self);
 
TASE2_API int
Tase2_Client_getServerVersionMajor(Tase2_Client self);
 
TASE2_API int
Tase2_Client_getServerVersionMinor(Tase2_Client self);
 
TASE2_API int
Tase2_Client_getSupportedFeatures(Tase2_Client self);
 
TASE2_API void
Tase2_Client_readPeerIdentity(Tase2_Client self, Tase2_ClientError* err, char** vendor, char** model, char** revision);
 
/***************************************************************
 * Functions for server data model discovery
 ***************************************************************/
 
TASE2_API LinkedList /* <char*> */
Tase2_Client_getVCCVariables(Tase2_Client self, Tase2_ClientError* err);
 
TASE2_API LinkedList /* <char*> */
Tase2_Client_getVCCDataSets(Tase2_Client self, Tase2_ClientError* err);
 
TASE2_API LinkedList /* <char*> */
Tase2_Client_getDomainNames(Tase2_Client self, Tase2_ClientError* err);
 
TASE2_API LinkedList /* <char*> */
Tase2_Client_getDomainVariables(Tase2_Client self, const char* domainName, Tase2_ClientError* err);
 
TASE2_API LinkedList /* <char*> */
Tase2_Client_getDomainDataSets(Tase2_Client self, const char* domainName, Tase2_ClientError* err);
 
 
typedef struct
{
    const char* domainId;
 
    const char* itemId;
 
    int32_t arrayIndex;
 
    const char* componentName;
}* Tase2_DataSetEntrySpec;
 
TASE2_API const char*
Tase2_DataSetEntrySpec_getDomainId(Tase2_DataSetEntrySpec self);
 
TASE2_API const char*
Tase2_DataSetEntrySpec_getItemId(Tase2_DataSetEntrySpec self);
 
TASE2_API void
Tase2_DataSetEntrySpec_destroy(Tase2_DataSetEntrySpec self);
 
TASE2_API LinkedList /* <Tase2_DataSetEntrySpec> */
Tase2_Client_getDataSetDirectory(Tase2_Client self, const char* domainName, const char* dataSetName, Tase2_ClientError* err);
 
 
 
/***************************************************************
 * Functions for control point handling
 ***************************************************************/
 
 
TASE2_API int
Tase2_Client_selectDevice(Tase2_Client self, Tase2_ClientError* err, const char* domainName, const char* deviceName);
 
TASE2_API bool
Tase2_Client_setTag(Tase2_Client self, Tase2_ClientError* err, const char* domainName, const char* deviceName, Tase2_TagValue tagValue, const char* reason);
 
TASE2_API Tase2_TagValue
Tase2_Client_getTag(Tase2_Client self, Tase2_ClientError* err, const char* domainName, const char* deviceName, bool* isArmed, char* reasonBuf, int reasonBufSize);
 
TASE2_API bool
Tase2_Client_sendCommand(Tase2_Client self, Tase2_ClientError* err, const char* domainName, const char* deviceName, int16_t commandValue);
 
TASE2_API bool
Tase2_Client_sendDiscreteSetPoint(Tase2_Client self, Tase2_ClientError* err, const char* domainName, const char* deviceName, int16_t setPointValue);
 
TASE2_API bool
Tase2_Client_sendRealSetPoint(Tase2_Client self, Tase2_ClientError* err, const char* domainName, const char* deviceName, float setPointValue);
 
 
/******************************************************************
 * Functions for protection events and indication point handling
 ******************************************************************/
 
TASE2_API Tase2_PointValue
Tase2_Client_readPointValue(Tase2_Client self, Tase2_ClientError* err, const char* domainName, const char* pointName);
 
TASE2_API LinkedList /* <Tase2_PointValue> */
Tase2_Client_readMultiplePointValues(Tase2_Client self, Tase2_ClientError* err, const char* domainName, LinkedList pointNames);
 
TASE2_API void
Tase2_Client_writePointValue(Tase2_Client self, Tase2_ClientError* err, const char* domainName, const char* pointName, Tase2_PointValue value);
 
/******************************************************************
 * Functions for information message transfer set handling
 ******************************************************************/
 
 
TASE2_API void
Tase2_Client_IMTransferSetEnable(Tase2_Client self, Tase2_ClientError* err);
 
TASE2_API void
Tase2_Client_IMTransferSetDisable(Tase2_Client self, Tase2_ClientError* err);
 
TASE2_API void
Tase2_Client_installIMTransferSetHandler(Tase2_Client self, Tase2_InformationMessageHandler handler, void* parameter);
 
TASE2_API void
Tase2_FreeMemory(void* ptr);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SRC_TASE2_CLIENT_TASE2_CLIENT_H_ */