SessionListener Class

Represents a listener to observe the connections of the TwinCAT HMI server. This class cannot be inherited.

Inheritance Hierarchy

SystemObject
  Listener
    TcHmiSrv.Core.ListenersSessionListener

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

Syntax

C#

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

The SessionListener type exposes the following members.

Constructors

 

Name

Description

SessionListener Class 1:

SessionListener

Initializes a new instance of the SessionListener class.

Properties

 

Name

Description

SessionListener Class 2:

Type

Gets the type of the SessionListener.
(Overrides Listener.Type)

Methods

 

Name

Description

SessionListener Class 3:

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

SessionListener Class 4:

GetHashCode

Serves as the default hash function.
(Inherited from Object)

SessionListener Class 5:

GetType

Gets the Type of the current instance.
(Inherited from Object)

SessionListener Class 6:

ToString

Returns a string that represents the current object.
(Inherited from Object)

Events

 

Name

Description

SessionListener Class 7:

OnCloseSession

Called when a session is closed.

SessionListener Class 8:

OnCloseSessionAsync

Called when a session is closed.

SessionListener Class 9:

OnCloseWebSocket

Called when an existing WebSocket connection is closed.

SessionListener Class 10:

OnCloseWebSocketAsync

Called when an existing WebSocket connection is closed.

SessionListener Class 11:

OnCreateSession

Called when a new session is created.

SessionListener Class 12:

OnCreateSessionAsync

Called when a new session is created.

SessionListener Class 13:

OnCreateWebSocket

Called when a new WebSocket connection is created.

SessionListener Class 14:

OnCreateWebSocketAsync

Called when a new WebSocket connection is created.

SessionListener Class 15:

OnLogin

Called when a user is logged in.

SessionListener Class 16:

OnLoginAsync

Called when a user is logged in.

SessionListener Class 17:

OnLogout

Called when a user is logged out.

SessionListener Class 18:

OnLogoutAsync

Called when a user is logged out.

Version Information

Supported in: 3.1.7447.0, 2.3.7447.0, 1.10.7447.0

Reference

TcHmiSrv.Core.Listeners Namespace

Copyright © Beckhoff Automation GmbH & Co. KG