AdsClient Class

Inheritance Hierarchy

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

C#

public sealed class AdsClient : IAdsDisposableConnection, 
    IAdsConnectAddress, IAdsConnection, IConnection, IConnectionStateProvider, IAdsNotifications, 
    IAdsSymbolicAccess, IAdsAnyAccess, IAdsHandle, IAdsReadWrite2, IAdsReadWrite, 
    IAdsStateProvider, IAdsStateControl, IAdsSymbolChangedProvider, IAdsRpcInvoke, IRouterNotificationProvider, 
    IDisposable

The AdsClient type exposes the following members.

Constructors

	Name	Description
	AdsClient.	Initializes a new instance of the AdsClient class.
	AdsClient(AdsClientSettings)	Initializes a new instance of the AdsClient class with the specified settings.
	AdsClient(ILogger)	Initializes a new instance of the AdsClient class.
	AdsClient(ISession, ILogger)	Initializes a new instance of the AdsClient class bound to a session.
	AdsClient(ISession, AdsClientSettings, ILogger)	Initializes a new instance of the AdsClient class.

Properties

	Name	Description
	Address	Gets the target AmsAddress of of the established ADS connection (Destination side).
	ClientAddress	Get the client AmsAddress (Source side).
	DefaultValueEncoding	Gets the default value encoding.
	Id	Gets the AdsClient Identifier.
	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.
	IsDisposed	Gets a value indicating whether this instance is disposed.
	IsLocal	Gets a value indicating whether the ADS client is connected to a ADS Server on the local computer.
	Logger	Gets the logger inteface.
	Session	Gets the session that initiated this IConnection
	SymbolEncoding	Gets the symbol encoding.
	Timeout	Sets the timeout for the ads communication. Unit is in ms.

