Data Structures
struct	Tase2_Version

struct	Tase2_DataSetEntrySpec
	A data set entry specification. More...

Typedefs
typedef struct sTase2_ClientDSTransferSet *	Tase2_ClientDSTransferSet
	Client side representation of a DS transfer set.

typedef struct sTase2_ClientDataSet *	Tase2_ClientDataSet
	Client side representation of a data set.

typedef void(*	Tase2_DSTransferSetValueHandler) (void parameter, Tase2_ClientDSTransferSet transferSet, const char domainName, const char *pointName, Tase2_PointValue pointValue)
	Callback handler that is called for each data point contained in a received DS transfer set.

typedef void(*	Tase2_DSTransferSetReportHandler) (void *parameter, bool finished, uint32_t seq, Tase2_ClientDSTransferSet transferSet)
	Callback handler that is called whenever a DS transfer set is received.

typedef void(*	Tase2_InformationMessageHandler) (void parameter, int32_t infoRef, int32_t localRef, int32_t msgId, int32_t size, uint8_t messageBuffer)
	Callback handler for information messages (IM transfer set)

typedef void(*	Tase2_ConnectionClosedHandler) (void *parameter, Tase2_Client connection)
	Callback handler that is called when the server closes the connection.

typedef void(*	Tase2_Client_StateChangedHandler) (void *parameter, Tase2_Client client, Tase2_ClientState newState)
	Callback handler that is called whenever the client state changes.

Enumerations
enum	Tase2_ClientState { TASE2_CLIENT_STATE_IDLE , TASE2_CLIENT_STATE_CONNECTED , TASE2_CLIENT_STATE_CLOSED }

Functions
TASE2_API Tase2_ClientDataSet	Tase2_Client_getDataSet (Tase2_Client self, Tase2_ClientError err, const char domainName, const char *dataSetName)
	Read the data set directory from the server and create a new Tase2_ClientDataSet instance.

TASE2_API bool	Tase2_Client_createDataSet (Tase2_Client self, Tase2_ClientError err, const char domainName, const char *dataSetName, LinkedList dataSetElements)
	Request the server to create a new data set.

TASE2_API bool	Tase2_Client_deleteDataSet (Tase2_Client self, Tase2_ClientError err, const char domainName, const char *dataSetName)
	Delete a data set.

TASE2_API const char *	Tase2_ClientDataSet_getDomainName (Tase2_ClientDataSet self)
	Get the domain name of the data set.

TASE2_API const char *	Tase2_ClientDataSet_getDataSetName (Tase2_ClientDataSet self)
	Get the name of the data set.

TASE2_API bool	Tase2_ClientDataSet_isDeletable (Tase2_ClientDataSet self)
	Check if the data set can be deleted by the client.

TASE2_API int	Tase2_ClientDataSet_getSize (Tase2_ClientDataSet self)
	Get the size (number of entries) of the data set.

TASE2_API Tase2_PointName	Tase2_ClientDataSet_getPointName (Tase2_ClientDataSet self, int index)
	Get the Tase2_PointName of the data set entry at the given index.

TASE2_API const char *	Tase2_ClientDataSet_getPointDomainName (Tase2_ClientDataSet self, int index)
	Get the domain name of the data set entry at the given index.

TASE2_API const char *	Tase2_ClientDataSet_getPointVariableName (Tase2_ClientDataSet self, int index)
	Get the variable name of the data set entry at the given index.

TASE2_API Tase2_PointValue	Tase2_ClientDataSet_getPointValue (Tase2_ClientDataSet self, int index)
	Return a copy of the point value for the data set entry with the given index.

TASE2_API Tase2_ClientError	Tase2_ClientDataSet_read (Tase2_ClientDataSet self, Tase2_Client client)
	read the data set values from the server

TASE2_API void	Tase2_ClientDataSet_destroy (Tase2_ClientDataSet self)
	Destroy the client data set instance and release all resources.

TASE2_API Tase2_ClientDSTransferSet	Tase2_Client_getNextDSTransferSet (Tase2_Client self, const char domainName, Tase2_ClientError err)
	Get the next available DS transfer set (GetNextDSTransferSet operation)

TASE2_API Tase2_ClientError	Tase2_ClientDSTransferSet_readValues (Tase2_ClientDSTransferSet self, Tase2_Client client)
	Read the values of the DSTransferSet from the server.

TASE2_API Tase2_ClientError	Tase2_ClientDSTransferSet_writeValues (Tase2_ClientDSTransferSet self, Tase2_Client client)
	Write the buffered values of the DSTransferSet to the server.

TASE2_API const char *	Tase2_ClientDSTransferSet_getDomain (Tase2_ClientDSTransferSet self)
	Get the domain name of the DSTransferSet.

TASE2_API const char *	Tase2_ClientDSTransferSet_getName (Tase2_ClientDSTransferSet self)
	Get the name of the DSTransferSet.

TASE2_API const char *	Tase2_ClientDSTransferSet_getDataSetDomain (Tase2_ClientDSTransferSet self)
	Get the domain name of the data set.

TASE2_API const char *	Tase2_ClientDSTransferSet_getDataSetName (Tase2_ClientDSTransferSet self)
	Get the name of the data set.

TASE2_API Tase2_ClientDataSet	Tase2_ClientDSTransferSet_getDataSet (Tase2_ClientDSTransferSet self)
	Get Tase2_ClientDataSet instance of the transfer set data set.

TASE2_API int32_t	Tase2_ClientDSTransferSet_getStartTime (Tase2_ClientDSTransferSet self)
	Get the start time of report transmission.

TASE2_API int32_t	Tase2_ClientDSTransferSet_getInterval (Tase2_ClientDSTransferSet self)
	Get the transmission interval of the report.

TASE2_API int32_t	Tase2_ClientDSTransferSet_getTLE (Tase2_ClientDSTransferSet self)
	Get the TLE (Time Limit for Execution) value.

TASE2_API int32_t	Tase2_ClientDSTransferSet_getBufferTime (Tase2_ClientDSTransferSet self)
	Get the buffer time value.

TASE2_API int32_t	Tase2_ClientDSTransferSet_getIntegrityCheck (Tase2_ClientDSTransferSet self)
	Get the integrity check interval time.

TASE2_API int	Tase2_ClientDSTransferSet_getDSConditionsRequested (Tase2_ClientDSTransferSet self)
	Get the DSConditions to trigger a report transmission.

TASE2_API bool	Tase2_ClientDSTransferSet_getBlockData (Tase2_ClientDSTransferSet self)
	Get the information if blocked data transfer is used.

TASE2_API bool	Tase2_ClientDSTransferSet_getCritical (Tase2_ClientDSTransferSet self)
	Get the value of the critical flag.

TASE2_API bool	Tase2_ClientDSTransferSet_getRBE (Tase2_ClientDSTransferSet self)
	Get the value of the RBE (report by exception) flag.

TASE2_API bool	Tase2_ClientDSTransferSet_getAllChangesReported (Tase2_ClientDSTransferSet self)
	Get the value of the AllChangesReported attribute.

TASE2_API bool	Tase2_ClientDSTransferSet_getStatus (Tase2_ClientDSTransferSet self)
	Get status of the transfer set.

TASE2_API int16_t	Tase2_ClientDSTransferSet_getEventCodeRequested (Tase2_ClientDSTransferSet self)
	Get the external event code that caused the transmission.

TASE2_API void	Tase2_ClientDSTransferSet_setDataSetName (Tase2_ClientDSTransferSet self, const char domainId, const char dataSetId)
	Sets the name of the transfer set data set.

TASE2_API void	Tase2_ClientDSTransferSet_setDataSet (Tase2_ClientDSTransferSet self, Tase2_ClientDataSet dataSet)
	Associate a data set instance with the transfer set.

TASE2_API void	Tase2_ClientDSTransferSet_setStartTime (Tase2_ClientDSTransferSet self, int32_t startTime)
	Sets the start time of transfer set monitoring.

TASE2_API void	Tase2_ClientDSTransferSet_setInterval (Tase2_ClientDSTransferSet self, int32_t interval)
	Sets the interval time for transfer set reports.

TASE2_API void	Tase2_ClientDSTransferSet_setTLE (Tase2_ClientDSTransferSet self, int32_t tle)
	Sets the TLE (Time Limit for Execution) value.

TASE2_API void	Tase2_ClientDSTransferSet_setBufferTime (Tase2_ClientDSTransferSet self, int32_t bufferTime)
	Sets the buffer time (wait time until report is sent)

TASE2_API void	Tase2_ClientDSTransferSet_setIntegrityCheck (Tase2_ClientDSTransferSet self, int32_t integrityCheck)
	Sets the integrity check interval time.

TASE2_API void	Tase2_ClientDSTransferSet_setDSConditionsRequested (Tase2_ClientDSTransferSet self, int dsConditionsRequested)
	Sets the trigger conditions for reports (DS conditions (DS transfer sets))

TASE2_API void	Tase2_ClientDSTransferSet_setBlockData (Tase2_ClientDSTransferSet self, bool blockData)
	Enables/disables block data transfer.

TASE2_API void	Tase2_ClientDSTransferSet_setCritical (Tase2_ClientDSTransferSet self, bool critical)
	Sets the critical flag.

TASE2_API void	Tase2_ClientDSTransferSet_setRBE (Tase2_ClientDSTransferSet self, bool rbe)
	Set the value of the RBE (report by exception) flag.

TASE2_API void	Tase2_ClientDSTransferSet_setAllChangesReported (Tase2_ClientDSTransferSet self, bool allChangesReported)
	Enable/disable transmission of all changes.

