HcommChannelNotifyWaitOnThread

产品支持情况

产品	是否支持
Atlas A3 训练系列产品/Atlas A3 推理系列产品	√
Atlas A2 训练系列产品/Atlas A2 推理系列产品	√
Atlas 200I/500 A2 推理产品	☓
Atlas 推理系列产品	☓
Atlas 训练系列产品	☓

针对Atlas A2 训练系列产品/Atlas A2 推理系列产品，仅支持Atlas 800T A2 训练服务器、Atlas 900 A2 PoD 集群基础单元、Atlas 200T A2 Box16 异构子框。

功能说明

等待同步信号，阻塞等待Thread的运行，直到指定的Notify完成。

函数原型

int32_t HcommChannelNotifyWaitOnThread(ThreadHandle thread, ChannelHandle channel, uint32_t localNotifyIdx, uint32_t timeout)

参数说明

参数名	输入/输出	描述
thread	输入	通信线程句柄，为通过HcclThreadAcquire接口获取到的threads。 ThreadHandle类型的定义可参见ThreadHandle。
channel	输入	通信通道句柄，为通过HcclChannelAcquire接口获取到的channels。 ChannelHandle类型的定义可参见ChannelHandle。
localNotifyIdx	输入	本地Notify索引。取值范围：[0, HcclChannelAcquire接口传入的channelDescs参数中的notifyNum)。
timeout	输入	超时时间，单位：毫秒。 0：表示永久等待。 >0：配置的具体超时时间。

返回值

int32_t：接口成功返回0，其他失败。

约束说明

无

调用示例

// 申请通信线程资源
CommEngine engine = CommEngine::COMM_ENGINE_CPU_TS;
uint32_t threadNum = 1;
uint32_t notifyNumPerThread = 1;
ThreadHandle thread;
HcclThreadAcquire(engine, threadNum, notifyNumPerThread, &thread);

// 申请通信通道资源
uint32_t channelNum = 1;
HcclChannelDesc channelDesc;
HcclChannelDescInit(&channelDesc, channelNum);
HcclComm comm;
ChannelHandle channel;
HcclChannelAcquire(comm, engine, &channelDesc, channelNum, &channel);

// 通知对端
HcommChannelNotifyRecordOnThread(thread, channel, 0);

// 数据面操作
// ...

// 等待对端通知本端
uint32_t notifyTimeout = 1800;
HcommChannelNotifyWaitOnThread(thread, channel, 0, notifyTimeout);

父主题： 通信操作