AdsSessionBase Class

Abstract base class for ADS Sessions.

Inheritance Hierarchy

SystemObject
  TwinCATSession
    TwinCAT.AdsAdsSessionBase
      TwinCAT.AdsAdsSession

Namespace: TwinCAT.Ads
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470

Syntax

C#

public abstract class AdsSessionBase : Session, 
    IAdsSession, ISession, IConnectionStateProvider, ISymbolServerProvider

The AdsSessionBase type exposes the following members.

Constructors

 

Name

Description

AdsSessionBase Class 1:

AdsSessionBase

Initializes a new instance of the AdsSessionBase class.

Properties

 

Name

Description

AdsSessionBase Class 2:

Address

Gets the target address of the AdsSessionBase

AdsSessionBase Class 3:

AddressSpecifier

Gets the communication endpoint address string representation.
(Inherited from Session)

AdsSessionBase Class 4:

Configuration

Gets the logger interface or null.

AdsSessionBase Class 5:

Connection

Gets the connection.

AdsSessionBase Class 6:

AdsSessionBase Class 7:

ConnectionState

Gets the current Connection state of the Session
(Inherited from Session)

AdsSessionBase Class 8:

Disposed

Gets a value indicating whether this Session is disposed.
(Inherited from Session)

AdsSessionBase Class 9:

EstablishedAt

Gets the UTC time when the session was established.
(Inherited from Session)

AdsSessionBase Class 10:

Id

Gets the Session Identifier
(Inherited from Session)

AdsSessionBase Class 11:

IsConnected

Gets a value indicating whether this instance is connected.
(Inherited from Session)

Logger

Gets the actual used logger or null.

AdsSessionBase Class 12:

LoggerFactory

Gets the logger factory.

AdsSessionBase Class 13:

Name

Gets the name of the session
(Inherited from Session)

AdsSessionBase Class 14:

NetId

Gets the NetId of the Session

AdsSessionBase Class 15:

Owner

Gets the Session owner.

AdsSessionBase Class 16:

Port

Gets the Ams Port of the Session

AdsSessionBase Class 17:

Settings

Gets the settings.

AdsSessionBase Class 18:

Statistics

Gets the Communication / Session statistics.

AdsSessionBase Class 19:

SymbolServer

Gets the symbol server.
(Inherited from Session)

Methods

 

Name

Description

AdsSessionBase Class 20:

Close

Closes this ISession
(Inherited from Session)

AdsSessionBase Class 21:

Connect

Connects the session.
(Inherited from Session)

AdsSessionBase Class 22:

ConnectAndWaitAsync

Connects the session.
(Inherited from Session)

AdsSessionBase Class 23:

ConnectAsync

Connects the session.
(Inherited from Session)

AdsSessionBase Class 24:

Disconnect

Disconnects the session from the target.
(Inherited from Session)

AdsSessionBase Class 25:

Dispose

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from Session)

AdsSessionBase Class 26:

Dispose(Boolean)

Releases unmanaged and - optionally - managed resources.
(Overrides SessionDispose(Boolean))

AdsSessionBase Class 27:

EnsureConnection

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

AdsSessionBase Class 28:

Equals

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

AdsSessionBase Class 29:

Finalize

Finalizes an instance of the AdsSessionBase class.
(Overrides ObjectFinalize)

AdsSessionBase Class 30:

GetHashCode

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

AdsSessionBase Class 31:

GetSessionName

Gets the name/string identifier of the session.
(Overrides SessionGetSessionName)

AdsSessionBase Class 32:

GetType

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

AdsSessionBase Class 33:

MemberwiseClone

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

AdsSessionBase Class 34:

OnConnect

Handler function connecting the Session.
(Overrides SessionOnConnect(Boolean))

AdsSessionBase Class 35:

OnConnectAndWaitAsync

Handler function connecting the Session.
(Overrides SessionOnConnectAndWaitAsync(Boolean, CancellationToken))

AdsSessionBase Class 36:

OnConnectAsync

Handler function connecting the Session.
(Overrides SessionOnConnectAsync(Boolean, CancellationToken))

AdsSessionBase Class 37:

OnConnectionStateChanged

Handles the [E:ConnectionStateChanged] event.
(Inherited from Session)

AdsSessionBase Class 38:

OnCreateSymbolServer

Handler function creating the symbol server object.
(Overrides SessionOnCreateSymbolServer)

AdsSessionBase Class 39:

OnDisconnect

Handler function disconnecting the session.
(Overrides SessionOnDisconnect)

AdsSessionBase Class 40:

OnGetAddress

Handler function getting the address of the session.
(Overrides SessionOnGetAddress)

AdsSessionBase Class 41:

ToString

Returns a String that represents this instance.
(Inherited from Session)

Events

 

Name

Description

AdsSessionBase Class 42:

AdsSessionBase Class 43:

ConnectionStateChanged

Occurs when connection status of the IConnectionStateProvider has been changed.
(Inherited from Session)

Fields

 

Name

Description

connection

The (established) connection
(Inherited from Session)

Reference

TwinCAT.Ads Namespace

Beckhoff Automation GmbH & Co. KG 2001-2026