TASE2_API void	Tase2_ClientDSTransferSet_setStatus (Tase2_ClientDSTransferSet self, bool status)
	Enable/disable the status of condition monitoring (and report transmission)

TASE2_API Tase2_ClientError	Tase2_ClientDSTransferSet_writeDataSetName (Tase2_ClientDSTransferSet self, Tase2_Client client, const char domainId, const char dataSetId)
	Write the name of the transfer set data set (write immediately to server)

TASE2_API Tase2_ClientError	Tase2_ClientDSTransferSet_writeStartTime (Tase2_ClientDSTransferSet self, Tase2_Client client, int32_t startTime)
	Sets the start time of transfer set monitoring (write immediately to server)

TASE2_API Tase2_ClientError	Tase2_ClientDSTransferSet_writeInterval (Tase2_ClientDSTransferSet self, Tase2_Client client, int32_t interval)
	Sets the interval time for transfer set reports (write immediately to server)

TASE2_API Tase2_ClientError	Tase2_ClientDSTransferSet_writeTLE (Tase2_ClientDSTransferSet self, Tase2_Client client, int32_t tle)
	Sets the TLE (Time Limit for Execution) value (write immediately to server).

TASE2_API Tase2_ClientError	Tase2_ClientDSTransferSet_writeBufferTime (Tase2_ClientDSTransferSet self, Tase2_Client client, int32_t bufferTime)
	Sets the buffer time (wait time until report is sent) (write immediately to server)

TASE2_API Tase2_ClientError	Tase2_ClientDSTransferSet_writeIntegrityCheck (Tase2_ClientDSTransferSet self, Tase2_Client client, int32_t integrityCheck)
	Sets the integrity check interval time (write immediately to server)

TASE2_API Tase2_ClientError	Tase2_ClientDSTransferSet_writeDSConditionsRequested (Tase2_ClientDSTransferSet self, Tase2_Client client, int dsConditionsRequested)
	Sets the trigger conditions for reports (DS conditions (DS transfer sets)) (write immediately to server)

TASE2_API Tase2_ClientError	Tase2_ClientDSTransferSet_writeBlockData (Tase2_ClientDSTransferSet self, Tase2_Client client, bool blockData)
	Enables/disables block data transfer (write immediately to server)

TASE2_API Tase2_ClientError	Tase2_ClientDSTransferSet_writeCritical (Tase2_ClientDSTransferSet self, Tase2_Client client, bool critical)
	Set the value of the critical flag (write immediately to server)

TASE2_API Tase2_ClientError	Tase2_ClientDSTransferSet_writeRBE (Tase2_ClientDSTransferSet self, Tase2_Client client, bool rbe)
	Write the value of the RBE (report by exception) flag (write immediately to server)

TASE2_API Tase2_ClientError	Tase2_ClientDSTransferSet_writeAllChangesReported (Tase2_ClientDSTransferSet self, Tase2_Client client, bool allChangesReported)
	Enable/disable transmission of all changes (write immediately to server)

TASE2_API Tase2_ClientError	Tase2_ClientDSTransferSet_writeStatus (Tase2_ClientDSTransferSet self, Tase2_Client client, bool status)
	Enable/disable the status of condition monitoring and report transmission (write immediately to server)

TASE2_API uint8_t	Tase2_ClientDSTransferSet_getDSConditionsDetected (Tase2_ClientDSTransferSet self)
	Get the DSConditions Detected value from the last received report.

TASE2_API int16_t	Tase2_ClientDSTransferSet_getEventCodeDetected (Tase2_ClientDSTransferSet self)
	Get the event code detected value from the last received report.

TASE2_API int32_t	Tase2_ClientDSTransferSet_getTransferSetTimestamp (Tase2_ClientDSTransferSet self)
	Get the transfer set timestamp value from the last received report.

TASE2_API void	Tase2_ClientDSTransferSet_destroy (Tase2_ClientDSTransferSet self)
	Destroy transfer set.

TASE2_API Tase2_Client	Tase2_Client_create (TLSConfiguration tlsConfig)
	Create a new TASE.2 client instance.

TASE2_API Tase2_Client	Tase2_Client_createEx (Tase2_Endpoint endpoint)
	Create a new Tase2_Client instance using an existing endpoint.

TASE2_API Tase2_Endpoint	Tase2_Client_getEndpoint (Tase2_Client self)
	Get the endpoint instance this client is assigned.

TASE2_API void	Tase2_Client_destroy (Tase2_Client self)
	Destroy the client instance. Releases all resources.

TASE2_API Tase2_Statistics	Tase2_Client_getStatistics (Tase2_Client self)
	Access some statistical information for the client connection.

TASE2_API void	Tase2_Client_setIdentity (Tase2_Client self, const char vendor, const char model, const char *revision)
	Set own identity for the identity service.

TASE2_API void	Tase2_Client_installDSTransferSetValueHandler (Tase2_Client self, Tase2_DSTransferSetValueHandler handler, void *parameter)
	Install the callback handler to get data points from received transfer set reports.

TASE2_API void	Tase2_Client_installDSTransferSetReportHandler (Tase2_Client self, Tase2_DSTransferSetReportHandler handler, void *parameter)
	Install the callback handler for received transfer set reports.

TASE2_API void	Tase2_Client_installConnectionClosedHandler (Tase2_Client self, Tase2_ConnectionClosedHandler handler, void *parameter)
	Install a handler function that will be called when the connection is lost.

TASE2_API void	Tase2_Client_installStateChangedHandler (Tase2_Client self, Tase2_Client_StateChangedHandler handler, void *parameter)
	Install a handler that is called whenever the client state changes (e.g. client gets connected or disconnected)

TASE2_API void	Tase2_Client_setTcpPort (Tase2_Client self, int tcpPort)
	Change default remote TCP port used by this client.

TASE2_API void	Tase2_Client_setRemoteApplicationAddress (Tase2_Client self, Tase2_ApplicationAddress remoteAddress)
	Sets the remote application endpoint addresses.

TASE2_API void	Tase2_Client_setRemoteApTitle (Tase2_Client self, const char *apTitle, int aeQualifier)
	Set application endpoint identifier of remote endpoint (AP-title and AE-qualifier)

TASE2_API void	Tase2_Client_setRemoteAddresses (Tase2_Client self, Tase2_PSelector pSelector, Tase2_SSelector sSelector, Tase2_TSelector tSelector)
	set remote addresses for the lower layers

TASE2_API void	Tase2_Client_setRemoteApInvocationId (Tase2_Client self, int apInvocationId)
	Set remote AP-invocation-ID (for active endpoint)

TASE2_API void	Tase2_Client_setRemoteAeInvocationId (Tase2_Client self, int aeInvocationId)
	Set remote AE-invocation-ID (for active endpoint)

TASE2_API void	Tase2_Client_setLocalApTitle (Tase2_Client self, const char *apTitle, int aeQualifier)
	Set application endpoint identifier of the local endpoint.

TASE2_API void	Tase2_Client_setLocalAddresses (Tase2_Client self, Tase2_PSelector pSelector, Tase2_SSelector sSelector, Tase2_TSelector tSelector)
	set local addresses for the lower layers

TASE2_API void	Tase2_Client_setLocalApInvocationId (Tase2_Client self, int apInvocationId)
	Set local AP-invocation-ID.

TASE2_API void	Tase2_Client_setLocalAeInvocationId (Tase2_Client self, int aeInvocationId)
	Set local AE-invocation-ID.

TASE2_API void	Tase2_Client_setMaxOutstandingCalls (Tase2_Client self, int calling, int called)
	Set the maximum number outstanding calls allowed for this connection.

TASE2_API Tase2_ClientError	Tase2_Client_connect (Tase2_Client self, const char hostname, const char apTitle, int aeQualifier)
	connect to server and collect basic server information

TASE2_API Tase2_ClientError	Tase2_Client_connectEx (Tase2_Client self)
	Connect to server with default settings from endpoint.

TASE2_API void	Tase2_Client_disconnect (Tase2_Client self)
	disconnect from the server

TASE2_API Tase2_ClientState	Tase2_Client_getState (Tase2_Client self)
	Get the connection state of the connection.

TASE2_API char *	Tase2_Client_getBilateralTableId (Tase2_Client self, Tase2_ClientError err, const char domainName)
	return the bilateral table ID associated with a TASE.2 domain

TASE2_API Tase2_Version	Tase2_Client_getServerVersion (Tase2_Client self)
	Get the TASE.2 version reported by the server.

TASE2_API int	Tase2_Client_getServerVersionMajor (Tase2_Client self)
	Get the major version part of the server version.

TASE2_API int	Tase2_Client_getServerVersionMinor (Tase2_Client self)
	Get the minor version part of the server version.

TASE2_API int	Tase2_Client_getSupportedFeatures (Tase2_Client self)
	Get a bit set value representing the support conformance blocks (CB) of the server.

TASE2_API void	Tase2_Client_readPeerIdentity (Tase2_Client self, Tase2_ClientError err, char vendor, char model, char *revision)
	Get the identity of the peer.

TASE2_API LinkedList	Tase2_Client_getVCCVariables (Tase2_Client self, Tase2_ClientError *err)
	Get the list of VCC scope variables.

TASE2_API LinkedList	Tase2_Client_getVCCDataSets (Tase2_Client self, Tase2_ClientError *err)
	Get the list of VCC scope data sets.

