IAdsConnection Interface

ADS Connection interface

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

Syntax

C#

public interface IAdsConnection : IConnection, 
    IConnectionStateProvider, IAdsNotifications, IAdsAnyAccess, IAdsHandleAccess, ITcAdsRpcInvoke

VB

Public Interface IAdsConnection
    Inherits IConnection, IConnectionStateProvider, IAdsNotifications, IAdsAnyAccess, 
    IAdsHandleAccess, ITcAdsRpcInvoke

The IAdsConnection type exposes the following members.

Properties

 

Name

Description

IAdsConnection Interface 1:

Address

Gets the AmsAddress of the ADS server.

IAdsConnection Interface 2:

ClientAddress

Get the AmsAddress of the ADS client.

IAdsConnection Interface 3:

IAdsConnection Interface 4:

ConnectionState

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

IAdsConnection Interface 5:

Id

Gets the Connection Identifier . (Inherited from IConnection.)

IAdsConnection Interface 6:

IsConnected

Gets a value indicating whether the local ADS port was opened successfully. It does not indicate if the target port is available. Use the method ReadState to determine if the target port is available. (Inherited from IConnection.)

IAdsConnection Interface 7:

IsLocal

Gets a value indicating whether the ADS client is connected to a ADS Server on the local computer.

IAdsConnection Interface 8:

Session

Gets the session that initiated this IConnection (Inherited from IConnection.)

IAdsConnection Interface 9:

Timeout

Gets the timeout (in milliseconds) (Inherited from IConnection.)

Methods

 

Name

Description

IAdsConnection Interface 10:

AddDeviceNotification(String, AdsStream, AdsTransMode, Int32, Int32, Object)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event. (Inherited from IAdsNotifications.)

IAdsConnection Interface 11:

AddDeviceNotification(UInt32, UInt32, AdsStream, AdsTransMode, Int32, Int32, Object)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event. (Inherited from IAdsNotifications.)

IAdsConnection Interface 12:

AddDeviceNotification(String, AdsStream, Int32, Int32, AdsTransMode, Int32, Int32, Object)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event. (Inherited from IAdsNotifications.)

IAdsConnection Interface 13:

AddDeviceNotification(UInt32, UInt32, AdsStream, Int32, Int32, AdsTransMode, Int32, Int32, Object)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event. (Inherited from IAdsNotifications.)

IAdsConnection Interface 14:

AddDeviceNotificationEx(String, AdsTransMode, Int32, Int32, Object, Type)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event. (Inherited from IAdsNotifications.)

IAdsConnection Interface 15:

AddDeviceNotificationEx(String, AdsTransMode, Int32, Int32, Object, Type, .Int32.)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event. (Inherited from IAdsNotifications.)

IAdsConnection Interface 16:

AddDeviceNotificationEx(UInt32, UInt32, AdsTransMode, Int32, Int32, Object, Type)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event. (Inherited from IAdsNotifications.)

IAdsConnection Interface 17:

AddDeviceNotificationEx(UInt32, UInt32, AdsTransMode, Int32, Int32, Object, Type, .Int32.)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event. If type is a string type, the first element of the parameter args specifies the number of characters of the string. If type is an array type, the number of elements for each dimension has to be specified in the parameter args. At the moment only 1 dimensional Arrays are supported. (Inherited from IAdsNotifications.)

IAdsConnection Interface 18:

Close

Closes this IConnection (Inherited from IConnection.)

IAdsConnection Interface 19:

Connect

(Re)Connects the IConnection when disconnected. (Inherited from IConnection.)

IAdsConnection Interface 20:

CreateVariableHandle

Generates a unique handle for an ADS variable. (Inherited from IAdsHandleAccess.)

IAdsConnection Interface 21:

DeleteDeviceNotification

Deletes an existing notification. (Inherited from IAdsNotifications.)

IAdsConnection Interface 22:

DeleteVariableHandle

Releases the handle of a ADS variable again. (Inherited from IAdsHandleAccess.)

IAdsConnection Interface 23:

Disconnect

Disconnects this IConnection. (Inherited from IConnection.)

IAdsConnection Interface 24:

InvokeRpcMethod(String, Int32, .Object.)

Invokes the specified RPC Method (Inherited from ITcAdsRpcInvoke.)

IAdsConnection Interface 25:

InvokeRpcMethod(String, String, .Object.)

Invokes the specified RPC Method (Inherited from ITcAdsRpcInvoke.)

IAdsConnection Interface 26:

InvokeRpcMethod(ITcAdsSymbol, Int32, .Object.)

Invokes the specified RPC Method (Inherited from ITcAdsRpcInvoke.)

IAdsConnection Interface 27:

InvokeRpcMethod(ITcAdsSymbol, String, .Object.)

