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，其他失败。

约束说明

无

调用示例

资源初始化相关代码请参见HcommWriteOnThread的调用示例。

void Sample(HcclComm comm, ChannelHandle channel, HcclThread threadHandle, uint32_t rank)
{
    if (rank == 0) {
        // 发送同步信号
        HcommChannelNotifyRecordOnThread(threadHandle, channel, 0);
        // 等待同步信号
        HcommChannelNotifyWaitOnThread(threadHandle, channel, 0, NOTIFY_TIMEOUT);
    } else {
        // 发送同步信号
        HcommChannelNotifyRecordOnThread(threadHandle, channel, 0);
        // 等待同步信号
        HcommChannelNotifyWaitOnThread(threadHandle, channel, 0, NOTIFY_TIMEOUT);
    }
    return;
}

父主题： 通信操作