TASE2_API LinkedList	Tase2_Client_getDomainNames (Tase2_Client self, Tase2_ClientError *err)
	Get the list of available domains.

TASE2_API LinkedList	Tase2_Client_getDomainVariables (Tase2_Client self, const char domainName, Tase2_ClientError err)
	Get the list of domain scope variables.

TASE2_API LinkedList	Tase2_Client_getDomainDataSets (Tase2_Client self, const char domainName, Tase2_ClientError err)
	Get the list of domain scope data sets.

TASE2_API const char *	Tase2_DataSetEntrySpec_getDomainId (Tase2_DataSetEntrySpec self)
	Get the domain ID of the data set entry.

TASE2_API const char *	Tase2_DataSetEntrySpec_getItemId (Tase2_DataSetEntrySpec self)
	Get the item ID of the data set entry.

TASE2_API void	Tase2_DataSetEntrySpec_destroy (Tase2_DataSetEntrySpec self)
	Delete a data set entry specification.

TASE2_API LinkedList	Tase2_Client_getDataSetDirectory (Tase2_Client self, const char domainName, const char dataSetName, Tase2_ClientError *err)
	Read a data set directory.

TASE2_API int	Tase2_Client_selectDevice (Tase2_Client self, Tase2_ClientError err, const char domainName, const char *deviceName)
	Select a device (command or setpoint) for SBO control mode.

TASE2_API bool	Tase2_Client_setTag (Tase2_Client self, Tase2_ClientError err, const char domainName, const char deviceName, Tase2_TagValue tagValue, const char reason)
	Set tag operation. Set a tag value and a reason message for a device (control point).

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)
	Read the tag.

TASE2_API bool	Tase2_Client_sendCommand (Tase2_Client self, Tase2_ClientError err, const char domainName, const char *deviceName, int16_t commandValue)
	Send a command to a device.

TASE2_API bool	Tase2_Client_sendDiscreteSetPoint (Tase2_Client self, Tase2_ClientError err, const char domainName, const char *deviceName, int16_t setPointValue)
	Send a discrete set point to a device.

TASE2_API bool	Tase2_Client_sendRealSetPoint (Tase2_Client self, Tase2_ClientError err, const char domainName, const char *deviceName, float setPointValue)
	Send a "real" (float) set point to a device.

TASE2_API Tase2_PointValue	Tase2_Client_readPointValue (Tase2_Client self, Tase2_ClientError err, const char domainName, const char *pointName)
	Read a data point (indication point or protection equipment) from the server.

TASE2_API LinkedList	Tase2_Client_readMultiplePointValues (Tase2_Client self, Tase2_ClientError err, const char domainName, LinkedList pointNames)
	Read multiple data points from the server.

TASE2_API void	Tase2_Client_writePointValue (Tase2_Client self, Tase2_ClientError err, const char domainName, const char *pointName, Tase2_PointValue value)
	Write a data point (indication point or protection equipment) value to the server.

TASE2_API void	Tase2_Client_IMTransferSetEnable (Tase2_Client self, Tase2_ClientError *err)
	Enable information message transfer set.

TASE2_API void	Tase2_Client_IMTransferSetDisable (Tase2_Client self, Tase2_ClientError *err)
	Disable information message transfer set.

TASE2_API void	Tase2_Client_installIMTransferSetHandler (Tase2_Client self, Tase2_InformationMessageHandler handler, void *parameter)
	Install callback handler for information messages (IM transfer set)

Detailed Description

Typedef Documentation

◆ Tase2_Client_StateChangedHandler

typedef void(* Tase2_Client_StateChangedHandler) (void *parameter, Tase2_Client client, Tase2_ClientState newState)

Callback handler that is called whenever the client state changes.

Parameters

parameter	a user provided parameter
client	the related client instance
newState	the new state

◆ Tase2_ClientDataSet

typedef struct sTase2_ClientDataSet* Tase2_ClientDataSet

Client side representation of a data set.

◆ Tase2_ClientDSTransferSet

typedef struct sTase2_ClientDSTransferSet* Tase2_ClientDSTransferSet

Client side representation of a DS transfer set.

◆ Tase2_ConnectionClosedHandler

typedef void(* Tase2_ConnectionClosedHandler) (void *parameter, Tase2_Client connection)

Callback handler that is called when the server closes the connection.

Parameters

parameter	a user provided parameter
connection	the related client instance

◆ Tase2_DSTransferSetReportHandler

typedef void(* Tase2_DSTransferSetReportHandler) (void *parameter, bool finished, uint32_t seq, Tase2_ClientDSTransferSet transferSet)

Callback handler that is called whenever a DS transfer set is received.

When used, this callback is called twice for each received DS transfer set report. After the report is received the callback is initially called with the finished flag set to false. Then each data point of the report is reported with a separate call to the Tase2_DSTransferSetValueHandler callback. When all data points have been reported the callback is invoked a second time with the finished flag set to true.

Parameters

parameter	a user provided parameter
finished	false for the first invocation after a report is received, true when all data points are reported.
seq	is a report sequence number that will be increased by one after each report received.
transferSet	the related transfer set object

◆ Tase2_DSTransferSetValueHandler

typedef void(* Tase2_DSTransferSetValueHandler) (void *parameter, Tase2_ClientDSTransferSet transferSet, const char *domainName, const char *pointName, Tase2_PointValue pointValue)

Callback handler that is called for each data point contained in a received DS transfer set.

Parameters

parameter	a user provided parameter
transferSet	the related transfer set object or NULL if the transfer set cannot be identified
domainName	the domain name of the data point
pointName	the variable name of the data point
pointValue	the value of the data point

◆ Tase2_InformationMessageHandler

typedef void(* Tase2_InformationMessageHandler) (void *parameter, int32_t infoRef, int32_t localRef, int32_t msgId, int32_t size, uint8_t *messageBuffer)

Callback handler for information messages (IM transfer set)

Parameters

parameter	a user provided parameter
msgId	the information message instance
size	the size in bytes of the information message
message	buffer where the information message is stored

Enumeration Type Documentation

◆ Tase2_ClientState

enum Tase2_ClientState

Connection state of the IedConnection instance (either idle, connected or closed)

Enumerator
TASE2_CLIENT_STATE_IDLE
TASE2_CLIENT_STATE_CONNECTED
TASE2_CLIENT_STATE_CLOSED

Function Documentation

◆ Tase2_Client_connect()

TASE2_API Tase2_ClientError Tase2_Client_connect	(	Tase2_Client	self,
		const char *	hostname,
		const char *	apTitle,
		int	aeQualifier )

connect to server and collect basic server information

Parameters

self	Tase2_Client instance
hostname	hostname or IP address of the server
apTitle	local (own) AP-title part of the application endpoint identifier
aeQualifier	local (own) AE-qualifier part of the application endpoint identifier

Returns: TASE2_CLIENT_ERROR_OK in case of success, otherwise error specific value

◆ Tase2_Client_connectEx()

TASE2_API Tase2_ClientError Tase2_Client_connectEx ( Tase2_Client self )

Connect to server with default settings from endpoint.

NOTE: if already connected this function will only read the TASE2 version and supported features from the peer server.

Parameters

self	Tase2_Client instance

Returns: TASE2_CLIENT_ERROR_OK in case of success, otherwise error specific value

◆ Tase2_Client_create()

TASE2_API Tase2_Client Tase2_Client_create ( TLSConfiguration tlsConfig )

Create a new TASE.2 client instance.

NOTE: The function will also create a new Tase2_Endpoint instance

Parameters

tlsConfig TLS configuration object or NULL if TLS is not used

Returns: the new TASE.2 client instances

◆ Tase2_Client_createDataSet()

TASE2_API bool Tase2_Client_createDataSet	(	Tase2_Client	self,
		Tase2_ClientError *	err,
		const char *	domainName,
		const char *	dataSetName,
		LinkedList	dataSetElements )

Request the server to create a new data set.

The data set element specifications are string of the format "<domain name>/<data set name>"

For VCC scope variable the domain name part and the '/' character has to be omitted.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self
[out]	err	the error return code
	domainName	domain name of the data set of NULL for a VCC scope data set
	dataSetName	name of the data set
	dataSetElemens	a list (see LinkedList) with the data elements of the new data set

Returns: true if data set has been created successfully, false otherwise

◆ Tase2_Client_createEx()

TASE2_API Tase2_Client Tase2_Client_createEx ( Tase2_Endpoint endpoint )

Create a new Tase2_Client instance using an existing endpoint.

Parameters

endpoint the endpoint instance to be used by the client

Returns: the new TASE.2 client instances

◆ Tase2_Client_deleteDataSet()

TASE2_API bool Tase2_Client_deleteDataSet	(	Tase2_Client	self,
		Tase2_ClientError *	err,
		const char *	domainName,
		const char *	dataSetName )

Delete a data set.

This function requests the server to delete the specified data set.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self
[out]	err	the error return code
	domainName	domain name of the data set or NULL for a VCC scope data set
	dataSetName	name of the data set

Returns: true if data set has been deleted, false otherwise

◆ Tase2_Client_destroy()

TASE2_API void Tase2_Client_destroy ( Tase2_Client self )

Destroy the client instance. Releases all resources.

NOTE: do not use any of the Tase2_Client_ functions for this instance after this call.

Parameters

self	Tase2_Client instance

◆ Tase2_Client_disconnect()

TASE2_API void Tase2_Client_disconnect ( Tase2_Client self )

disconnect from the server

NOTE: This function will call Tase2_Endpoint_disconnect on the underlying endpoint. This means that other clients and servers connected to the endpoint will also be disconnected!