Methods

	Name	Description
	AddDeviceNotification(String, Int32, NotificationSettings, Object)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.
	AddDeviceNotification(UInt32, UInt32, Int32, NotificationSettings, Object)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.
	AddDeviceNotificationAsync(String, Int32, NotificationSettings, Object, CancellationToken)	Connects a variable to the ADS client asynchronously. The ADS client will be notified by the AdsNotification event.
	AddDeviceNotificationAsync(UInt32, UInt32, Int32, NotificationSettings, Object, CancellationToken)	Adds a device notification as an asynchronous operation.
	AddDeviceNotificationEx(String, NotificationSettings, Object, Type)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.
	AddDeviceNotificationEx(String, NotificationSettings, Object, Type, .Int32.)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.
	AddDeviceNotificationEx(UInt32, UInt32, NotificationSettings, Object, Type)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.
	AddDeviceNotificationEx(UInt32, UInt32, NotificationSettings, 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. Only primitive ('AnyType') types are allowed for the parameter type.
	AddDeviceNotificationExAsync(String, NotificationSettings, Object, Type, .Int32., CancellationToken)	Connects a variable to the ADS client asynchronously. The ADS client will be notified by the AdsNotificationEx event.
	AddDeviceNotificationExAsync(UInt32, UInt32, NotificationSettings, Object, Type, .Int32., CancellationToken)	Connects a variable to the ADS client asynchronously. The ADS client will be notified by the AdsNotificationEx event.
	CleanupSymbolTable	Clears the internal symbol cache.
	Close	Closes this AdsClient
	Connect(AmsAddress)	Connects the target
	Connect(AmsPort)	Connects to the local target ADS Device.
	Connect(Int32)	Connects to the local target ADS Device.
	Connect(AmsNetId, Int32)	Connects to the target ADS Device.
	Connect(AmsNetId, AmsPort)	Connects to the target ADS Device.
	Connect(String, Int32)	Connects to the target ADS Device.
	ConnectAndWaitAsync	Connects to the target address and waits until the AdsClient is disconnected asynchronously.
	CreateVariableHandle	Determines the Symbol handle by its instance path synchronously.
	CreateVariableHandleAsync	Determines the Symbol handle by its instance path asynchronously.
	DeleteDeviceNotification	Deletes a registered notification.
	DeleteDeviceNotificationAsync	Deletes a registered notification asynchronously.
	DeleteVariableHandle	Releases the specified symbol/variable handle synchronously.
	DeleteVariableHandleAsync	Releases the specified symbol/variable handle asynchronously.
	Disconnect	Disconnects this AdsClient from the local ADS router.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Finalizes an instance of the AdsClient class. (Overrides Object.Finalize..)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InvokeRpcMethodAsync(IRpcCallableInstance, IRpcMethod, .Object., CancellationToken)	invoke RPC method as an asynchronous operation.
	InvokeRpcMethodAsync(String, String, .Object., CancellationToken)	Invokes the specified RPC Method asynchronously
	InvokeRpcMethodAsync(IRpcCallableInstance, IRpcMethod, .Object., .AnyTypeSpecifier., AnyTypeSpecifier, CancellationToken)	invoke RPC method as an asynchronous operation.
	InvokeRpcMethodAsync(String, String, .Object., .AnyTypeSpecifier., AnyTypeSpecifier, CancellationToken)	Invokes the specified RPC Method asynchronously
	Read(UInt32, Memory.Byte.)	Reads data synchronously from an ADS device and writes to the specified readBuffer.
	Read(UInt32, UInt32, Memory.Byte.)	Reads data synchronously from an ADS device and writes it to the given readBuffer
	ReadAny(UInt32, Type)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAny(UInt32, Type, .Int32.)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAny(UInt32, UInt32, Type)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAny(UInt32, UInt32, Type, .Int32.)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAny.T.(UInt32)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAny.T.(UInt32, .Int32.)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAny.T.(UInt32, UInt32)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAny.T.(UInt32, UInt32, .Int32.)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAnyAsync(UInt32, Type, CancellationToken)	Reads the value of an Anytype (Primitive type) asynchronously.
	ReadAnyAsync(UInt32, Type, .Int32., CancellationToken)	Reads the value of an Anytype (Primitive type) asynchronously.
	ReadAnyAsync(UInt32, UInt32, Type, CancellationToken)	Reads the value of an Anytype (Primitive type) asynchronously.
	ReadAnyAsync(UInt32, UInt32, Type, .Int32., CancellationToken)	Reads the value of an Anytype (Primitive type) asynchronously.
	ReadAnyAsync.T.(UInt32, CancellationToken)	Reads data synchronously from an ADS device.
	ReadAnyAsync.T.(UInt32, .Int32., CancellationToken)	Reads data asynchronously from an ADS device and writes it to an object.
	ReadAnyAsync.T.(UInt32, UInt32, CancellationToken)	Reads data asynchronously from an ADS device and writes it to an object.
	ReadAnyAsync.T.(UInt32, UInt32, .Int32., CancellationToken)	Reads data asynchronously from an ADS device and writes it to an object.
	ReadAnyString(UInt32, Int32, Encoding)	Reads a string from the specified symbol/variable.
	ReadAnyString(UInt32, UInt32, Int32, Encoding)	Reads as string from a specified address.
	ReadAnyStringAsync(UInt32, Int32, Encoding, CancellationToken)	Reads a string asynchronously from the specified symbol/variable
	ReadAnyStringAsync(UInt32, UInt32, Int32, Encoding, CancellationToken)	Reads a string from a specified address asynchronously.
	ReadAsync(UInt32, Memory.Byte., CancellationToken)	Reads the value data of the symbol asynchronously into the readBuffer.
	ReadAsync(UInt32, UInt32, Memory.Byte., CancellationToken)	Reads the data asynchronously from specified IndexGroup/IndexOffset
	ReadDataType	Call this method to obtain information about the specified data type.
	ReadDataTypeAsync	read data type as an asynchronous operation.
	ReadDeviceInfo	Reads the identification and version number of an ADS server.
	ReadDeviceInfoAsync	Reads the identification and version number of an ADS server.
	ReadState	Reads the ADS status and the device status from an ADS server.
	ReadStateAsync	Reads the ADS status and the device status from an ADS server.
	ReadSymbol	Call this method to obtain information about the individual symbols (variables) in ADS devices.
	ReadSymbolAsync	Call this method to obtain information about the individual symbols (variables) in ADS devices.
	ReadValue(ISymbol)	Reads the value of a symbol and returns it as an object.
	ReadValue(String, Type)	Reads the value of a symbol and returns the value as object. The parameter type must have the same layout as the ADS symbol.
	ReadValue.T.(ISymbol)	Reads the value of a symbol and returns it as an object.
	ReadValue.T.(String)	Reads the value of a symbol and returns the value. The parameter type must have the same layout as the ADS symbol.
	ReadValueAsync(ISymbol, CancellationToken)	Reads the value of a symbol asynchronously and returns it as an object. Strings and all primitive data types (UInt32, Int32, Bool etc.) are supported. Arrays and structures cannot be read.
	ReadValueAsync(String, Type, CancellationToken)	Reads the value of a symbol asynchronously.
	ReadValueAsync.TValue.(ISymbol, CancellationToken)	Reads the value of a symbol asynchronously and returns it as an object.
	ReadValueAsync.TValue.(String, CancellationToken)	Reads the value of a symbol asynchronously.
	ReadWrite(UInt32, Memory.Byte., ReadOnlyMemory.Byte.)	Writes data synchronously to an ADS device and then Reads data from that target.
	ReadWrite(UInt32, UInt32, Memory.Byte., ReadOnlyMemory.Byte.)	Writes data synchronously to an ADS device and then Reads data from this device into the readBuffer
	ReadWriteAsync(UInt32, Memory.Byte., ReadOnlyMemory.Byte., CancellationToken)	ReadWrites value data asynchronously to/from the symbol represented by the variableHandle.
	ReadWriteAsync(UInt32, UInt32, Memory.Byte., ReadOnlyMemory.Byte., CancellationToken)	Read/Writes data asynchronously to/from the specified writeBuffer, readBuffer
	RegisterAdsStateChangedAsync	Registers for AdsStateChanged events as an asynchronous operation.
	RegisterSymbolVersionChanged	Registers for an AdsSymbolVersionChanged event as an asynchronous operation.
	RegisterSymbolVersionChangedAsync	Registers for an AdsSymbolVersionChanged event as an asynchronous operation.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryAddDeviceNotification(String, Int32, NotificationSettings, Object, UInt32.)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.
	TryAddDeviceNotification(UInt32, UInt32, Int32, NotificationSettings, Object, UInt32.)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.
	TryAddDeviceNotificationEx(String, NotificationSettings, Object, Type, .Int32., UInt32.)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.
	TryAddDeviceNotificationEx(UInt32, UInt32, NotificationSettings, Object, Type, .Int32., UInt32.)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.
	TryCreateVariableHandle	Determines the Symbol handle by its instance path synchronously.
	TryDeleteDeviceNotification(UInt32)	Deletes a registered notification.
	TryDeleteDeviceNotification(UInt32, Int32)	Deletes a registered notification.
	TryDeleteVariableHandle	Releases the specified symbol/variable handle synchronously.
	TryInvokeRpcMethod(String, String, .Object., Object.)	Invokes the specified RPC Method
	TryInvokeRpcMethod(String, String, .Object., .Object.., Object.)	Invokes the specified RPC Method
	TryInvokeRpcMethod(IRpcCallableInstance, IRpcMethod, .Object., .AnyTypeSpecifier., AnyTypeSpecifier, .Object.., Object.)	Tries the invoke RPC method.
	TryInvokeRpcMethod(String, String, .Object., .AnyTypeSpecifier., AnyTypeSpecifier, .Object.., Object.)	Invokes the RPC Method
	TryRead(UInt32, Memory.Byte., Int32.)	Reads the value synchronously data of the symbol, that is represented by the variable handle into the readBuffer.
	TryRead(UInt32, UInt32, Memory.Byte., Int32.)	Reads value data from the specified IndexGroup/IndexOffset to the specified memory location.
	TryReadDataType	Call this method to obtain information about the specified data type.
	TryReadState	Reads the ADS status and the device status from an ADS server. Unlike the ReadState method this method does not call an exception on failure. Instead an AdsErrorCode is returned. If the return value is equal to AdsErrorCode.NoError the call was successful.
	TryReadSymbol	Call this method to obtain information about the individual symbols (variables) in ADS devices.
	TryReadValue(ISymbol, Object.)	Reads the value of a symbol and returns it as an object.
	TryReadValue(String, Type, Object.)	Reads the value of a symbol and returns the value as object.
	TryReadValue.T.(ISymbol, T.)	Reads the value of a symbol and returns it as an object.
	TryReadValue.T.(String, T.)	Reads the value of a symbol and returns the value as object.
	TryReadWrite(UInt32, Memory.Byte., ReadOnlyMemory.Byte., Int32.)	ReadWrites value data synchronously to/from the symbol represented by the variableHandle.
	TryReadWrite(UInt32, UInt32, Memory.Byte., ReadOnlyMemory.Byte., Int32.)	Writes data synchronously to an ADS device and reads data from that device.
	TryResurrect	Resurrects the connection
	TryWrite(UInt32, ReadOnlyMemory.Byte.)	Writes the value data synchronously that is represented in the writeBuffer to the symbol with the specified variableHandle.
	TryWrite(UInt32, UInt32, ReadOnlyMemory.Byte.)	Writes data synchronously to an ADS device.
	TryWriteControl(StateInfo)	Changes the ADS status and the device status of an ADS server.
	TryWriteControl(StateInfo, ReadOnlyMemory.Byte.)	Changes the ADS status and the device status of an ADS server.
	TryWriteValue(ISymbol, Object)	Writes a value to the symbol. Strings and all primitive data types(UInt32, Int32, Bool etc.) are supported. Array and structures are not supported. If a string is passed as parameter, the method attempts to parse the string according to the ADS data type of the symbol.
	TryWriteValue(String, Object)	Writes the passed object value to the specified ADS symbol.The parameter type must have the same layout as the ADS symbol.
	TryWriteValue.T.(ISymbol, T)	Writes a value to the symbol. Strings and all primitive data types(UInt32, Int32, Bool etc.) are supported. If a string is passed as parameter, the method attempts to parse the string according to the ADS data type of the symbol.
	TryWriteValue.T.(String, T)	Writes the passed object value to the specified ADS symbol.The parameter type must have the same layout as the ADS symbol.
	UnregisterAdsStateChangedAsync	unregister ads state changed as an asynchronous operation.
	UnregisterSymbolVersionChanged	Unregisters the symbol version changed.
	UnregisterSymbolVersionChangedAsync	Unregisters from an AdsSymbolVersionChanged event as an asynchronous operation.
	Write(UInt32, ReadOnlyMemory.Byte.)	Writes data synchronously to an ADS device.
	Write(UInt32, UInt32)	Triggers a 'Write' call to the ADS device at the specified address.
	Write(UInt32, UInt32, ReadOnlyMemory.Byte.)	Writes data synchronously to an ADS device.
	WriteAny(UInt32, Object)	Writes an object synchronously to an ADS device.
	WriteAny(UInt32, 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.
	WriteAny(UInt32, UInt32, Object)	Writes an object synchronously to an ADS device.
	WriteAny(UInt32, UInt32, Object, .Int32.)	Writes an object synchronously to an ADS device.
	WriteAnyAsync(UInt32, Object, CancellationToken)	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.
	WriteAnyAsync(UInt32, Object, .Int32., CancellationToken)	Writes an object asynchronously 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.
	WriteAnyAsync(UInt32, UInt32, Object, CancellationToken)	Write the value of an Anytype (Primitive type) asynchronously.
	WriteAnyAsync(UInt32, UInt32, Object, .Int32., CancellationToken)	Write the value of an Anytype (Primitive type) asynchronously.
	WriteAnyStringAsync(String, String, Int32, Encoding, CancellationToken)	Writes the string (Potentially unsafe!)
	WriteAnyStringAsync(UInt32, String, Int32, Encoding, CancellationToken)	Writes the string (Potentially unsafe!)
	WriteAsync(UInt32, ReadOnlyMemory.Byte., CancellationToken)	Writes the value data asynchronously that is represented by the writeBuffer to the symbol specified by the variableHandle.
	WriteAsync(UInt32, UInt32, CancellationToken)	Triggers a write call at the specified IndexGroup/IndexOffset asynchronously.
	WriteAsync(UInt32, UInt32, ReadOnlyMemory.Byte., CancellationToken)	Writes the data / Value asynchronously into the specified writeBuffer.
	WriteControl(StateInfo)	Changes the ADS status and the device status of an ADS server.
	WriteControl(StateInfo, ReadOnlyMemory.Byte.)	Changes the ADS status and the device status of an ADS server.
	WriteControlAsync(AdsState, UInt16, CancellationToken)	Changes the ADS status and device status of the ADS server asynchronously.
	WriteControlAsync(AdsState, UInt16, ReadOnlyMemory.Byte., CancellationToken)	Writes the state asynchronously
	WriteSymbolAsync	Writes the passed object value to the specified ADS symbol.The parameter type must have the same layout as the ADS symbol.
	WriteValue(ISymbol, Object)	Writes a value to the symbol. Strings and all primitive data types(UInt32, Int32, Bool etc.) are supported. Array and structures are not supported. If a string is passed as parameter, the method attempts to parse the string according to the ADS data type of the symbol.
	WriteValue(String, Object)	Writes the passed object value to the specified ADS symbol.The parameter type must have the same layout as the ADS symbol.
	WriteValue.T.(ISymbol, T)	Writes a value to the symbol. Strings and all primitive data types(UInt32, Int32, Bool etc.) are supported. If a string is passed as parameter, the method attempts to parse the string according to the ADS data type of the symbol.
	WriteValue.T.(String, T)	Writes the passed object value to the specified ADS symbol.The parameter type must have the same layout as the ADS symbol.
	WriteValueAsync(ISymbol, Object, CancellationToken)	Writes a value to the symbol. Strings and all primitive data types(UInt32, Int32, Bool etc.) are supported. Array and structures are not supported. If a string is passed as parameter, the method attempts to parse the string according to the ADS data type of the symbol.
	WriteValueAsync.T.(ISymbol, T, CancellationToken)	Writes a value to the symbol. Strings and all primitive data types(UInt32, Int32, Bool etc.) are supported. If a string is passed as parameter, the method attempts to parse the string according to the ADS data type of the symbol.
	WriteValueAsync.T.(String, T, CancellationToken)	Writes the passed object value to the specified ADS symbol.The parameter type must have the same layout as the ADS symbol.

Events

	Name	Description
	AdsNotification	Occurs when the ADS device sends a notification to the client.
	AdsNotificationError	Occurs when a exception has occurred during notification management.
	AdsNotificationEx	Occurs when the ADS devices sends a notification to the client.
	AdsNotificationsInvalidated	Occurs when Notification Unregistrations / Invalidates are received from the AdsServer
	AdsStateChanged	Occurs when the ADS state changes.
	AdsSumNotification	Occurs when Notifications are send (bundled notifications)
	AdsSymbolVersionChanged	Occurs when the symbol version has been changed changes.
	ConnectionStateChanged	Occurs when the connection state has been changed.
	RouterStateChanged	(Local) Router state changed event.

Extension Methods

	Name	Description
	PollAdsState(IObservable.Unit.)	Overloaded. Gets an observable sequence of ResultReadAdsStates via Polling. (Defined by ConnectionStateExtension.)
	PollAdsState(IObservable.Unit.)	Overloaded. Gets an observable sequence of AdsStates via Polling. (Defined by AdsClientExtensions.)
	PollAdsState(TimeSpan)	Overloaded. Gets an observable sequence of ResultReadAdsStates via Polling. (Defined by ConnectionStateExtension.)
	PollAdsState(TimeSpan)	Overloaded. Gets an observable sequence of AdsStates via Polling. (Defined by AdsClientExtensions.)
	PollAdsState2(IObservable.Unit.)	Overloaded. Gets an observable sequence of ResultReadAdsStates via Polling. (Defined by AdsClientExtensions.)
	PollAdsState2(TimeSpan)	Overloaded. Gets an observable sequence of ResultReadAdsStates via Polling. (Defined by AdsClientExtensions.)
	PollAdsState2Async(IObservable.Unit., CancellationToken)	Overloaded. Gets an observable sequence of AdsStates via Polling. (Defined by AdsClientExtensions.)
	PollAdsState2Async(TimeSpan, CancellationToken)	Overloaded. Gets an observable sequence of ResultReadAdsStates via Polling. (Defined by AdsClientExtensions.)
	PollAdsStateAsync(IObservable.Unit., CancellationToken)	Overloaded. Gets an observable sequence of AdsStates via Polling. (Defined by ConnectionStateExtension.)
	PollAdsStateAsync(IObservable.Unit., CancellationToken)	Overloaded. Gets an observable sequence of AdsStates via Polling. (Defined by AdsClientExtensions.)
	PollAdsStateAsync(TimeSpan, CancellationToken)	Overloaded. Gets an observable sequence of AdsStates via Polling. (Defined by ConnectionStateExtension.)
	PollAdsStateAsync(TimeSpan, CancellationToken)	Overloaded. Gets an observable sequence of AdsStates via Polling. (Defined by AdsClientExtensions.)
	PollDeviceState(IObservable.Unit.)	Overloaded. Gets an observable sequence of ResultReadDeviceStates via Polling. (Defined by AdsClientExtensions.)
	PollDeviceState(TimeSpan)	Overloaded. Gets an observable sequence of ResultReadDeviceStates via Polling. (Defined by AdsClientExtensions.)
	PollDeviceStateAsync(IObservable.Unit., CancellationToken)	Overloaded. Gets an observable sequence of ResultReadDeviceStates via Polling. (Defined by AdsClientExtensions.)
	PollDeviceStateAsync(TimeSpan, CancellationToken)	Overloaded. Gets an observable sequence of ResultReadDeviceStates via Polling. (Defined by AdsClientExtensions.)
	PollSystemServiceState	Polls the state of the system service. (Defined by SystemServiceExtension.)
	PollSystemServiceStateAsync	Polls the system service state asynchronously (Defined by SystemServiceExtension.)
	PollValues(ISymbol, Type, IObservable.Unit.)	Overloaded. Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)
	PollValues(ISymbol, Type, TimeSpan)	Overloaded. Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)
	PollValues(String, Type, IObservable.Unit.)	Overloaded. Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)
	PollValues(String, Type, TimeSpan)	Overloaded. Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)
	PollValues(ISymbol, Type, .Int32., TimeSpan)	Overloaded. Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)
	PollValues(ISymbol, Type, IObservable.Unit., Func.Exception, Object.)	Overloaded. Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)
	PollValues(ISymbol, Type, TimeSpan, Func.Exception, Object.)	Overloaded. Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)
	PollValues(String, Type, .Int32., TimeSpan)	Overloaded. Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)
	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.)
	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.)
	PollValues(ISymbol, 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.)
	PollValues(ISymbol, Type, .Int32., TimeSpan, Func.Exception, Object.)	Overloaded. Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)
	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.)
	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.)
	PollValues.T.(ISymbol, IObservable.Unit.)	Overloaded. Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)
	PollValues.T.(ISymbol, TimeSpan)	Overloaded. Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)
	PollValues.T.(String, IObservable.Unit.)	Overloaded. Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)
	PollValues.T.(String, TimeSpan)	Overloaded. Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)
	PollValues.T.(ISymbol, IObservable.Unit., Func.Exception, T.)	Overloaded. Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)
	PollValues.T.(ISymbol, TimeSpan, Func.Exception, T.)	Overloaded. Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)
	PollValues.T.(ISymbol, .Int32., IObservable.Unit.)	Overloaded. Polls the symbol values on time points where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)
	PollValues.T.(ISymbol, .Int32., TimeSpan)	Overloaded. Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)
	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.)
	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.)
	PollValues.T.(String, .Int32., IObservable.Unit.)	Overloaded. Polls the symbol values on time points where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)
	PollValues.T.(String, .Int32., TimeSpan)	Overloaded. Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)
	PollValues.T.(ISymbol, .Int32., IObservable.Unit., Func.Exception, T.)	Overloaded. Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)
	PollValues.T.(ISymbol, .Int32., TimeSpan, Func.Exception, T.)	Overloaded. Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions.)
	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.)
	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.)
	PollValues2.T.(ISymbol, .Int32., IObservable.Unit.)	Overloaded. Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)
	PollValues2.T.(String, .Int32., IObservable.Unit.)	Overloaded. Polls the symbol values on time points where the polling observable streams data / triggers (Defined by AnyTypeExtensions.)
	ReadSysServState	Reads the System Service state (AdsSysServState) (Defined by SystemServiceExtension.)
	ReadSysServStateAsync	Reads the System Service state (AdsSysServState) (asynchronous) (Defined by SystemServiceExtension.)
	ReadWithFallback(UInt32, UInt32, Memory.Byte., UInt32, Boolean.)	Overloaded. Ads Read with fallback. (Defined by AdsClientExtensions.)
	ReadWithFallback(UInt32, UInt32, UInt32, Memory.Byte., Func.ResultRead, Boolean., Boolean.)	Overloaded. Ads Read with Fallback. (Defined by AdsClientExtensions.)
	ReadWithFallbackAsync(UInt32, UInt32, UInt32, Memory.Byte., CancellationToken)	Overloaded. Ads Read with fallback as an asynchronous operation. (Defined by AdsClientExtensions.)
	ReadWithFallbackAsync(UInt32, UInt32, UInt32, Memory.Byte., Func.ResultRead, Boolean., CancellationToken)	Overloaded. Ads Read with fallback as an asynchronous operation. (Defined by AdsClientExtensions.)
	RepeatedRead(UInt32, UInt32, Memory.Byte., Int32, TimeSpan)	Overloaded. Repeated AdsRead. (Defined by AdsClientExtensions.)
	RepeatedRead(UInt32, UInt32, Memory.Byte., Int32, TimeSpan, Func.ResultRead, Boolean.)	Overloaded. Repeated AdsRead. (Defined by AdsClientExtensions.)
	RepeatedReadAsync(UInt32, UInt32, Memory.Byte., Int32, TimeSpan, CancellationToken)	Overloaded. Repeated AdsRead as an asynchronous operation. (Defined by AdsClientExtensions.)
	RepeatedReadAsync(UInt32, UInt32, Memory.Byte., Int32, TimeSpan, Func.ResultRead, Boolean., CancellationToken)	Overloaded. Repeated AdsRead as an asynchronous operation. (Defined by AdsClientExtensions.)
	RestartTwinCATAsync	Sends a SystemService Restart to the target system and waits until the system has finished the state changes (SystemService, Port 10000) (asynchronously) (Defined by SystemServiceExtension.)
	SetAdsState	Sets an AdsState/AdsStateCommand to an AdsServer and waits until the StateChange finishes. (Defined by ConnectionStateExtension.)
	SetAdsStateAsync	Sets an AdsState/AdsStateCommand to an AdsServer and waits until the StateChange finishes. (Defined by ConnectionStateExtension.)
	WaitUntilRestarted	Waits until the Restart is detected on the client (SystemService, Port 10000) (Defined by SystemServiceExtension.)
	WaitUntilRestartedAsync	Waits until the SystemService Restart is detectd on the client (SystemService, Port 10000) (asynchronously) (Defined by SystemServiceExtension.)
	WhenAdsStateChanges	Gets an observable sequence of AdsStates. (Defined by AdsClientExtensions.)
	WhenNotification(ISymbol)	Overloaded. Gets an observable sequence of Notifications. (Defined by AdsClientExtensions.)
	WhenNotification(ISymbolCollection)	Overloaded. Gets an observable sequence of Notification objects. (Defined by AdsClientExtensions.)
	WhenNotification(IList.ISymbol., NotificationSettings)	Overloaded. Gets an observable sequence of Notification objects. (Defined by AdsClientExtensions.)
	WhenNotification(ISymbol, NotificationSettings)	Overloaded. Gets an observable sequence of SymbolValueNotifications. (Defined by AdsClientExtensions.)
	WhenNotification(String, Type, NotificationSettings)	Overloaded. Creates an observable sequence of values that are created by ADS Notifications. (Defined by AnyTypeExtensions.)
	WhenNotification.T.(String, NotificationSettings)	Overloaded. Creates an observable sequence of values that are created by ADS Notifications. (Defined by AnyTypeExtensions.)
	WhenSymbolVersionChanges.	Overloaded. Gets an observable sequence of SymbolVersion changed counts. (Defined by AdsClientExtensions.)
	WhenSymbolVersionChanges(IScheduler)	Overloaded. Gets an observable sequence of SymbolVersion changed counts. (Defined by AdsClientExtensions.)
	WhenValueChanged	Observable sequence of Values driven by ADS Notifications on the specified symbol. (Defined by ValueSymbolExtensions.)
	WriteValues.T.(String, IObservable.T.)	Overloaded. Writes the sequence of values to the symbol specified by the instance path. (Defined by AnyTypeExtensions.)
	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 class AdsClient enables synchronous/asynchronous access to data of an ADS Device.

