UaClientSdk::UaSubscription Class Reference
[UA Client Library]

#include <uasubscription.h>


Public Member Functions
UaStatus	modifySubscription (ServiceSettings &serviceSettings, SubscriptionSettings &subscriptionSettings)
UaStatus	setPublishingMode (ServiceSettings &serviceSettings, OpcUa_Boolean publishingEnabled)
UaStatus	createMonitoredItems (ServiceSettings &serviceSettings, OpcUa_TimestampsToReturn timestampsToReturn, const UaMonitoredItemCreateRequests &monitoredItemCreateRequests, UaMonitoredItemCreateResults &monitoredItemCreateResults)
UaStatus	modifyMonitoredItems (ServiceSettings &serviceSettings, OpcUa_TimestampsToReturn timestampsToReturn, const UaMonitoredItemModifyRequests &monitoredItemModifyRequests, UaMonitoredItemModifyResults &monitoredItemModifyResults)
UaStatus	setMonitoringMode (ServiceSettings &serviceSettings, OpcUa_MonitoringMode monitoringMode, const UaUInt32Array &monitoredItemIds, UaStatusCodeArray &results)
UaStatus	deleteMonitoredItems (ServiceSettings &serviceSettings, const UaUInt32Array &monitoredItemIds, UaStatusCodeArray &results)
UaStatus	republish (ServiceSettings &serviceSettings, OpcUa_Int32 retransmitSequenceNumber, UaDataNotifications &dataNotifications, UaDiagnosticInfos &diagnosticInfos, UaEventFieldLists &eventFieldList, UaStatus &subscriptionStatus)
OpcUa_UInt32	subscriptionId ()
OpcUa_Double	publishingInterval ()
OpcUa_UInt32	lifetimeCount ()
OpcUa_UInt32	maxKeepAliveCount ()
OpcUa_UInt32	maxNotificationsPerPublish ()
OpcUa_Byte	priority ()
OpcUa_Boolean	publishingEnabled ()

Detailed Description

The UaSubscription class manges a UA Client created subscription. The class provides all Subscription related UA Services as syncronous and asyncronous methods.

Member Function Documentation

UaStatus UaSubscription::modifySubscription	(	ServiceSettings &	serviceSettings,
		SubscriptionSettings &	subscriptionSettings
	)

Modify the subscription settings

Parameters:

serviceSettings	[in,out] The general service settings like timeout. See ServiceSettings for more details
subscriptionSettings	[in,out] The new subscription settings. See SubscriptionSettings for more details

UaStatus UaSubscription::setPublishingMode	(	ServiceSettings &	serviceSettings,
		OpcUa_Boolean	publishingEnabled
	)

Set the publishing mode of the subscription

Parameters:

serviceSettings	[in,out] The general service settings like timeout. See ServiceSettings for more details
publishingEnabled	[in] New publishing enabled setting.

UaStatus UaSubscription::createMonitoredItems	(	ServiceSettings &	serviceSettings,
		OpcUa_TimestampsToReturn	timestampsToReturn,
		const UaMonitoredItemCreateRequests &	monitoredItemCreateRequests,
		UaMonitoredItemCreateResults &	monitoredItemCreateResults
	)

Creates monitored items

Parameters:

serviceSettings	[in,out] The general service settings like timeout. See ServiceSettings for more details
timestampsToReturn	[in] OPC UA defines two timestamps, the source and the server timestamp. This parameter allows the client to define which timestamps the server should return with the value. The source timestamp is only available for Value Attributes. The source timestamp is used to reflect the timestamp that was applied to a Variable value by the data source. It should indicate the last change of the value or status code. The source timestamp must be always generated by the same physical clock. This timestamp type was added for OPC UA to cover the use case to get the timestamp of the last value change which is different than the server timestamp definition. The server timestamp is used to reflect the time that the server received a Variable value or knew it to be accurate if the changes are reported by exeption and the connection to the data source is operating. This is the behavior expected by Classic OPC Possible values are: OpcUa_TimestampsToReturn_Source OpcUa_TimestampsToReturn_Server OpcUa_TimestampsToReturn_Both
monitoredItemCreateRequests	[in] List of monitored items to create
monitoredItemCreateResults	[out] List of create results

