AdsSymbolicServer.OnAddDeviceNotificationAsync Method

Called when an ADS Add Device Notification indication is received.

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

Syntax

C#

protected override Task<ResultHandle> OnAddDeviceNotificationAsync(
    AmsAddress sender,
    uint invokeId,
    uint indexGroup,
    uint indexOffset,
    int dataLength,
    AmsAddress receiver,
    NotificationSettings settings,
    CancellationToken cancel
)

Parameters

sender

Type: TwinCAT.Ads.AmsAddress
The sender address of the request.

invokeId

Type: System.UInt32
The invoke identifier of the request.

indexGroup

Type: System.UInt32
The index group of the requested ADS service

indexOffset

Type: System.UInt32
The index offset of the requested ADS service

dataLength

Type: System.Int32
Number of bytes to be transmitted

receiver

Type: TwinCAT.Ads.AmsAddress
The receiver of the notifications (the requester of this message)

settings

Type: TwinCAT.Ads.NotificationSettings
The Notification settings.

cancel

Type: System.Threading.CancellationToken
The cancellation token.

Return Value

Type: Task.ResultHandle.
A task that represents the asynchronous 'AddDeviceNotificationIndication' operation. The Task.TResult. parameter contains the AdsErrorCode as Result.

Remarks

Overwrite this method in derived classes to react on ADS Add Device Notification indications. The default implementation replies with an ADS ServiceNotSupported error code (0x701).

Reference

AdsSymbolicServer Class

TwinCAT.Ads.Server Namespace