Parameters

self	Tase2_Client instance

◆ Tase2_Client_getBilateralTableId()

TASE2_API char * Tase2_Client_getBilateralTableId	(	Tase2_Client	self,
		Tase2_ClientError *	err,
		const char *	domainName )

return the bilateral table ID associated with a TASE.2 domain

This function has to be called after the Tase2_Client_connect function. When the bilateral table ID does not match with the configured one, the client has to close the connection.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
[out]	err	the error return code
[in]	domainName	the domain name

Returns: the table ID as string. Memory is allocated by the function and has to be released by caller.

◆ Tase2_Client_getDataSet()

TASE2_API Tase2_ClientDataSet Tase2_Client_getDataSet	(	Tase2_Client	self,
		Tase2_ClientError *	err,
		const char *	domainName,
		const char *	dataSetName )

Read the data set directory from the server and create a new Tase2_ClientDataSet instance.

NOTE: A Tase2_ClientDataSet instance will only be created when the data set was read successfully.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self
[out]	err	the error return code
	domainName	domain name of the data set, or NULL for VCC scope data sets
	dataSetName	the name of the data set

Returns: new instance or NULL when the data set directory cannot be read

◆ Tase2_Client_getDataSetDirectory()

TASE2_API LinkedList Tase2_Client_getDataSetDirectory	(	Tase2_Client	self,
		const char *	domainName,
		const char *	dataSetName,
		Tase2_ClientError *	err )

Read a data set directory.

Deprecated: This function is deprecated since 1.1. please use Tase2_Client_getDataSet instead

NOTE: The returned list is in the responsibility of the caller. The data set entries have to be release with the Tase2_DataSetEntrySpec_destroy function. The complete list can be deleted with the LinkedList_destroyDeep function with Tase2_DataSetEntrySpec_destroy as second argument.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
	domainName	the domain name of the data set or NULL for VMD scope data set
	dataSetName	the name of the data set
[out]	err	the error return code

Returns: a list of data set entries (Tase2_DataSetEntrySpec).

◆ Tase2_Client_getDomainDataSets()

TASE2_API LinkedList Tase2_Client_getDomainDataSets	(	Tase2_Client	self,
		const char *	domainName,
		Tase2_ClientError *	err )

Get the list of domain scope data sets.

NOTE: The returned list is in the responsibility of the caller and can be deleted with LinkedList_destroy

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
	domainName	domain name
[out]	err	the error return code

Returns: list of data set name strings

◆ Tase2_Client_getDomainNames()

TASE2_API LinkedList Tase2_Client_getDomainNames	(	Tase2_Client	self,
		Tase2_ClientError *	err )

Get the list of available domains.

NOTE: The returned list is in the responsibility of the caller and can be deleted with LinkedList_destroy

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
[out]	err	the error return code

Returns: list of domain name strings

◆ Tase2_Client_getDomainVariables()

TASE2_API LinkedList Tase2_Client_getDomainVariables	(	Tase2_Client	self,
		const char *	domainName,
		Tase2_ClientError *	err )

Get the list of domain scope variables.

NOTE: The returned list is in the responsibility of the caller and can be deleted with LinkedList_destroy

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
	domainName	domain name
[out]	err	the error return code

Returns: list of variable name strings

◆ Tase2_Client_getEndpoint()

TASE2_API Tase2_Endpoint Tase2_Client_getEndpoint ( Tase2_Client self )

Get the endpoint instance this client is assigned.

Parameters

self	Tase2_Client instance

Returns: the assigned endpoint instance

◆ Tase2_Client_getNextDSTransferSet()

TASE2_API Tase2_ClientDSTransferSet Tase2_Client_getNextDSTransferSet	(	Tase2_Client	self,
		const char *	domainName,
		Tase2_ClientError *	err )

Get the next available DS transfer set (GetNextDSTransferSet operation)

Parameters

	self	the Tase2_Client instance
	domainName	the domain name of associated TASE.2 domain of the requesting client
[out]	err	pointer to Tase2_ClientError variable to store the error code of the service call

◆ Tase2_Client_getServerVersion()

TASE2_API Tase2_Version Tase2_Client_getServerVersion ( Tase2_Client self )

Get the TASE.2 version reported by the server.

Parameters

self	Tase2_Client instance

Returns: structure containing major and minor version numbers

◆ Tase2_Client_getServerVersionMajor()

TASE2_API int Tase2_Client_getServerVersionMajor ( Tase2_Client self )

Get the major version part of the server version.

Parameters

self	Tase2_Client instance

Returns: major version number

◆ Tase2_Client_getServerVersionMinor()

TASE2_API int Tase2_Client_getServerVersionMinor ( Tase2_Client self )

Get the minor version part of the server version.

Parameters

self	Tase2_Client instance

Returns: minor version number

◆ Tase2_Client_getState()

TASE2_API Tase2_ClientState Tase2_Client_getState ( Tase2_Client self )

Get the connection state of the connection.

Parameters

self	Tase2_Client instance

Returns: one of IDLE, CONNECTED, CLOSED

◆ Tase2_Client_getStatistics()

TASE2_API Tase2_Statistics Tase2_Client_getStatistics ( Tase2_Client self )

Access some statistical information for the client connection.

Statistical information comprises the number of sent and received messages and the number of communication errors occurred.

Parameters

self	Tase2_Client instance

Returns: the statistical information

◆ Tase2_Client_getSupportedFeatures()

TASE2_API int Tase2_Client_getSupportedFeatures ( Tase2_Client self )

Get a bit set value representing the support conformance blocks (CB) of the server.

Parameters

self	Tase2_Client instance

Returns: get the supported features reported by the server (bit mask)

◆ Tase2_Client_getTag()

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 )

Read the tag.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
[out]	err	the error return code
	domainName	the domain name of the tag or NULL if the tag has VCC scope
	deviceName	the point name of the tag
[out]	device	is selected (armed) - only valid for SBO control type
[out]	reasonBuf	user provided buffer to store the reason text of the tag
	reasonBufSize	size of the user provided buffer to store the reason text of the tag

Returns: the tag value

◆ Tase2_Client_getVCCDataSets()

TASE2_API LinkedList Tase2_Client_getVCCDataSets	(	Tase2_Client	self,
		Tase2_ClientError *	err )

Get the list of VCC scope data sets.

NOTE: The returned list is in the responsibility of the caller and can be deleted with LinkedList_destroy

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
[out]	err	the error return code

Returns: list of data set name strings

◆ Tase2_Client_getVCCVariables()

TASE2_API LinkedList Tase2_Client_getVCCVariables	(	Tase2_Client	self,
		Tase2_ClientError *	err )

Get the list of VCC scope variables.

NOTE: The returned list is in the responsibility of the caller and can be deleted with LinkedList_destroy

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
[out]	err	the error return code

Returns: list of variable name strings

◆ Tase2_Client_IMTransferSetDisable()

TASE2_API void Tase2_Client_IMTransferSetDisable	(	Tase2_Client	self,
		Tase2_ClientError *	err )

Disable information message transfer set.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

[out] err pointer to Tase2_ClientError variable to store the error code of the service call

◆ Tase2_Client_IMTransferSetEnable()

TASE2_API void Tase2_Client_IMTransferSetEnable	(	Tase2_Client	self,
		Tase2_ClientError *	err )

Enable information message transfer set.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

[out] err pointer to Tase2_ClientError variable to store the error code of the service call

◆ Tase2_Client_installConnectionClosedHandler()

TASE2_API void Tase2_Client_installConnectionClosedHandler	(	Tase2_Client	self,
		Tase2_ConnectionClosedHandler	handler,
		void *	parameter )

Install a handler function that will be called when the connection is lost.

Parameters

self	Tase2_Client instance
handler	the callback function
parameter	a user provided context parameter that is passed to the callback handler

◆ Tase2_Client_installDSTransferSetReportHandler()

TASE2_API void Tase2_Client_installDSTransferSetReportHandler	(	Tase2_Client	self,
		Tase2_DSTransferSetReportHandler	handler,
		void *	parameter )

Install the callback handler for received transfer set reports.

NOTE: The callback handler is invoked twice for each received report. Once directly after the report is received and a second time after all values have been pushed to the application using the Tase2_DSTransferSetValueHandler.

Parameters

self	Tase2_Client instance
handler	the callback function
parameter	a user provided context parameter that is passed to the callback handler

◆ Tase2_Client_installDSTransferSetValueHandler()

TASE2_API void Tase2_Client_installDSTransferSetValueHandler	(	Tase2_Client	self,
		Tase2_DSTransferSetValueHandler	handler,
		void *	parameter )

Install the callback handler to get data points from received transfer set reports.

Parameters

self	Tase2_Client instance
handler	the callback function
parameter	a user provided context parameter that is passed to the callback handler

◆ Tase2_Client_installIMTransferSetHandler()

TASE2_API void Tase2_Client_installIMTransferSetHandler	(	Tase2_Client	self,
		Tase2_InformationMessageHandler	handler,
		void *	parameter )

Install callback handler for information messages (IM transfer set)

Parameters

handler	the callback function
parameter	a user provided context parameter that is passed to the callback handler

◆ Tase2_Client_installStateChangedHandler()

TASE2_API void Tase2_Client_installStateChangedHandler	(	Tase2_Client	self,
		Tase2_Client_StateChangedHandler	handler,
		void *	parameter )

Install a handler that is called whenever the client state changes (e.g. client gets connected or disconnected)

Parameters