UaStatus UaSubscription::modifyMonitoredItems	(	ServiceSettings &	serviceSettings,
		OpcUa_TimestampsToReturn	timestampsToReturn,
		const UaMonitoredItemModifyRequests &	monitoredItemModifyRequests,
		UaMonitoredItemModifyResults &	monitoredItemModifyResults
	)

Modify monitored items

Parameters:

serviceSettings	[in,out] The general service settings like timeout. See ServiceSettings for more details
timestampsToReturn	[in] OPC UA defines two timestamps, the source and the server timestamp. This parameter allows the client to define which timestamps the server should return with the value. The source timestamp is only available for Value Attributes. The source timestamp is used to reflect the timestamp that was applied to a Variable value by the data source. It should indicate the last change of the value or status code. The source timestamp must be always generated by the same physical clock. This timestamp type was added for OPC UA to cover the use case to get the timestamp of the last value change which is different than the server timestamp definition. The server timestamp is used to reflect the time that the server received a Variable value or knew it to be accurate if the changes are reported by exeption and the connection to the data source is operating. This is the behavior expected by Classic OPC Possible values are: OpcUa_TimestampsToReturn_Source OpcUa_TimestampsToReturn_Server OpcUa_TimestampsToReturn_Both
monitoredItemModifyRequests	[in] List of monitored items to modify
monitoredItemModifyResults	[out] List of modify results

UaStatus UaSubscription::setMonitoringMode	(	ServiceSettings &	serviceSettings,
		OpcUa_MonitoringMode	monitoringMode,
		const UaUInt32Array &	monitoredItemIds,
		UaStatusCodeArray &	setMonitoringResults
	)

Set monitoring mode for monitored items

Parameters:

serviceSettings	[in,out] The general service settings like timeout. See ServiceSettings for more details
monitoringMode	[in] New monitoring mode. Options are OpcUa_MonitoringMode_Disabled, OpcUa_MonitoringMode_Sampling and OpcUa_MonitoringMode_Reporting
monitoredItemIds	[in] List of monitored items where the monitoring mode should be changed
setMonitoringResults	[out] List of change results

UaStatus UaSubscription::deleteMonitoredItems	(	ServiceSettings &	serviceSettings,
		const UaUInt32Array &	monitoredItemIds,
		UaStatusCodeArray &	deleteResults
	)

Delete monitored items

Parameters:

serviceSettings	[in,out] The general service settings like timeout. See ServiceSettings for more details
monitoredItemIds	[in] List of monitored items to delete
deleteResults	[out] List of delete results

UaStatus UaSubscription::republish	(	ServiceSettings &	serviceSettings,
		OpcUa_Int32	retransmitSequenceNumber,
		UaDataNotifications &	dataNotifications,
		UaDiagnosticInfos &	diagnosticInfos,
		UaEventFieldLists &	eventFieldList,
		UaStatus &	subscriptionStatus
	)

Republish call to get lost notifications

Parameters:

serviceSettings	[in,out] The general service settings like timeout. See ServiceSettings for more details
dataNotifications	[out] List of data notifiations. The list can be empty if the message contains only event notifications.
diagnosticInfos	[out] List of diagnostic info related to the data notifications. This list can be empty.
eventFieldList	[out] List of event notifiations. The list can be empty if the message contains only data change notifications.
subscriptionStatus	[out] Contains the status of the subscription if it has changed.

OpcUa_UInt32 UaSubscription::subscriptionId ( )

Returns the id of the subscription

OpcUa_Double UaSubscription::publishingInterval ( )

Returns the publishing interval of the subscription

OpcUa_UInt32 UaSubscription::lifetimeCount ( )

Returns the lifetime count of the subscription.

OpcUa_UInt32 UaSubscription::maxKeepAliveCount ( )

Returns the maximim keep alive count of the subscription

OpcUa_UInt32 UaSubscription::maxNotificationsPerPublish ( )

Returns the maximum number of notifications per publish for the subscription

OpcUa_Byte UaSubscription::priority ( )

Returns the priority of the subscription

OpcUa_Boolean UaSubscription::publishingEnabled ( )

Returns the publish enabled flag of the subscription

The documentation for this class was generated from the following files:

src/uaclient/uaclientcpp/uasubscription.h
src/uaclient/uaclientcpp/uasubscription.cpp

UaClientSdk::UaSubscription Class Reference [UA Client Library]

Public Member Functions

Detailed Description

Member Function Documentation

UaClientSdk::UaSubscription Class Reference
[UA Client Library]