IAdsSession Interface

Interface IAdsSession

Namespace:  TwinCAT.Ads
Assembly:  TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 4.3.0.0

Syntax

C#

public interface IAdsSession : ISession, 
    IConnectionStateProvider

VB

Public Interface IAdsSession
    Inherits ISession, IConnectionStateProvider

The IAdsSession type exposes the following members.

Properties

 

Name

Description

Address

Gets the Address specifier of the Session / connection

AddressSpecifier

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

Connection

Gets the Connection object. (Inherited from ISession.)

ConnectionState

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

EstablishedAt

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

Id

Gets the Session Id (Inherited from ISession.)

IsConnected

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

NetId

Gets the NetId of the Session

Owner

Gets the Session owner.

Port

Gets the Ams Port of the Session

Methods

 

Name

Description

Close

Closes this ISession (Inherited from ISession.)

Connect

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

Disconnect

Disconnects the ISession (Inherited from ISession.)

Events

 

Name

Description

ConnectionStateChanged

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

Reference

TwinCAT.Ads Namespace

TwinCAT.ISession