IAdsConnectAddress Interface
Interface for method to connect the ADS client via AMS Address.
Namespace: TwinCAT.Ads
Assembly: TwinCAT.Ads.Abstractions (in TwinCAT.Ads.Abstractions.dll) Version: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470
Syntax
C#
public interface IAdsConnectAddress : IAdsConnection,
IConnection, IConnectionStateProvider, IAdsNotifications, IAdsSymbolicAccess, IAdsAnyAccess,
IAdsHandle, IAdsReadWrite, IAdsStateProvider, IAdsStateControl, IAdsSymbolChangedProvider,
IAdsRpcInvokeThe IAdsConnectAddress type exposes the following members.
Properties
|
|
Name |
Description |
|---|---|---|
|
|
Gets the AmsAddress of the ADS server.
| |
|
|
Gets the channel port type.
| |
|
|
Gets the channel protocol.
| |
|
|
Get the AmsAddress of the ADS client.
| |
|
|
Gets the configuration.
| |
|
|
Gets the current Connection state of the IConnectionStateProvider | |
|
|
Gets/Sets the default value encoding.
| |
|
|
Gets the Connection Identifier .
| |
|
|
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.
| |
|
|
Gets a value indicating whether the ADS client is connected to a ADS Server on the local
computer.
| |
|
|
Gets the connection logger interface.
| |
|
|
Gets the logger factory.
| |
|
|
Gets the session that initiated this IConnection | |
|
|
Gets/Sets the symbol encoding.
| |
|
|
Gets the timeout (in milliseconds)
|
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) |
Connects a variable to the ADS client asynchronously. The ADS client will be notified by the AdsNotification event.
|
|
|
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.
|
|
|
Connects a variable to the ADS client asynchronously. The ADS client will be notified by the AdsNotificationEx event.
| |
|
|
Clears the internal symbol / DataTypes cache.
| |
|
|
Closes this IConnection | |
|
|
(Re)Connects the IConnection when disconnected.
| |
|
|
Connects/Reconnects to the specified target address. | |
|
|
Connects/Reconnects to the specified port of the local ADS target device. | |
|
|
Connects/Reconnects to the specified target address. | |
|
|
Connects/Reconnects to the specified target address. | |
|
|
Connects the and wait asynchronous.
| |
|
|
Connects/Reconnects to the target address and waits until the IAdsConnection is disconnected asynchronously. | |
|
|
Connects the IConnection asynchronously when disconnected.
| |
|
|
Connects/Reconnects to the specified target address asynchronously. | |
|
|
Connects/Reconnects to the specified port of the local system asynchonously. | |
|
|
Connects/Reconnects to the specified target address asynchronously. | |
|
|
Determines the Symbol handle by its instance path synchronously.
| |
|
|
Determines the Symbol handle by its instance path asynchronously.
| |
|
|
Deletes a registered notification.
| |
|
|
Deletes a registered notification asynchronously.
| |
|
|
Releases the specified symbol/variable handle synchronously.
| |
|
|
Releases the specified symbol/variable handle asynchronously.
| |
|
|
Disconnects this IConnection.
| |
|
|
Disconnects the IConnection when connected (asynchronously)
| |
|
|
InvokeRpcMethodAsync(String, String, Object[], CancellationToken) |
Invokes the specified RPC Method asynchronously
|
|
|
Invokes the specified RPC Method asynchronously
| |
|
|
Invokes the specified RPC Method asynchronously
| |
|
|
Reads data synchronously from an ADS device and writes to the specified readBuffer.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data synchronously from an ADS device and writes it to an object.
| |
|
|
Reads data asynchronously from an ADS device and writes it to an object.
| |
|
|
ReadAnyAsync(UInt32, UInt32, Type, Int32[], CancellationToken) |
Reads data asynchronously from an ADS device and writes it to an object.
|
|
|
Reads data asynchronously from an ADS device.
| |
|
|
Reads data asynchronously from an ADS device.
| |
|
|
Reads data asynchronously from an ADS device and writes it to an object.
| |
|
|
Reads data asynchronously from an ADS device and writes it to an object.
| |
|
|
Reads data asynchronously from an ADS device and writes it to an object.
| |
|
|
Reads data asynchronously from an ADS device and writes it to an object.
| |
|
|
Reads any string.
| |
|
|
Reads a string from the specified symbol/variable.
| |
|
|
Reads as string from a specified address.
| |
|
|
ReadAnyStringAsync(String, Int32, Encoding, CancellationToken) |
Reads a string asynchronously from the specified symbol/variable
|
|
|
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.
|
|
|
Reads the value synchronously data of the symbol, that is represented by the variable handle./>.
| |
|
|
Reads data synchronously from an ADS device.
| |
|
|
Reads/Determines the DataType Inforrmation with the specifed name.
| |
|
|
Reads/Determines the DataType of the specified type as an asynchronous operation.
| |
|
|
Reads the identification and version number of an ADS server.
| |
|
|
Reads the identification and version number of an ADS server.
| |
|
|
Reads the ADS status and the device status from an ADS server.
| |
|
|
Reads the ADS status and the device status from an ADS server.
| |
|
|
Reads the symbol information about an individual variable in ADS devices.
| |
|
|
Reads the symbol information object specified by the instance path as an asynchronous operation.
| |
|
|
Reads the value of a symbol and returns the value as (boxed) object.
| |
|
|
Reads the value of a symbol specified with its instance path and returns the value as boxed object.
| |
|
|
Reads the value of a symbol specified with its instance path and returns the value as object of the specified type.
| |
|
|
Reads the value of a symbol as an asynchronous operation and returns the value as an (boxed) object.
| |
|
|
Reads the typed value of a symbol as an asynchronous operation.
| |
|
|
Reads the typed value of a symbol specified by the instance path as an asynchronous operation.
| |
|
|
Writes data synchronously to an ADS device and then Reads data from that target.
| |
|
|
Writes data synchronously to an ADS device and reads data from that device.
| |
|
|
ReadWrites value data asynchronously to/from the symbol represented by the variableHandle.
| |
|
|
Registers for AdsStateChanged events as an asynchronous operation.
| |
|
|
Registers the symbol version changed event (synchronously)
| |
|
|
Registers the symbol version changed asynchronously.
| |
|
|
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.
|
|
|
Determines the Symbol handle by its instance path synchronously.
| |
|
|
Deletes a registered notification.
| |
|
|
Releases the specified symbol/variable handle synchronously.
| |
|
|
Invokes the specified RPC Method
| |
|
|
TryInvokeRpcMethod(String, String, Object[], Object[], Object) |
Invokes the specified RPC Method
|
|
|
Invokes the rpc method.
| |
|
|
TryInvokeRpcMethod(String, String, Object[], AnyTypeSpecifier[], AnyTypeSpecifier, Object[], Object) |
Invokes the rpc method.
|
|
|
Reads the value synchronously data of the symbol, that is represented by the variable handle into the readBuffer.
| |
|
|
Tries to Read/Determine the DataType of the specified type.
| |
|
|
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.
| |
|
|
Tries to read the symbol information object specified by the instance path.
| |
|
|
Tries to read the value of a symbol and returns the value as boxed object.
| |
|
|
Tries to the value of a symbol specified as instance path and returns the value as (boxed) object.
| |
|
|
Reads the value of a symbol and returns the value as typed value.
| |
|
|
Tries to reads the value of a symbol specified with instance path and returns the typed value.
| |
|
|
ReadWrites value data synchronously to/from the symbol represented by the variableHandle.
| |
|
|
Writes the value data synchronously that is represented in the writeBuffer to the symbol with the specified variableHandle.
| |
|
|
Writes data synchronously to an ADS device.
| |
|
|
Changes the ADS status and the device status of an ADS server.
| |
|
|
Changes the ADS status and the device status of an ADS server.
| |
|
|
Tries to write a (boxed) value to the symbol
| |
|
|
Tries to write a (boxed) value to the symbol instance specified by its instance/symbol path.
| |
|
|
Tries to write a value to the symbol.
| |
|
|
Tries to Write a (typed) value to the symbol instance specified by its instance/symbol path.
| |
|
|
Registers for AdsStateChanged events as an asynchronous operation.
| |
|
|
Unregisters the symbol version changed event (synchronously)
| |
|
|
Unregisters the symbol version changed asynchronously.
| |
|
|
Writes data synchronously to an ADS device.
| |
|
|
Sends a 'Write' request to the ADS device at the specified address.
| |
|
|
Writes data synchronously to an ADS device.
| |
|
|
Writes an object synchronously to an ADS device.
| |
|
|
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.
| |
|
|
Writes an object synchronously to an ADS device.
| |
|
|
Writes an object synchronously to an ADS device.
| |
|
|
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.
| |
|
|
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.
| |
|
|
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, 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.
|
|
|
Writes data synchronously to an ADS device.
| |
|
|
Writes the value data asynchronously that is represented by the writeBuffer to the symbol specified by the
variableHandle.
| |
|
|
WriteAsync(UInt32, UInt32, ReadOnlyMemory<Byte>, CancellationToken) |
Writes the data / Value asynchronously into the specified writeBuffer.
|
|
|
Changes the ADS status and the device status of an ADS server.
| |
|
|
Changes the ADS status and the device status of an ADS server.
| |
|
|
Changes the ADS status and device status of the ADS server asynchronously.
| |
|
|
WriteControlAsync(AdsState, UInt16, ReadOnlyMemory<Byte>, CancellationToken) |
Changes the ADS status and device status of the ADS server asynchronously.
|
|
|
Writes a (boxed) value to the symbol.
| |
|
|
Writes a (boxed value) to the symbol instance specified by its instance/symbol path.
| |
|
|
Writes a (typed) value to the symbol.
| |
|
|
Writes a typed value to the symbol instance specified by its instance/symbol path.
| |
|
|
Writes a (boxed) value to the symbol as an asynchronous operation.
| |
|
|
Writes a (typed) value to the symbol as an asynchronous operation.
| |
|
|
Writes a (typed) value to the symbol instance specified by its instance/symbol path as an asynchronous operation.
|
Events
|
|
Name |
Description |
|---|---|---|
|
|
Occurs when the ADS device sends a notification to the client.
| |
|
|
Occurs when a exception has occurred during notification management.
| |
|
|
Occurs when the ADS devices sends a notification to the client.
| |
|
|
Occurs when the AdsState of the target system has been changed.
| |
|
|
Occurs when Notifications are send (bundled notifications)
| |
|
|
Occurs when the SymbolVersion table of a TwinCAT PLC System has been changed.
| |
|
|
Occurs when connection status of the IConnectionStateProvider has been changed.
|
Extension Methods
|
|
Name |
Description |
|---|---|---|
|
|
Gets an observable sequence of ResultReadAdsStates via Polling.
| |
|
|
Gets an observable sequence of AdsStates via Polling.
| |
|
|
Gets an observable sequence of ResultReadAdsStates via Polling.
| |
|
|
Gets an observable sequence of AdsStates via Polling.
| |
|
|
Gets an observable sequence of ResultReadAdsStates via Polling.
| |
|
|
Gets an observable sequence of ResultReadAdsStates via Polling.
| |
|
|
Gets an observable sequence of AdsStates via Polling.
| |
|
|
Gets an observable sequence of ResultReadAdsStates via Polling.
| |
|
|
Gets an observable sequence of AdsStates via Polling.
| |
|
|
Gets an observable sequence of AdsStates via Polling.
| |
|
|
Gets an observable sequence of AdsStates via Polling.
| |
|
|
Gets an observable sequence of AdsStates via Polling.
| |
|
|
Gets an observable sequence of ResultReadDeviceStates via Polling.
| |
|
|
Gets an observable sequence of ResultReadDeviceStates via Polling.
| |
|
|
Gets an observable sequence of ResultReadDeviceStates via Polling.
| |
|
|
Gets an observable sequence of ResultReadDeviceStates via Polling.
| |
|
|
Polls the state of the system service.
| |
|
|
Polls the system service state asynchronously
| |
|
|
Polls the symbol values on timepoints where the polling observable streams data / triggers
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol values on timepoints where the polling observable streams data / triggers
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol values on timepoints where the polling observable streams data / triggers
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol values on timepoints where the polling observable streams data / triggers
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol values on time points where the polling observable streams data / triggers
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol values on time points where the polling observable streams data / triggers
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol values on timepoints where the polling observable streams data / triggers
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol values on timepoints where the polling observable streams data / triggers
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol values on timepoints where the polling observable streams data / triggers
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol values on time points where the polling observable streams data / triggers
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol values on timepoints where the polling observable streams data / triggers
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol values on time points where the polling observable streams data / triggers
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol values on timepoints where the polling observable streams data / triggers
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol values on timepoints where the polling observable streams data / triggers
| |
|
|
Polls the symbol as value sequence of object values with a specified period time.
| |
|
|
Polls the symbol values on timepoints where the polling observable streams data / triggers
| |
|
|
Polls the symbol values on time points where the polling observable streams data / triggers
| |
|
|
Reads the System Service state (AdsSysServState)
| |
|
|
Reads the System Service state (AdsSysServState) (asynchronous)
| |
|
|
Read with fallback.
| |
|
|
Ads Read with Fallback.
| |
|
|
Ads Read with Fallback.
| |
|
|
Ads Read with fallback as an asynchronous operation.
| |
|
|
Ads Read with fallback as an asynchronous operation.
| |
|
|
Ads Read with fallback as an asynchronous operation.
| |
|
|
Ads Read with Fallback.
| |
|
|
ReadWrite with Fallback.
| |
|
|
Ads Read with fallback as an asynchronous operation.
| |
|
|
Ads Read with fallback as an asynchronous operation.
| |
|
|
Repeated AdsRead.
| |
|
|
Repeated AdsRead.
| |
|
|
Repeated AdsRead as an asynchronous operation.
| |
|
|
Repeated AdsRead as an asynchronous operation.
| |
|
|
Repeated AdsRead.
| |
|
|
Repeated AdsReadWrite as an asynchronous operation.
| |
|
|
Repeated AdsWrie.
| |
|
|
Repeated AdsReadWrite as an asynchronous operation.
| |
|
|
Sends a SystemService Restart to the target system and waits until the system has finished the state changes (SystemService, Port 10000) (asynchronously)
| |
|
|
Sends an AdsState/AdsStateCommand Request to an AdsServer and waits until the StateChange is done or fails.
| |
|
|
Sends an AdsState/AdsStateCommand Request to an AdsServer and waits until the StateChange is done or fails (asynchronously)
| |
|
|
Waits until the target AdsServer reaches the requested state.
| |
|
|
Waits until the target AdsServer reaches the requested state (asynchronous)
| |
|
|
Waits until the Restart is detected on the client (SystemService, Port 10000)
| |
|
|
Waits until the SystemService Restart is detectd on the client (SystemService, Port 10000) (asynchronously)
| |
|
|
Gets an observable sequence of AdsStates.
| |
|
|
Gets an observable sequence of Notifications.
| |
|
|
Gets an observable sequence of Notification objects.
| |
|
|
Gets an observable sequence of Notification objects.
| |
|
|
Gets an observable sequence of SymbolValueNotifications.
| |
|
|
Creates an observable sequence of values that are created by ADS Notifications.
| |
|
|
Creates an observable sequence of values that are created by ADS Notifications.
| |
|
|
Gets an observable sequence of SymbolVersion changed counts.
| |
|
|
Gets an observable sequence of SymbolVersion changed counts.
| |
|
|
Observable sequence of Values driven by ADS Notifications on the specified symbol.
| |
|
|
Writes the sequence of values to the symbol specified by the instance path.
| |
|
|
Writes the sequence of values to the symbol specified by the instance path.
|
See Also
- IAdsConnection.ChannelPortType Property
- IAdsConnection.ChannelProtocol Property
- IConnection.Configuration Property
- IConnection.Logger Property
- IConnection.LoggerFactory Property
- IConnection.SymbolEncoding Property
- IAdsConnectAddress.ConnectAndWaitAsync(AmsAddress, CancellationToken) Method
- IAdsConnectAddress.ConnectAsync(AmsAddress, CancellationToken) Method
- IAdsConnectAddress.ConnectAsync(Int32, CancellationToken) Method
- IAdsConnectAddress.ConnectAsync(AmsNetId, Int32, CancellationToken) Method
- IAdsAnyAccess.ReadAny(String, Type) Method
- IAdsAnyAccess.ReadAny(UInt32, Type) Method
- IAdsAnyAccess.ReadAny(String, Type, Int32[]) Method
- IAdsAnyAccess.ReadAny(UInt32, Type, Int32[]) Method
- IAdsAnyAccess.ReadAny(UInt32, UInt32, Type) Method
- IAdsAnyAccess.ReadAny(UInt32, UInt32, Type, Int32[]) Method
- IAdsHandle.ReadAsResult Method
- IAdsSymbolicAccess.ReadValue(ISymbol) Method
- IAdsSymbolicAccess.ReadValue(String) Method
- IAdsSymbolicAccess.ReadValue(String, Type) Method
- IAdsSymbolicAccess.ReadValueAsync(String, Type, CancellationToken) Method
- IAdsSymbolicAccess.TryReadValue(ISymbol, Object) Method
- IAdsSymbolicAccess.TryReadValue(String, Type, Object) Method