Invokes the specified RPC Method. (Inherited from ITcAdsRpcInvoke.)

IAdsConnection Interface 28:

Read(Int32, AdsStream)

Reads data synchronously from an ADS device and writes it to the given stream. (Inherited from IAdsHandleAccess.)

IAdsConnection Interface 29:

Read(Int32, AdsStream, Int32, Int32)

Reads data synchronously from an ADS device and writes it to the given stream. (Inherited from IAdsHandleAccess.)

IAdsConnection Interface 30:

ReadAny(Int32, Type)

Reads data synchronously from an ADS device and writes it to an object. (Inherited from IAdsAnyAccess.)

IAdsConnection Interface 31:

ReadAny(Int32, Type, .Int32.)

Reads data synchronously from an ADS device and writes it to an object. (Inherited from IAdsAnyAccess.)

IAdsConnection Interface 32:

ReadAny(UInt32, UInt32, Type)

Reads data synchronously from an ADS device and writes it to an object. (Inherited from IAdsAnyAccess.)

IAdsConnection Interface 33:

ReadAny(UInt32, UInt32, Type, .Int32.)

Reads data synchronously from an ADS device and writes it to an object. (Inherited from IAdsAnyAccess.)

IAdsConnection Interface 34:

ReadAnyString(Int32, Int32, Encoding)

Reads the string. (Inherited from IAdsAnyAccess.)

IAdsConnection Interface 35:

ReadAnyString(UInt32, UInt32, Int32, Encoding)

Reads the string (Inherited from IAdsAnyAccess.)

IAdsConnection Interface 36:

ReadDeviceInfo

Reads the identification and version number of an ADS server.

IAdsConnection Interface 37:

ReadWrite

Writes data synchronously to an ADS device and then Reads data from this device. (Inherited from IAdsHandleAccess.)

IAdsConnection Interface 38:

TryAddDeviceNotification

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event. (Inherited from IAdsNotifications.)

IAdsConnection Interface 39:

TryAddDeviceNotificationEx

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event. (Inherited from IAdsNotifications.)

IAdsConnection Interface 40:

TryDeleteDeviceNotification

Deletes an existing notification. (Inherited from IAdsNotifications.)

IAdsConnection Interface 41:

TryInvokeRpcMethod(String, Int32, .Object., Object.)

Invokes the specified RPC Method (Inherited from ITcAdsRpcInvoke.)

IAdsConnection Interface 42:

TryInvokeRpcMethod(String, String, .Object., Object.)

Invokes the specified RPC Method (Inherited from ITcAdsRpcInvoke.)

IAdsConnection Interface 43:

TryInvokeRpcMethod(ITcAdsSymbol, Int32, .Object., Object.)

Invokes the specified RPC Method (Inherited from ITcAdsRpcInvoke.)

IAdsConnection Interface 44:

TryInvokeRpcMethod(ITcAdsSymbol, String, .Object., Object.)

Invokes the specified RPC Method. (Inherited from ITcAdsRpcInvoke.)

IAdsConnection Interface 45:

TryRead

Reads data synchronously from an ADS device and writes it to the given stream. (Inherited from IAdsHandleAccess.)

IAdsConnection Interface 46:

TryReadWrite

Writes data synchronously to an ADS device and then Reads data from this device. (Inherited from IAdsHandleAccess.)

IAdsConnection Interface 47:

TryWrite

Writes data synchronously to an ADS device. (Inherited from IAdsHandleAccess.)

IAdsConnection Interface 48:

Write(Int32, AdsStream)

Writes data synchronously to an ADS device. (Inherited from IAdsHandleAccess.)

IAdsConnection Interface 49:

Write(Int32, AdsStream, Int32, Int32)

Writes data synchronously to an ADS device. (Inherited from IAdsHandleAccess.)

IAdsConnection Interface 50:

WriteAny(Int32, Object)

Writes an object synchronously to an ADS device. (Inherited from IAdsAnyAccess.)

IAdsConnection Interface 51:

WriteAny(Int32, Object, .Int32.)

Writes an object synchronously to an ADS device. If the Type of the object to be written is a string type, the first element of parameter args specifies the number of characters of the string. (Inherited from IAdsAnyAccess.)

IAdsConnection Interface 52:

WriteAny(UInt32, UInt32, Object)

Writes an object synchronously to an ADS device. (Inherited from IAdsAnyAccess.)

IAdsConnection Interface 53:

WriteAny(UInt32, UInt32, Object, .Int32.)

Writes an object synchronously to an ADS device. (Inherited from IAdsAnyAccess.)

Events

 

Name

Description

IAdsConnection Interface 54:

IAdsConnection Interface 55:

AdsNotification

Occurs when the ADS device sends a notification to the client. (Inherited from IAdsNotifications.)