self	Tase2_Client instance
handler	the callback function
parameter	a user provided context parameter that is passed to the callback handler

◆ Tase2_Client_readMultiplePointValues()

TASE2_API LinkedList Tase2_Client_readMultiplePointValues	(	Tase2_Client	self,
		Tase2_ClientError *	err,
		const char *	domainName,
		LinkedList	pointNames )

Read multiple data points from the server.

NOTE: the returned list has to be released by the caller with LinkedList_destroyDeep using Tase2_PointValue_destroy

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
[out]	err	the error return code
	domainName	the domain name of the data point or NULL if the data point has VCC scope
	pointNames	list with the data point names as C strings (char*)

Returns: a list of point values, or NULL if the read has not been successful.

◆ Tase2_Client_readPeerIdentity()

TASE2_API void Tase2_Client_readPeerIdentity	(	Tase2_Client	self,
		Tase2_ClientError *	err,
		char **	vendor,
		char **	model,
		char **	revision )

Get the identity of the peer.

NOTE: The returned strings have to be released by the caller (with Tase2_FreeMemory )!

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
[out]	err	the error return code
[out]	vendor	the vendor name of the peer application
[out]	model	the model name of the peer application
[out]	revision	the revision string of the peer application

◆ Tase2_Client_readPointValue()

TASE2_API Tase2_PointValue Tase2_Client_readPointValue	(	Tase2_Client	self,
		Tase2_ClientError *	err,
		const char *	domainName,
		const char *	pointName )

Read a data point (indication point or protection equipment) from the server.

NOTE: the returned point value has to be released by the caller (using Tase2_PointValue_destroy)

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
[out]	err	the error return code
	domainName	the domain name of the data point or NULL if the data point has VCC scope
	pointName	the point name of the data point

Returns: The point value, or NULL if the read has not been successful.

◆ Tase2_Client_selectDevice()

TASE2_API int Tase2_Client_selectDevice	(	Tase2_Client	self,
		Tase2_ClientError *	err,
		const char *	domainName,
		const char *	deviceName )

Select a device (command or setpoint) for SBO control mode.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
[out]	err	the error return code

Returns: check back name value

◆ Tase2_Client_sendCommand()

TASE2_API bool Tase2_Client_sendCommand	(	Tase2_Client	self,
		Tase2_ClientError *	err,
		const char *	domainName,
		const char *	deviceName,
		int16_t	commandValue )

Send a command to a device.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
[out]	err	the error return code
	domainName	the domain name of the device or NULL if the tag has VCC scope
	deviceName	the point name of the device
	commandValue	the command value

Returns: true if the command has been accepted, false otherwise

◆ Tase2_Client_sendDiscreteSetPoint()

TASE2_API bool Tase2_Client_sendDiscreteSetPoint	(	Tase2_Client	self,
		Tase2_ClientError *	err,
		const char *	domainName,
		const char *	deviceName,
		int16_t	setPointValue )

Send a discrete set point to a device.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
[out]	err	the error return code
	domainName	the domain name of the device or NULL if the tag has VCC scope
	deviceName	the point name of the device

◆ Tase2_Client_sendRealSetPoint()

TASE2_API bool Tase2_Client_sendRealSetPoint	(	Tase2_Client	self,
		Tase2_ClientError *	err,
		const char *	domainName,
		const char *	deviceName,
		float	setPointValue )

Send a "real" (float) set point to a device.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
[out]	err	the error return code
	domainName	the domain name of the device or NULL if the tag has VCC scope
	deviceName	the point name of the device

◆ Tase2_Client_setIdentity()

TASE2_API void Tase2_Client_setIdentity	(	Tase2_Client	self,
		const char *	vendor,
		const char *	model,
		const char *	revision )

Set own identity for the identity service.

Parameters

self	Tase2_Client instance
vendor	the vendor name of the TASE.2 application
model	the model name of the TASE.2 application
revision	the revision string of the TASE.2 application

◆ Tase2_Client_setLocalAddresses()

TASE2_API void Tase2_Client_setLocalAddresses	(	Tase2_Client	self,
		Tase2_PSelector	pSelector,
		Tase2_SSelector	sSelector,
		Tase2_TSelector	tSelector )

set local addresses for the lower layers

This function can be used to set the addresses for the lower layer protocols (presentation, session, and transport layer). Calling this function is optional. It might be required when the peer expects specific values for the parameters.

Parameters

self	Tase2_Client instance
pSelector	the P-Selector (presentation layer address)
sSelector	the S-Selector (session layer address)
tSelector	the T-Selector (ISO transport layer address)

◆ Tase2_Client_setLocalAeInvocationId()

TASE2_API void Tase2_Client_setLocalAeInvocationId	(	Tase2_Client	self,
		int	aeInvocationId )

Set local AE-invocation-ID.

Parameters

self	endpoint instance to use
aeInvocationId	the new AE-invocation-ID value

◆ Tase2_Client_setLocalApInvocationId()

TASE2_API void Tase2_Client_setLocalApInvocationId	(	Tase2_Client	self,
		int	apInvocationId )

Set local AP-invocation-ID.

Parameters

self	endpoint instance to use
apInvocationId	the new AP-invocation-ID value

◆ Tase2_Client_setLocalApTitle()

TASE2_API void Tase2_Client_setLocalApTitle	(	Tase2_Client	self,
		const char *	apTitle,
		int	aeQualifier )

Set application endpoint identifier of the local endpoint.

NOTE: It is important to set this parameter correctly to match the remotely configured parameter. The format of the AP-title is a list of positive integer variables separated by '.' or ',' sign. E.g. "1.1.1.999.1" or "1,1,1,999,2".

Parameters

self	Tase2_Client instance
apTitle	AP-title part of the local application endpoint identifier
aeQualifier	AE-qualifier part of the local application endpoint identifier

◆ Tase2_Client_setMaxOutstandingCalls()

TASE2_API void Tase2_Client_setMaxOutstandingCalls	(	Tase2_Client	self,
		int	calling,
		int	called )

Set the maximum number outstanding calls allowed for this connection.

Parameters

self	the connection object
calling	the maximum outstanding calls allowed by the caller (client)
called	the maximum outstanding calls allowed by the called endpoint (server)

◆ Tase2_Client_setRemoteAddresses()

TASE2_API void Tase2_Client_setRemoteAddresses	(	Tase2_Client	self,
		Tase2_PSelector	pSelector,
		Tase2_SSelector	sSelector,
		Tase2_TSelector	tSelector )

set remote addresses for the lower layers

This function can be used to set the addresses for the lower layer protocols (presentation, session, and transport layer). Calling this function is optional and not recommended. It might be required when the server expects specific values for the parameters.

If not used the configured remote application address from the Tase2_Endpoint is used.

Parameters

self	Tase2_Client instance
pSelector	the P-Selector (presentation layer address)
sSelector	the S-Selector (session layer address)
tSelector	the T-Selector (ISO transport layer address)

◆ Tase2_Client_setRemoteAeInvocationId()

TASE2_API void Tase2_Client_setRemoteAeInvocationId	(	Tase2_Client	self,
		int	aeInvocationId )

Set remote AE-invocation-ID (for active endpoint)

Parameters

self	endpoint instance to use
aeInvocationId	the new AE-invocation-ID value

◆ Tase2_Client_setRemoteApInvocationId()

TASE2_API void Tase2_Client_setRemoteApInvocationId	(	Tase2_Client	self,
		int	apInvocationId )

Set remote AP-invocation-ID (for active endpoint)

Parameters

self	endpoint instance to use
apInvocationId	the new AP-invocation-ID value

◆ Tase2_Client_setRemoteApplicationAddress()

TASE2_API void Tase2_Client_setRemoteApplicationAddress	(	Tase2_Client	self,
		Tase2_ApplicationAddress	remoteAddress )

Sets the remote application endpoint addresses.

Parameters

self	Tase2_Client instance
remoteAddress	structure containing ap-title, AE-qualifier, and P-, S-, and T-selectors.

◆ Tase2_Client_setRemoteApTitle()

TASE2_API void Tase2_Client_setRemoteApTitle	(	Tase2_Client	self,
		const char *	apTitle,
		int	aeQualifier )

Set application endpoint identifier of remote endpoint (AP-title and AE-qualifier)

NOTE: It is important to set this parameter correctly to match the remote endpoint identifer. The format of the AP-title is a list of positive integer variables separated by '.' or ',' sign. E.g. "1.1.1.999.1" or "1,1,1,999,2".

If not used the configured remote application address from the Tase2_Endpoint is used.

Parameters

self	Tase2_Client instance
apTitle	AP-title part of the remote application endpoint identifier
aeQualifier	AE-qualifier part of the remote application endpoint identifier

◆ Tase2_Client_setTag()

TASE2_API bool Tase2_Client_setTag	(	Tase2_Client	self,
		Tase2_ClientError *	err,
		const char *	domainName,
		const char *	deviceName,
		Tase2_TagValue	tagValue,
		const char *	reason )

Set tag operation. Set a tag value and a reason message for a device (control point).

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
[out]	err	the error return code
	tagValue	the new tag value
	reason	a text string to specify the reason of the tag

Returns: true when set tag was successful, false otherwise

◆ Tase2_Client_setTcpPort()

TASE2_API void Tase2_Client_setTcpPort	(	Tase2_Client	self,
		int	tcpPort )

Change default remote TCP port used by this client.

Parameters

self	Tase2_Client instance
tcpPort	the TCP port number of the remote endpoint

◆ Tase2_Client_writePointValue()

