SubscriptionListener Class

Represents a listener to get notified when a client opens or closes a subscription.
If this listener is not registered at the TwinCAT HMI server, subscriptions will just call the OnRequest event.
This class cannot be inherited.

Inheritance Hierarchy

SystemObject
Listener
TcHmiSrv.Core.ListenersSubscriptionListener

Namespace: TcHmiSrv.Core.Listeners
Assembly: TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 3.1.7447.0+85f9b473a1dd11b8f3e5c9a182fd1901975e46f9

Syntax

C#

public sealed class SubscriptionListener : Listener, 
    IExternalCaller<string>, IAsyncExternalCaller<string>

The SubscriptionListener type exposes the following members.

Constructors

	Name	Description
	SubscriptionListener	Initializes a new instance of the SubscriptionListener class.

Properties

	Name	Description
	Type	Gets the type of the SubscriptionListener. (Overrides Listener.Type)

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Events

	Name	Description
	OnSubscribe	Called when a client opens a new subscription. The subscription will call the OnRequest once per specified interval.
	OnSubscribeAsync	Called when a client opens a new subscription. The subscription will call the OnRequest once per specified interval.
	OnUnsubscribe	Called when a client closes a subscription.
	OnUnsubscribeAsync	Called when a client closes a subscription.

Version Information

Supported in: 3.1.7447.0, 2.3.7447.0, 1.10.7447.0

Reference

TcHmiSrv.Core.Listeners Namespace

Weiterführende Informationen