SendNotify

Applicability

Product	Supported (√/x)
Ascend 950PR / Ascend 950DT	√
Atlas A3 training products / Atlas A3 inference products	√
Atlas A2 training products / Atlas A2 inference products	√
Atlas 200I/500 A2 inference products	x
Atlas inference products	x
Atlas training products	x

Note: For Atlas A2 training products / Atlas A2 inference products , only the Atlas 800I A2 inference server and A200I A2 Box heterogeneous subrack are supported.

Function Description

Sends a Notify message from the client to the server.

Prototype

Status SendNotify(const AscendString &remote_engine, const NotifyDesc &notify, int32_t timeout_in_millis = 1000)

Parameters

Parameter	Input/Output	Description
remote_engine	Input	Unique identifier of the remote HIXL instance.
notify	Input	Content to be sent. The maximum length for both name and notify_msg in the content is 1024 characters.
timeout_in_millis	Input	Sending timeout interval, in milliseconds. The default value is 1000.

Parameter

Input/Output

Description

remote_engine

Input

Unique identifier of the remote HIXL instance.

notify

Input

Content to be sent.

The maximum length for both name and notify_msg in the content is 1024 characters.

timeout_in_millis

Input

Sending timeout interval, in milliseconds. The default value is 1000.

Example

None

Returns

SUCCESS: Success.
Other values: Failure.

Constraints

Before calling this API, call the Connect API to establish a link with the peer end.
This API and Initialize must run in the same thread. If you need to switch threads to call this API, first call aclrtGetCurrentContext in the thread where Initialize is running to obtain the context. Then, in the new thread, call aclrtSetCurrentContext to set the context.
Each link can have a maximum of 4,096 Notify messages. Ensure that the remote HIXL calls the GetNotifies API in a timely manner to consume Notify messages, preventing sending failures caused by reaching the upper limit.

Parent topic: HIXL APIs