TASE2_API void Tase2_Client_writePointValue	(	Tase2_Client	self,
		Tase2_ClientError *	err,
		const char *	domainName,
		const char *	pointName,
		Tase2_PointValue	value )

Write a data point (indication point or protection equipment) value to the server.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

	self	Tase2_Client instance
[out]	err	the error return code
	domainName	the domain name of the data point or NULL if the data point has VCC scope
	pointName	the point name of the data point
	value	the new value to write

◆ Tase2_ClientDataSet_destroy()

TASE2_API void Tase2_ClientDataSet_destroy ( Tase2_ClientDataSet self )

Destroy the client data set instance and release all resources.

Parameters

self	the Tase2_ClientDataSet instance

◆ Tase2_ClientDataSet_getDataSetName()

TASE2_API const char * Tase2_ClientDataSet_getDataSetName ( Tase2_ClientDataSet self )

Get the name of the data set.

Returns: the data set name (only valid as long as the Tase2_ClientDataSet instance exists)

◆ Tase2_ClientDataSet_getDomainName()

TASE2_API const char * Tase2_ClientDataSet_getDomainName ( Tase2_ClientDataSet self )

Get the domain name of the data set.

Parameters

self

Returns: the domain name or NULL, for VCC scope data sets

◆ Tase2_ClientDataSet_getPointDomainName()

TASE2_API const char * Tase2_ClientDataSet_getPointDomainName	(	Tase2_ClientDataSet	self,
		int	index )

Get the domain name of the data set entry at the given index.

Parameters

self	the Tase2_ClientDataSet instance
index	the index of the data set entry (starting with 0)

Returns: the domain name of the data set entry

◆ Tase2_ClientDataSet_getPointName()

TASE2_API Tase2_PointName Tase2_ClientDataSet_getPointName	(	Tase2_ClientDataSet	self,
		int	index )

Get the Tase2_PointName of the data set entry at the given index.

Parameters

self	the Tase2_ClientDataSet instance
index	the index of the data set entry (starting with 0)

Returns: the point name of the data set entry

◆ Tase2_ClientDataSet_getPointValue()

TASE2_API Tase2_PointValue Tase2_ClientDataSet_getPointValue	(	Tase2_ClientDataSet	self,
		int	index )

Return a copy of the point value for the data set entry with the given index.

Parameters

self	the Tase2_ClientDataSet instance
index	the index position of the data set entry (starting with 0)

Returns: Return a copy of the data point value. Releasing the allocated memory is in the responsibility of the caller.

◆ Tase2_ClientDataSet_getPointVariableName()

TASE2_API const char * Tase2_ClientDataSet_getPointVariableName	(	Tase2_ClientDataSet	self,
		int	index )

Get the variable name of the data set entry at the given index.

Parameters

self	the Tase2_ClientDataSet instance
index	the index of the data set entry (starting with 0)

Returns: the variable name of the data set entry

◆ Tase2_ClientDataSet_getSize()

TASE2_API int Tase2_ClientDataSet_getSize ( Tase2_ClientDataSet self )

Get the size (number of entries) of the data set.

Returns: number of data set entries

◆ Tase2_ClientDataSet_isDeletable()

TASE2_API bool Tase2_ClientDataSet_isDeletable ( Tase2_ClientDataSet self )

Check if the data set can be deleted by the client.

Returns: true when data set can be deleted by the client, false otherwise

◆ Tase2_ClientDataSet_read()

TASE2_API Tase2_ClientError Tase2_ClientDataSet_read	(	Tase2_ClientDataSet	self,
		Tase2_Client	client )

read the data set values from the server

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

self	the Tase2_ClientDataSet instance
client	the connection to be used

Returns: TASE2_CLIENT_ERROR_OK in case of success, or error code

◆ Tase2_ClientDSTransferSet_destroy()

TASE2_API void Tase2_ClientDSTransferSet_destroy ( Tase2_ClientDSTransferSet self )

Destroy transfer set.

NOTE: Do not call this function until the Tase2_Client instance is either destroyed or the client state (see Tase2_Client_getState) changes to TASE2_CLIENT_STATE_IDLE or TASE2_CLIENT_STATE_CLOSED. Otherwise the instance might be called internally by Tase2_Client and cause memory corruption!

Parameters

self	the Tase2_ClientDSTransferSet instance

◆ Tase2_ClientDSTransferSet_getAllChangesReported()

TASE2_API bool Tase2_ClientDSTransferSet_getAllChangesReported ( Tase2_ClientDSTransferSet self )

Get the value of the AllChangesReported attribute.

This attributes indicates if all changes of an element during the buffer time are reported (true), or only the last change (false).

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: true if all changes reported is enabled, false otherwise

◆ Tase2_ClientDSTransferSet_getBlockData()

TASE2_API bool Tase2_ClientDSTransferSet_getBlockData ( Tase2_ClientDSTransferSet self )

Get the information if blocked data transfer is used.

NOTE: blocked data transfer (CB3) is not supported!

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: true when blocked data transfer is used, false otherwise

◆ Tase2_ClientDSTransferSet_getBufferTime()

TASE2_API int32_t Tase2_ClientDSTransferSet_getBufferTime ( Tase2_ClientDSTransferSet self )

Get the buffer time value.

The buffer time is the time between an object change and the transmission of the report. During the buffer time events are collected and can be transmitted with the same report. If the buffer time is 0 then every event causes a report.

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: buffer time value in seconds

◆ Tase2_ClientDSTransferSet_getCritical()

TASE2_API bool Tase2_ClientDSTransferSet_getCritical ( Tase2_ClientDSTransferSet self )

Get the value of the critical flag.

The critical flag indicates that the client has to confirm the reception of the critical report.

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: true if critical is set, false otherwise

◆ Tase2_ClientDSTransferSet_getDataSet()

TASE2_API Tase2_ClientDataSet Tase2_ClientDSTransferSet_getDataSet ( Tase2_ClientDSTransferSet self )

Get Tase2_ClientDataSet instance of the transfer set data set.

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: the Tase2_ClientDataSet instance of the transfer set

◆ Tase2_ClientDSTransferSet_getDataSetDomain()

TASE2_API const char * Tase2_ClientDSTransferSet_getDataSetDomain ( Tase2_ClientDSTransferSet self )

Get the domain name of the data set.

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: the data set domain name string

◆ Tase2_ClientDSTransferSet_getDataSetName()

TASE2_API const char * Tase2_ClientDSTransferSet_getDataSetName ( Tase2_ClientDSTransferSet self )

Get the name of the data set.

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: the data set name string

◆ Tase2_ClientDSTransferSet_getDomain()

TASE2_API const char * Tase2_ClientDSTransferSet_getDomain ( Tase2_ClientDSTransferSet self )

Get the domain name of the DSTransferSet.

Parameters

self	the Tase2_ClientDSTransferSet instance

◆ Tase2_ClientDSTransferSet_getDSConditionsDetected()

TASE2_API uint8_t Tase2_ClientDSTransferSet_getDSConditionsDetected ( Tase2_ClientDSTransferSet self )

Get the DSConditions Detected value from the last received report.

This represents an optional special data set variable. When part of the transfer set data set this will be sent with reports.

At the time of reporting, this attribute uniquely identifies the conditions that caused the generation of the report.

NOTE: The value may not be present in a report.

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: DSConditions Detected value (reason code for transfer report)

◆ Tase2_ClientDSTransferSet_getDSConditionsRequested()

TASE2_API int Tase2_ClientDSTransferSet_getDSConditionsRequested ( Tase2_ClientDSTransferSet self )

Get the DSConditions to trigger a report transmission.

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: the DSConditions value (DS conditions (DS transfer sets))

◆ Tase2_ClientDSTransferSet_getEventCodeDetected()

TASE2_API int16_t Tase2_ClientDSTransferSet_getEventCodeDetected ( Tase2_ClientDSTransferSet self )

Get the event code detected value from the last received report.

This represents an optional special data set variable. When part of the transfer set data set this will be sent with reports.

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: the event code

◆ Tase2_ClientDSTransferSet_getEventCodeRequested()

TASE2_API int16_t Tase2_ClientDSTransferSet_getEventCodeRequested ( Tase2_ClientDSTransferSet self )

Get the external event code that caused the transmission.

Returns: the external event code

◆ Tase2_ClientDSTransferSet_getIntegrityCheck()

TASE2_API int32_t Tase2_ClientDSTransferSet_getIntegrityCheck ( Tase2_ClientDSTransferSet self )

Get the integrity check interval time.

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: the integrity check interval time value in seconds

◆ Tase2_ClientDSTransferSet_getInterval()

TASE2_API int32_t Tase2_ClientDSTransferSet_getInterval ( Tase2_ClientDSTransferSet self )

Get the transmission interval of the report.

When the report time is set, then events are collected and reported after the interval timeout.

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: transmission interval for periodic transmission in seconds

◆ Tase2_ClientDSTransferSet_getName()

TASE2_API const char * Tase2_ClientDSTransferSet_getName ( Tase2_ClientDSTransferSet self )

Get the name of the DSTransferSet.

Parameters

self	the Tase2_ClientDSTransferSet instance

◆ Tase2_ClientDSTransferSet_getRBE()

TASE2_API bool Tase2_ClientDSTransferSet_getRBE ( Tase2_ClientDSTransferSet self )

Get the value of the RBE (report by exception) flag.

When RBE is activated only the changed objects are reported. Otherwise all objects in the transfer set data set are reported.

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: true if RBE is enabled, false otherwise