IAdsConnection Interface 56:

AdsNotificationError

Occurs when a exception has occurred during notification management. (Inherited from IAdsNotifications.)

IAdsConnection Interface 57:

AdsNotificationEx

Occurs when the ADS devices sends a notification to the client. (Inherited from IAdsNotifications.)

IAdsConnection Interface 58:

IAdsConnection Interface 59:

ConnectionStateChanged

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

Extension Methods

 

Name

Description

IAdsConnection Interface 60:

IAdsConnection Interface 61:

PollAdsState(IObservable.Unit.)

Overloaded.

Gets an observable sequence of AdsStates via Polling. (Defined by AdsClientExtensions.)

IAdsConnection Interface 62:

IAdsConnection Interface 63:

PollAdsState(TimeSpan)

Overloaded.

Gets an observable sequence of AdsStates via Polling. (Defined by AdsClientExtensions.)

IAdsConnection Interface 64:

PollValues(String, Type, IObservable.Unit.)

Overloaded.

Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)

IAdsConnection Interface 65:

PollValues(String, Type, TimeSpan)

Overloaded.

Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)

IAdsConnection Interface 66:

PollValues(String, Type, .Int32., TimeSpan)

Overloaded.

Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)

IAdsConnection Interface 67:

PollValues(String, Type, IObservable.Unit., Func.Exception, Object.)

Overloaded.

Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)

IAdsConnection Interface 68:

PollValues(String, Type, TimeSpan, Func.Exception, Object.)

Overloaded.

Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)

IAdsConnection Interface 69:

PollValues(String, Type, .Int32., IObservable.Unit., Func.Exception, Object.)

Overloaded.

Polls the symbol values on time points where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)

IAdsConnection Interface 70:

PollValues(String, Type, .Int32., TimeSpan, Func.Exception, Object.)

Overloaded.

Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)

IAdsConnection Interface 71:

PollValues.T.(String, IObservable.Unit.)

Overloaded.

Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)

IAdsConnection Interface 72:

PollValues.T.(String, TimeSpan)

Overloaded.

Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)

IAdsConnection Interface 73:

PollValues.T.(String, IObservable.Unit., Func.Exception, T.)

Overloaded.

Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)

IAdsConnection Interface 74:

PollValues.T.(String, TimeSpan, Func.Exception, T.)

Overloaded.

Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)

IAdsConnection Interface 75:

PollValues.T.(String, .Int32., IObservable.Unit.)

Overloaded.

Polls the symbol values on time points where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)

IAdsConnection Interface 76:

IAdsConnection Interface 77:

PollValues.T.(String, .Int32., TimeSpan)

Overloaded.

Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)

IAdsConnection Interface 78:

PollValues.T.(String, .Int32., IObservable.Unit., Func.Exception, T.)

Overloaded.

Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)

IAdsConnection Interface 79:

IAdsConnection Interface 80:

PollValues.T.(String, .Int32., TimeSpan, Func.Exception, T.)

Overloaded.

Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)

IAdsConnection Interface 81:

WhenNotification(ISymbol)

Overloaded.

Gets an observable sequence of Notifications. (Defined by AdsClientExtensions.)

IAdsConnection Interface 82:

IAdsConnection Interface 83:

WhenNotification(ISymbolCollection)

Overloaded.

Gets an observable sequence of Notification objects. (Defined by AdsClientExtensions.)

IAdsConnection Interface 84:

WhenNotification(ISymbol, NotificationSettings)

Overloaded.

Gets an observable sequence of Notifications. (Defined by AdsClientExtensions.)

IAdsConnection Interface 85:

IAdsConnection Interface 86:

WhenNotification(ISymbolCollection, NotificationSettings)

Overloaded.

Gets an observable sequence of Notification objects. (Defined by AdsClientExtensions.)

IAdsConnection Interface 87:

IAdsConnection Interface 88:

WhenValueChanged

Observable sequence of Values driven by ADS Notifications on the specified symbol. (Defined by ValueSymbolExtensions.)

IAdsConnection Interface 89:

IAdsConnection Interface 90:

WriteValues.T.(String, IObservable.T.)

Overloaded.

Writes the sequence of values to the symbol specified by the instance path. (Defined by AnyTypeExtensions.)

IAdsConnection Interface 91:

IAdsConnection Interface 92:

WriteValues.T.(String, IObservable.T., Action.Exception.)

Overloaded.

Writes the sequence of values to the symbol specified by the instance path. (Defined by AnyTypeExtensions.)

Remarks

The ADS connection interface represents the the logical point-to-point exception between Client and Server within an ADS Session.

Reference

TwinCAT.Ads Namespace

TwinCAT.IConnection

TwinCAT.Ads.IAdsAnyAccess

TwinCAT.Ads.IAdsHandleAccess