Examples

The following sample shows how to instantiate and use the AdsClient class.

AdsClient Demo (async)

using System;
using System.Buffers.Binary;
using System.Threading;
using System.Threading.Tasks;
using TwinCAT.Ads;
using TwinCAT.TypeSystem;

namespace Sample
{
    class ClientAsync
    {
    /// <summary>
    /// Defines the entry point of the application.
    /// </summary>
    /// <param name="args">The arguments.</param>
    static async void Main(string[] args)
    {
        AmsAddress address = ArgParser.Parse(args);
        CancellationTokenSource cancelSource = new CancellationTokenSource();
        CancellationToken cancel = cancelSource.Token;

        using (AdsClient client = new AdsClient())
        {

        // Connect to Address
        client.Connect(address.NetId,address.Port); // Connect to Port (851, first PLC by default)

        // Read the identification and version number of the device
        ResultDeviceInfo resultDeviceInfo = await client.ReadDeviceInfoAsync(cancel);

        if (resultDeviceInfo.Succeeded)
        {
            DeviceInfo deviceInfo = resultDeviceInfo.DeviceInfo;
            Version version = deviceInfo.Version.ConvertToStandard();
            Console.WriteLine(string.Format("DeviceName: {0}", deviceInfo.Name));
            Console.WriteLine(string.Format("DeviceVersion: {0}", version.ToString(3)));
        }
        // Read the state of the device
        ResultReadDeviceState resultReadDeviceState  = await client.ReadStateAsync(cancel);
        AdsState state = AdsState.Invalid;

        if (resultReadDeviceState.Succeeded)
        {
            StateInfo stateInfo = resultReadDeviceState.State;

            state = stateInfo.AdsState;
            short deviceState = stateInfo.DeviceState;
            Console.WriteLine(string.Format("DeviceState: {0}", deviceState));
            Console.WriteLine(string.Format("AdsState   : {0}", state));
        }

        // Write ADS Commands (write state) to target
        // Set PLC to Run

        if (state == AdsState.Stop)
        {
            await client.WriteControlAsync(AdsState.Run,0,cancel);
        }

        //create variable handle for Plc Project Name (automatic generated symbol in PLC)
        ResultHandle resultHandle = await client.CreateVariableHandleAsync("TwinCAT_SystemInfoVarList._AppInfo.ProjectName",cancel);

        if (resultHandle.Succeeded)
        {
            uint handleProjectName = resultHandle.Handle;
            uint handleNotification = 0; // Notification Handle for Task1 CycleCount changes

            try
            {
            // Read value from target and Marshal data into string
            byte[] readData = new byte[256];

                ResultRead resultRead = await client.ReadAsync(handleProjectName,readData.AsMemory(), cancel);

                if (resultRead.Succeeded)
                {
                PrimitiveTypeMarshaler marshaler = PrimitiveTypeMarshaler.Default;

                string projectName = null; 
                int unmarshaledBytes = marshaler.Unmarshal(readData, out projectName);
                Console.WriteLine(string.Format("ProjectName  : {0}", projectName));
                }

            //_notificationBuffer = new byte[4]; // Sizeof UDINT
            int size = sizeof(UInt32); // Sizeof UDINT

            client.AdsNotification += client_NotificationEvent; // Register for Notification event

            //Register Notification for Task1 CycleCount symbol (automatic generated symbol in PLC)
            resultHandle = await client.AddDeviceNotificationAsync("TwinCAT_SystemInfoVarList._TaskInfo[1].CycleCount", size, NotificationSettings.Default, null, cancel);

            if (resultHandle.Succeeded)
            {
                handleNotification = resultHandle.Handle;
                // Sleep 10 Seconds to receive events
                await Task.Delay(10000, cancel); // Async Delay (some time for notifications)
            }
            }
            finally
            {
            // Cleanup all handles
            // Dispose all Streams

            ResultAds result = await client.DeleteDeviceNotificationAsync(handleNotification, cancel);

            // Always delete all variable handles.
            result = await client.DeleteVariableHandleAsync(handleProjectName, cancel);
            }
        }
        Console.WriteLine("");
        Console.WriteLine("Press [Enter] for leave:");
        Console.ReadLine();
        }
    }

AdsClient Demo (sync)

using System;
using System.Buffers.Binary;
using System.Threading;
using System.Threading.Tasks;
using TwinCAT.Ads;
using TwinCAT.TypeSystem;

namespace Sample
{
    class Client
    {
    /// <summary>
    /// Defines the entry point of the application.
    /// </summary>
    /// <param name="args">The arguments.</param>
    static void Main(string[] args)
    {
        AmsAddress address = ArgParser.Parse(args);

        using (AdsClient client = new AdsClient())
        {

        // Connect to Address
        client.Connect(address.NetId, address.Port); // Connect to Port (851, first PLC by default)

        // Read the identification and version number of the device
        DeviceInfo deviceInfo = client.ReadDeviceInfo();

        Version version = deviceInfo.Version.ConvertToStandard();
        Console.WriteLine(string.Format("DeviceName: {0}", deviceInfo.Name));
        Console.WriteLine(string.Format("DeviceVersion: {0}", version.ToString(3)));

        // Read the state of the device
        StateInfo stateInfo = client.ReadState();
        AdsState state = AdsState.Invalid;

        state = stateInfo.AdsState;
        short deviceState = stateInfo.DeviceState;
        Console.WriteLine(string.Format("DeviceState: {0}", deviceState));
        Console.WriteLine(string.Format("AdsState   : {0}", state));

        // Write ADS Commands (write state) to target
        // Set PLC to Run

        if (state == AdsState.Stop)
        {
            client.WriteControl(new StateInfo(AdsState.Run, 0));
        }

        //create variable handle for Plc Project Name (automatic generated symbol in PLC)
        uint handleProjectName = client.CreateVariableHandle("TwinCAT_SystemInfoVarList._AppInfo.ProjectName");
        uint handleNotification = 0; // Notification Handle for Task1 CycleCount changes

        try
        {
            // Read value from target and Marshal data into string
            byte[] readData = new byte[256];
            int readBytes = client.Read(handleProjectName, readData.AsMemory());

            PrimitiveTypeMarshaler marshaler = PrimitiveTypeMarshaler.Default;

            string projectName = null;
            int unmarshaledBytes = marshaler.Unmarshal(readData, client.DefaultValueEncoding, out projectName);
            Console.WriteLine(string.Format("ProjectName  : {0}", projectName));

            //_notificationBuffer = new byte[4]; // Sizeof UDINT
            int size = sizeof(UInt32); // Sizeof UDINT

            client.AdsNotification += client_NotificationEvent; // Register for Notification event

            //Register Notification for Task1 CycleCount symbol (automatic generated symbol in PLC)
            handleNotification = client.AddDeviceNotification("TwinCAT_SystemInfoVarList._TaskInfo[1].CycleCount", size, NotificationSettings.Default, null);

            // Sleep 10 Seconds to receive events
            Thread.Sleep(10000); // Sleep to get notifications
        }
        finally
        {
            // Cleanup all handles
            // Dispose all Streams
            client.DeleteDeviceNotification(handleNotification);

            // Always delete all variable handles.
            client.DeleteVariableHandle(handleProjectName);
        }
        Console.WriteLine("");
        Console.WriteLine("Press [Enter] for leave:");
        Console.ReadLine();
        }
    }

Argument Parser

public static class ArgParser
{
    /// <summary>
    /// Parses the arguments.
    /// </summary>
    /// <param name="args">The arguments.</param>
    /// <returns>AmsAddress.</returns>
    public static AmsAddress Parse(string[] args)
    {
    AmsNetId netId = AmsNetId.Local;
    int port = 851;

    if (args != null)
    {
        if (args.Length > 0 && args[0] != null)
        netId = AmsNetId.Parse(args[0]);

        if (args.Length > 1 && args[1] != null)
        port = int.Parse(args[1]);
    }
    return new AmsAddress(netId, port);
    }
}

The following sample shows how to call (Remote Procedures / Methods) within the PLC directly from the AdsClient class.

RPC Call Example (async)

namespace Sample
{
    using System;
    using System.Diagnostics;
    using System.Threading;
    using TwinCAT.Ads;
    using TwinCAT.TypeSystem;