◆ Tase2_ClientDSTransferSet_getStartTime()

TASE2_API int32_t Tase2_ClientDSTransferSet_getStartTime ( Tase2_ClientDSTransferSet self )

Get the start time of report transmission.

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: the transmission start time value in seconds since 01.01.1970 UTC

◆ Tase2_ClientDSTransferSet_getStatus()

TASE2_API bool Tase2_ClientDSTransferSet_getStatus ( Tase2_ClientDSTransferSet self )

Get status of the transfer set.

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: true when the transfer set (reporting) is enabled, false otherwise

◆ Tase2_ClientDSTransferSet_getTLE()

TASE2_API int32_t Tase2_ClientDSTransferSet_getTLE ( Tase2_ClientDSTransferSet self )

Get the TLE (Time Limit for Execution) value.

Parameters

self	the Tase2_ClientDSTransferSet instance

Returns: TLE value in seconds

◆ Tase2_ClientDSTransferSet_getTransferSetTimestamp()

TASE2_API int32_t Tase2_ClientDSTransferSet_getTransferSetTimestamp ( Tase2_ClientDSTransferSet self )

Get the transfer set timestamp value from the last received report.

This represents an optional special data set variable. When part of the transfer set data set this will be sent with reports.

This attribute specifies the time the transfer report was generated at the server.

Returns: transfer set timestamp value in seconds since 01.01.1970 UTC

◆ Tase2_ClientDSTransferSet_readValues()

TASE2_API Tase2_ClientError Tase2_ClientDSTransferSet_readValues	(	Tase2_ClientDSTransferSet	self,
		Tase2_Client	client )

Read the values of the DSTransferSet from the server.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

self	the Tase2_ClientDSTransferSet instance
client	the Tase2_Client connection to use

Returns: error code of the read service

◆ Tase2_ClientDSTransferSet_setAllChangesReported()

TASE2_API void Tase2_ClientDSTransferSet_setAllChangesReported	(	Tase2_ClientDSTransferSet	self,
		bool	allChangesReported )

Enable/disable transmission of all changes.

Parameters

self	the Tase2_ClientDSTransferSet instance
allChangesReported	when true, all changes of an object are reported, when false, changes that happen in the buffer time may not be reported

◆ Tase2_ClientDSTransferSet_setBlockData()

TASE2_API void Tase2_ClientDSTransferSet_setBlockData	(	Tase2_ClientDSTransferSet	self,
		bool	blockData )

Enables/disables block data transfer.

The block data mode provides a compressed data format for transmission to save bandwidth. NOTE: Should not be set to true! Block data transfer (CB3 is not supported by the library)

Parameters

self	the Tase2_ClientDSTransferSet instance
blockData	true to enable block data transfer, false otherwise

◆ Tase2_ClientDSTransferSet_setBufferTime()

TASE2_API void Tase2_ClientDSTransferSet_setBufferTime	(	Tase2_ClientDSTransferSet	self,
		int32_t	bufferTime )

Sets the buffer time (wait time until report is sent)

Parameters

self	the Tase2_ClientDSTransferSet instance
bufferTime	the buffer time value in seconds

◆ Tase2_ClientDSTransferSet_setCritical()

TASE2_API void Tase2_ClientDSTransferSet_setCritical	(	Tase2_ClientDSTransferSet	self,
		bool	critical )

Sets the critical flag.

NOTE: critical reports have to be acknowledged by the client.

Parameters

self	the Tase2_ClientDSTransferSet instance
critical	true, enable critical transfer report, false, otherwise

◆ Tase2_ClientDSTransferSet_setDataSet()

TASE2_API void Tase2_ClientDSTransferSet_setDataSet	(	Tase2_ClientDSTransferSet	self,
		Tase2_ClientDataSet	dataSet )

Associate a data set instance with the transfer set.

Parameters

self	the Tase2_ClientDSTransferSet instance
dataSet	the data set instance to use

◆ Tase2_ClientDSTransferSet_setDataSetName()

TASE2_API void Tase2_ClientDSTransferSet_setDataSetName	(	Tase2_ClientDSTransferSet	self,
		const char *	domainId,
		const char *	dataSetId )

Sets the name of the transfer set data set.

Parameters

self	the Tase2_ClientDSTransferSet instance
domainId	domain name of the data set
dataSetid	name of the data set

◆ Tase2_ClientDSTransferSet_setDSConditionsRequested()

TASE2_API void Tase2_ClientDSTransferSet_setDSConditionsRequested	(	Tase2_ClientDSTransferSet	self,
		int	dsConditionsRequested )

Sets the trigger conditions for reports (DS conditions (DS transfer sets))

Parameters

self	the Tase2_ClientDSTransferSet instance
dsConditionRequested	the trigger conditions (bitmask/sum of DS conditions (DS transfer sets))

◆ Tase2_ClientDSTransferSet_setIntegrityCheck()

TASE2_API void Tase2_ClientDSTransferSet_setIntegrityCheck	(	Tase2_ClientDSTransferSet	self,
		int32_t	integrityCheck )

Sets the integrity check interval time.

Parameters

self	the Tase2_ClientDSTransferSet instance
integrityCheck	the integrity check value in seconds.

◆ Tase2_ClientDSTransferSet_setInterval()

TASE2_API void Tase2_ClientDSTransferSet_setInterval	(	Tase2_ClientDSTransferSet	self,
		int32_t	interval )

Sets the interval time for transfer set reports.

The interval time determines the time period for cyclic report transmission.

Parameters

self	the Tase2_ClientDSTransferSet instance
interval	the interval time in seconds.

◆ Tase2_ClientDSTransferSet_setRBE()

TASE2_API void Tase2_ClientDSTransferSet_setRBE	(	Tase2_ClientDSTransferSet	self,
		bool	rbe )

Set the value of the RBE (report by exception) flag.

Parameters

self	the Tase2_ClientDSTransferSet instance
rbe	true, enable RBE, false, otherwise

◆ Tase2_ClientDSTransferSet_setStartTime()

TASE2_API void Tase2_ClientDSTransferSet_setStartTime	(	Tase2_ClientDSTransferSet	self,
		int32_t	startTime )

Sets the start time of transfer set monitoring.

Parameters

self	the Tase2_ClientDSTransferSet instance
startTime	Start time as seconds since epoch.

◆ Tase2_ClientDSTransferSet_setStatus()

TASE2_API void Tase2_ClientDSTransferSet_setStatus	(	Tase2_ClientDSTransferSet	self,
		bool	status )

Enable/disable the status of condition monitoring (and report transmission)

Parameters

self	the Tase2_ClientDSTransferSet instance
status	true, enable reporting, false otherwise

◆ Tase2_ClientDSTransferSet_setTLE()

TASE2_API void Tase2_ClientDSTransferSet_setTLE	(	Tase2_ClientDSTransferSet	self,
		int32_t	tle )

Sets the TLE (Time Limit for Execution) value.

Parameters

self	the Tase2_ClientDSTransferSet instance
tle	TLE value in seconds

◆ Tase2_ClientDSTransferSet_writeAllChangesReported()

TASE2_API Tase2_ClientError Tase2_ClientDSTransferSet_writeAllChangesReported	(	Tase2_ClientDSTransferSet	self,
		Tase2_Client	client,
		bool	allChangesReported )

Enable/disable transmission of all changes (write immediately to server)

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

self	the Tase2_ClientDSTransferSet instance
client	the related client instance used to send the write message to the server
allChangesReported	when true, all changes are reported, when false, changes that happen in the buffer time may not be reported

Returns: error code (TASE2_CLIENT_ERROR_OK in case of success)

◆ Tase2_ClientDSTransferSet_writeBlockData()

TASE2_API Tase2_ClientError Tase2_ClientDSTransferSet_writeBlockData	(	Tase2_ClientDSTransferSet	self,
		Tase2_Client	client,
		bool	blockData )

Enables/disables block data transfer (write immediately to server)

The block data mode provides a compressed data format for transmission to save bandwidth. NOTE: Should not be set to true! Block data transfer (CB3 is not supported by the library)

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

self	the Tase2_ClientDSTransferSet instance
client	the related client instance used to send the write message to the server
blockData	true to enable block data transfer, false otherwise

Returns: error code (TASE2_CLIENT_ERROR_OK in case of success)

◆ Tase2_ClientDSTransferSet_writeBufferTime()

TASE2_API Tase2_ClientError Tase2_ClientDSTransferSet_writeBufferTime	(	Tase2_ClientDSTransferSet	self,
		Tase2_Client	client,
		int32_t	bufferTime )

Sets the buffer time (wait time until report is sent) (write immediately to server)

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

self	the Tase2_ClientDSTransferSet instance
client	the related client instance used to send the write message to the server
bufferTime	the buffer time value in seconds

Returns: error code (TASE2_CLIENT_ERROR_OK in case of success)

◆ Tase2_ClientDSTransferSet_writeCritical()

TASE2_API Tase2_ClientError Tase2_ClientDSTransferSet_writeCritical	(	Tase2_ClientDSTransferSet	self,
		Tase2_Client	client,
		bool	critical )

Set the value of the critical flag (write immediately to server)

The critical flag indicates that the client has to confirm the reception of the critical report.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

self	the Tase2_ClientDSTransferSet instance
client	the related client instance used to send the write message to the server
critical	true to set the critical flag, false otherwise

Returns: error code (TASE2_CLIENT_ERROR_OK in case of success)

◆ Tase2_ClientDSTransferSet_writeDataSetName()

