HccnRpingRemoveTarget

Applicability

Product

Supported

Atlas 350 Accelerator Card

Atlas A3 training product/Atlas A3 inference product

Atlas A2 training product/Atlas A2 inference product

Atlas 200I/500 A2 inference product

Atlas inference product

Atlas training product

Description

Removes the ping target and disables the RPing communication.

Prototype

1
HccnResult HccnRpingRemoveTarget(HccnRpingCtx rpingCtx, uint32_t targetNum, HccnRpingTargetInfo *target)

Parameters

Parameter

Input/Output

Description

rpingCtx

Input

RPing object returned by the HccnRpingInit API.

targetNum

Input

Number of targets to be removed. The value must be less than or equal to the number of added targets.

target

Input

Target to be removed.

For details about the definition of the HccnRpingTargetInfo type, see HccnRpingTargetInfo.

Returns

Parsing result of the error code of the HccnResult type.

Constraints

  • The value of targetNum must be the same as the target array size. Otherwise, out-of-bounds access may occur.
  • If the HccnRpingBatchPingStart API has been called to initiate a ping task, call HccnRpingBatchPingStop to stop the ping task, and call HccnRpingRemoveTarget to remove the target.
  • A maximum of 16 targets can be removed at once. If more than 16 targets need to be removed, call this API for multiple times.