IEasyUASubscriber Interface Methods

OPC Studio User's Guide and Reference

IEasyUASubscriber Interface Methods

Collapse All

OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.PubSub Namespace : IEasyUASubscriber Interface

For a list of all members of this type, see IEasyUASubscriber members.

Public Methods

	Name	Description
	ChangeDataSetSubscription	Changes parameters of an existing dataset subscription.
	GetService	Gets the service object of the specified type. (Inherited from System.IServiceProvider)
	GetSubscribeDataSetArguments	Obtains parameters of a specified dataset subscription.
	GetSubscribeDataSetArgumentsDictionary	Obtains information about all dataset subscriptions on this IEasyUASubscriber object.
	IsKnownDataSetSubscriptionHandle	Determines whether the given data set subscription handle is known to this client.
	PullMultipleDataSetMessages	Attempts to pull multiple dataset message event notifications.
	PullMultipleResolverAccesses	Attempts to pull multiple resolver access event notifications.
	PullMultipleSubscriptionResolvedNotifications	Attempts to pull multiple subscription resolved event notifications.
	SubscribeDataSet	Subscribes to a dataset. The DataSetMessage event is generated for each dataset message received.
	UnsubscribeAllDataSets	Unsubscribes from all datasets.
	UnsubscribeDataSet	Unsubscribes from a dataset specified by its integer handle.

Extension Methods

	Name	Description
	ChangeDataSetFieldSubscription	Overloaded. Changes parameters of an existing dataset field subscription.
	ChangeDataSetSubscription	Changes parameters of an existing dataset subscription, specifying a new filter.
	GetSubscribeDataSetFieldArguments	Obtains parameters of a specified dataset subscription.
	PullDataSetMessage	Attempts to pull a dataset message event notification subscribed to by the SubscribeDataSet method.
	PullResolverAccess	Attempts to pull a resolver access notification.
	PullSubscriptionResolved	Attempts to pull a subscription resolved notification.
	SubscribeDataSet	Overloaded. Subscribes to a dataset, using a PubSub connection descriptor, and no filter.
	SubscribeDataSetField	Overloaded. Subscribes to a single dataset field from a dataset, using arguments object.
	TestConnection	Overloaded. Tests whether an OPC UA PubSub connection can be successfully established. Synchronous. The method returns normally when the test passes. The method throws a OpcLabs.EasyOpc.UA.OperationModel.UAException when there is an error establishing the connection. Due to asynchronous nature of some communication channels, successful test outcome does not always imply that a connection has been fully established. The waitMilliseconds parameter is not a timeout in its traditional sense, i.e. a maximum time allowed for the operation. Here, this method actually waits for the time given by waitMilliseconds parameter unless a failure occurs.
	TestConnectionAsync	Overloaded. Tests whether an OPC UA PubSub connection can be successfully established. Asynchronous. Due to asynchronous nature of some communication channels, successful test outcome does not always imply that a connection has been fully established. The waitMilliseconds parameter is not a timeout in its traditional sense, i.e. a maximum time allowed for the operation. Here, this method actually waits for the time given by waitMilliseconds parameter unless a failure occurs.
	TestSubscription	Tests whether an OPC UA PubSub subscription can be successfully established. Synchronous.
	TestSubscriptionAsync	Tests whether an OPC UA PubSub subscription can be successfully established. Asynchronous.
	UnsubscribeDataSetField	Unsubscribes from a dataset field specified by its integer handle.

See Also

Reference

IEasyUASubscriber Interface
OpcLabs.EasyOpc.UA.PubSub Namespace

Copyright © 2004-2024 CODE Consulting and Development, s.r.o., Plzen. All rights reserved. Web page: www.opclabs.com

Send Documentation Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.