    class RpcCallAsync
    {
    /// <summary>
    /// Defines the entry point of the application.
    /// </summary>
    /// <param name="args">The arguments.</param>
    static async void Main(string[] args)
    {
        //Parse the AmsAddress from command-line arguments
        AmsAddress address = ArgParser.Parse(args);

        // Create the ADS Client
        using (AdsClient client = new AdsClient())
        {
        // Establish Connection
        client.Connect(address);

        // Call a Method that has the following signature (within MAIN Program)

        /*  {attribute 'TcRpcEnable'}
            METHOD PUBLIC M_Add : INT
            VAR_INPUT
            i1 : INT := 0;
            i2 : INT := 0;
            END_VAR 
        */

        ResultRpcMethod result1 = await client.InvokeRpcMethodAsync("MAIN", "M_Add", new object[] { (short)1, (short)4 }, CancellationToken.None);
        short result = (short)result1.ReturnValue;

        // Call a Method that has no parameter and returns VOID
        await client.InvokeRpcMethodAsync("MAIN", "M_Method1", new object[] { },CancellationToken.None);
        }
    }
    }
}

RPC Call Example (sync)

namespace Sample
{
    using System;
    using System.Diagnostics;
    using TwinCAT.Ads;
    using TwinCAT.TypeSystem;

    class RpcCall
    {
    /// <summary>
    /// Defines the entry point of the application.
    /// </summary>
    /// <param name="args">The arguments.</param>
    static void Main(string[] args)
    {
        //Parse the AmsAddress from command-line arguments
        AmsAddress address = ArgParser.Parse(args);

        // Create the ADS Client
        using (AdsClient client = new AdsClient())
        {
        // Establish Connection
        client.Connect(address);

        // Call a Method that has the following signature (within MAIN Program)

        /*  {attribute 'TcRpcEnable'}
            METHOD PUBLIC M_Add : INT
            VAR_INPUT
            i1 : INT := 0;
            i2 : INT := 0;
            END_VAR 
        */

        short result = (short)client.InvokeRpcMethod("MAIN", "M_Add", new object[] { (short)1, (short)4 });

        // Call a Method that has no parameter and returns VOID
        client.InvokeRpcMethod("MAIN", "M_Method1", new object[] { });
        }
    }
    }
}

Reference

TwinCAT.Ads Namespace