IAdsSession Interface

Interface IAdsSession

Namespace:  TwinCAT.Ads
Assembly:  TwinCAT.Ads.Abstractions (in TwinCAT.Ads.Abstractions.dll) Version: 6.0.328+39e3229

Syntax

C#

public interface IAdsSession : ISession, 
    IConnectionStateProvider, ISymbolServerProvider

The IAdsSession type exposes the following members.

Properties

 

Name

Description

IAdsSession Interface 1:

Address

Gets the Address specifier of the Session / connection

IAdsSession Interface 2:

AddressSpecifier

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

IAdsSession Interface 3:

Connection

Gets the Connection object. (Inherited from ISession.)

IAdsSession Interface 4:

IAdsSession Interface 5:

ConnectionState

Gets the current Connection state of the IConnectionStateProvider (Inherited from IConnectionStateProvider.)

IAdsSession Interface 6:

EstablishedAt

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

IAdsSession Interface 7:

Id

Gets the Session Id (Inherited from ISession.)

IAdsSession Interface 8:

IsConnected

Gets a value indicating whether the session is connected. (Inherited from ISession.)

IAdsSession Interface 9:

NetId

Gets the NetId of the Session

IAdsSession Interface 10:

Owner

Gets the Session owner.

IAdsSession Interface 11:

Port

Gets the Ams Port of the Session

IAdsSession Interface 12:

Provider

Gets the Session Provider (Inherited from ISession.)

IAdsSession Interface 13:

SymbolServer

Gets the symbol server. (Inherited from ISymbolServerProvider.)

Methods

 

Name

Description

IAdsSession Interface 14:

Close

Closes this ISession (Inherited from ISession.)

IAdsSession Interface 15:

Connect

Connects the session and returns the established IConnection object. (Inherited from ISession.)

IAdsSession Interface 16:

ConnectAsync

Connects the session and returns the established IConnection object. (Inherited from ISession.)

IAdsSession Interface 17:

Disconnect

Disconnects the ISession (Inherited from ISession.)

IAdsSession Interface 18:

EnsureConnection

Ensures, that the ISession is connected and returns the IConnection object. (Inherited from ISession.)

Events

 

Name

Description

IAdsSession Interface 19:

IAdsSession Interface 20:

ConnectionStateChanged

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

Reference

TwinCAT.Ads Namespace

TwinCAT.ISession