TASE2_API Tase2_ClientError Tase2_ClientDSTransferSet_writeDataSetName	(	Tase2_ClientDSTransferSet	self,
		Tase2_Client	client,
		const char *	domainId,
		const char *	dataSetId )

Write the name of the transfer set data set (write immediately to server)

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

self	the Tase2_ClientDSTransferSet instance
client	the related client instance used to send the write message to the server
domainId	domain name of the data set
dataSetid	name of the data set

Returns: error code (TASE2_CLIENT_ERROR_OK in case of success)

◆ Tase2_ClientDSTransferSet_writeDSConditionsRequested()

TASE2_API Tase2_ClientError Tase2_ClientDSTransferSet_writeDSConditionsRequested	(	Tase2_ClientDSTransferSet	self,
		Tase2_Client	client,
		int	dsConditionsRequested )

Sets the trigger conditions for reports (DS conditions (DS transfer sets)) (write immediately to server)

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

self	the Tase2_ClientDSTransferSet instance
client	the related client instance used to send the write message to the server
dsConditionRequested	the trigger conditions (bitmask/sum of DS conditions (DS transfer sets))

Returns: error code (TASE2_CLIENT_ERROR_OK in case of success)

◆ Tase2_ClientDSTransferSet_writeIntegrityCheck()

TASE2_API Tase2_ClientError Tase2_ClientDSTransferSet_writeIntegrityCheck	(	Tase2_ClientDSTransferSet	self,
		Tase2_Client	client,
		int32_t	integrityCheck )

Sets the integrity check interval time (write immediately to server)

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

self	the Tase2_ClientDSTransferSet instance
client	the related client instance used to send the write message to the server
integrityCheck	the integrity check value in seconds.

Returns: error code (TASE2_CLIENT_ERROR_OK in case of success)

◆ Tase2_ClientDSTransferSet_writeInterval()

TASE2_API Tase2_ClientError Tase2_ClientDSTransferSet_writeInterval	(	Tase2_ClientDSTransferSet	self,
		Tase2_Client	client,
		int32_t	interval )

Sets the interval time for transfer set reports (write immediately to server)

The interval time determines the time period for cyclic report transmission.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

self	the Tase2_ClientDSTransferSet instance
client	the related client instance used to send the write message to the server
interval	the interval time in seconds.

Returns: error code (TASE2_CLIENT_ERROR_OK in case of success)

◆ Tase2_ClientDSTransferSet_writeRBE()

TASE2_API Tase2_ClientError Tase2_ClientDSTransferSet_writeRBE	(	Tase2_ClientDSTransferSet	self,
		Tase2_Client	client,
		bool	rbe )

Write the value of the RBE (report by exception) flag (write immediately to server)

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

self	the Tase2_ClientDSTransferSet instance
client	the related client instance used to send the write message to the server
rbe	true, send reports when a value changes

Returns: error code (TASE2_CLIENT_ERROR_OK in case of success)

◆ Tase2_ClientDSTransferSet_writeStartTime()

TASE2_API Tase2_ClientError Tase2_ClientDSTransferSet_writeStartTime	(	Tase2_ClientDSTransferSet	self,
		Tase2_Client	client,
		int32_t	startTime )

Sets the start time of transfer set monitoring (write immediately to server)

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

self	the Tase2_ClientDSTransferSet instance
client	the related client instance used to send the write message to the server
startTime	Start time as seconds since epoch.

Returns: error code (TASE2_CLIENT_ERROR_OK in case of success)

◆ Tase2_ClientDSTransferSet_writeStatus()

TASE2_API Tase2_ClientError Tase2_ClientDSTransferSet_writeStatus	(	Tase2_ClientDSTransferSet	self,
		Tase2_Client	client,
		bool	status )

Enable/disable the status of condition monitoring and report transmission (write immediately to server)

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

self	the Tase2_ClientDSTransferSet instance
client	the related client instance used to send the write message to the server
status	true, enable reporting, false otherwise

Returns: error code (TASE2_CLIENT_ERROR_OK in case of success)

◆ Tase2_ClientDSTransferSet_writeTLE()

TASE2_API Tase2_ClientError Tase2_ClientDSTransferSet_writeTLE	(	Tase2_ClientDSTransferSet	self,
		Tase2_Client	client,
		int32_t	tle )

Sets the TLE (Time Limit for Execution) value (write immediately to server).

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

self	the Tase2_ClientDSTransferSet instance
client	the related client instance used to send the write message to the server
tle	TLE value in seconds

Returns: error code (TASE2_CLIENT_ERROR_OK in case of success)

◆ Tase2_ClientDSTransferSet_writeValues()

TASE2_API Tase2_ClientError Tase2_ClientDSTransferSet_writeValues	(	Tase2_ClientDSTransferSet	self,
		Tase2_Client	client )

Write the buffered values of the DSTransferSet to the server.

NOTE: This function can only be used after calling the Tase2_ClientDSTransferSet_readValues function to get the current values of the transfer set in the server.

DO NOT CALL THIS FUNCTION INSIDE A LIBRARY CALLBACK! Calling this function inside library callbacks can cause deadlock situations.

Parameters

self	the Tase2_ClientDSTransferSet instance
client	the Tase2_Client connection to use

Returns: error code of the write service

◆ Tase2_DataSetEntrySpec_destroy()

TASE2_API void Tase2_DataSetEntrySpec_destroy ( Tase2_DataSetEntrySpec self )

Delete a data set entry specification.

◆ Tase2_DataSetEntrySpec_getDomainId()

TASE2_API const char * Tase2_DataSetEntrySpec_getDomainId ( Tase2_DataSetEntrySpec self )

Get the domain ID of the data set entry.

◆ Tase2_DataSetEntrySpec_getItemId()

TASE2_API const char * Tase2_DataSetEntrySpec_getItemId ( Tase2_DataSetEntrySpec self )

Get the item ID of the data set entry.

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ Tase2_Client_StateChangedHandler

◆ Tase2_ClientDataSet

◆ Tase2_ClientDSTransferSet

◆ Tase2_ConnectionClosedHandler

◆ Tase2_DSTransferSetReportHandler

◆ Tase2_DSTransferSetValueHandler

◆ Tase2_InformationMessageHandler

Enumeration Type Documentation

◆ Tase2_ClientState

Function Documentation

◆ Tase2_Client_connect()

◆ Tase2_Client_connectEx()

◆ Tase2_Client_create()

◆ Tase2_Client_createDataSet()

◆ Tase2_Client_createEx()

◆ Tase2_Client_deleteDataSet()

◆ Tase2_Client_destroy()

◆ Tase2_Client_disconnect()

◆ Tase2_Client_getBilateralTableId()

◆ Tase2_Client_getDataSet()

◆ Tase2_Client_getDataSetDirectory()

◆ Tase2_Client_getDomainDataSets()

◆ Tase2_Client_getDomainNames()

◆ Tase2_Client_getDomainVariables()

◆ Tase2_Client_getEndpoint()

◆ Tase2_Client_getNextDSTransferSet()

◆ Tase2_Client_getServerVersion()

◆ Tase2_Client_getServerVersionMajor()

◆ Tase2_Client_getServerVersionMinor()

◆ Tase2_Client_getState()

◆ Tase2_Client_getStatistics()

◆ Tase2_Client_getSupportedFeatures()

◆ Tase2_Client_getTag()

◆ Tase2_Client_getVCCDataSets()

◆ Tase2_Client_getVCCVariables()

◆ Tase2_Client_IMTransferSetDisable()

◆ Tase2_Client_IMTransferSetEnable()

◆ Tase2_Client_installConnectionClosedHandler()

◆ Tase2_Client_installDSTransferSetReportHandler()

◆ Tase2_Client_installDSTransferSetValueHandler()

◆ Tase2_Client_installIMTransferSetHandler()

◆ Tase2_Client_installStateChangedHandler()

◆ Tase2_Client_readMultiplePointValues()

◆ Tase2_Client_readPeerIdentity()

◆ Tase2_Client_readPointValue()

◆ Tase2_Client_selectDevice()

◆ Tase2_Client_sendCommand()

◆ Tase2_Client_sendDiscreteSetPoint()

◆ Tase2_Client_sendRealSetPoint()

◆ Tase2_Client_setIdentity()

◆ Tase2_Client_setLocalAddresses()

◆ Tase2_Client_setLocalAeInvocationId()

◆ Tase2_Client_setLocalApInvocationId()

◆ Tase2_Client_setLocalApTitle()

◆ Tase2_Client_setMaxOutstandingCalls()

◆ Tase2_Client_setRemoteAddresses()

◆ Tase2_Client_setRemoteAeInvocationId()

◆ Tase2_Client_setRemoteApInvocationId()

◆ Tase2_Client_setRemoteApplicationAddress()

◆ Tase2_Client_setRemoteApTitle()

◆ Tase2_Client_setTag()

◆ Tase2_Client_setTcpPort()

◆ Tase2_Client_writePointValue()

◆ Tase2_ClientDataSet_destroy()

◆ Tase2_ClientDataSet_getDataSetName()

◆ Tase2_ClientDataSet_getDomainName()

◆ Tase2_ClientDataSet_getPointDomainName()

◆ Tase2_ClientDataSet_getPointName()

◆ Tase2_ClientDataSet_getPointValue()

◆ Tase2_ClientDataSet_getPointVariableName()

◆ Tase2_ClientDataSet_getSize()

◆ Tase2_ClientDataSet_isDeletable()

◆ Tase2_ClientDataSet_read()

◆ Tase2_ClientDSTransferSet_destroy()