Session Class

Abstract Session base class.

Inheritance Hierarchy

System.Object
  TwinCAT.Session
    TwinCAT.Ads.AdsSessionBase
Namespace:  TwinCAT
Assembly:  TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 6.0.328+39e3229

Syntax

C#

public abstract class Session : ISession, 
    IConnectionStateProvider, ISymbolServerProvider, IDisposable

The Session type exposes the following members.

Properties

 

Name

Description

Session Class 1:

AddressSpecifier

Gets the communication endpoint address string representation.

Session Class 2:

Connection

Gets the (established) connection.

Session Class 3:

Session Class 4:

ConnectionState

Gets the current Connection state of the Session

Session Class 5:

Disposed

Gets a value indicating whether this Session is disposed.

Session Class 6:

EstablishedAt

Gets the UTC time when the session was established.

Session Class 7:

Id

Gets the Session Identifier

Session Class 8:

IsConnected

Gets a value indicating whether this instance is connected.

Session Class 9:

Name

Gets the name of the session

Session Class 10:

SymbolServer

Gets the symbol server.

Methods

 

Name

Description

Session Class 11:

Close

Closes this ISession

Session Class 12:

Connect

Connects the session.

Session Class 13:

ConnectAsync

Connects the session.

Session Class 14:

Disconnect

Disconnects the session from the target.

Session Class 15:

Dispose.

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Session Class 16:

Dispose(Boolean)

Releases unmanaged and - optionally - managed resources.

Session Class 17:

EnsureConnection

Ensures, that the ISession is connected and returns the IConnection object.

Session Class 18:

Equals

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

Session Class 19:

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)

Session Class 20:

GetHashCode

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

Session Class 21:

GetSessionName

Gets the name/string identifier of the session.

Session Class 22:

GetType

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

Session Class 23:

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

Session Class 24:

OnConnect

Handler function connecting the Session.

Session Class 25:

OnConnectAsync

Handler function connecting the Session.

Session Class 26:

OnConnectionStateChanged

Handles the [E:ConnectionStateChanged] event.

Session Class 27:

OnCreateSymbolServer

Handler function creating the ISymbolServer

Session Class 28:

OnDisconnect

Handler function disconnecting the session.

Session Class 29:

OnGetAddress

Handler function getting the address of the session.

Session Class 30:

ToString

Returns a String that represents this instance. (Overrides Object.ToString..)

Events

 

Name

Description

Session Class 31:

Session Class 32:

ConnectionStateChanged

Occurs when connection status of the IConnectionStateProvider has been changed.

Reference

TwinCAT Namespace

TwinCAT.ISession

System.IDisposable