已合并
fix shared jetty feat md bug #4461
acoolntly创建于 8月6日
fix shared jetty feat md bug #4461
已合并
共 13 个文件变更+43-43
| @@ -20,7 +20,7 @@ | |||
| 20 | 20 | ||
| 21 | ## 功能说明 | 21 | ## 功能说明 |
| 22 | 22 | ||
| 23 | -创建 Channel 配置对象，用于[HcommChannelCreateWithConfig](HcommChannelCreateWithConfig.md)接口创建通信通道时传入共享 Jetty 等高级配置。 | 23 | +创建Channel配置对象，用于[HcommChannelCreateWithConfig](HcommChannelCreateWithConfig.md)接口创建通信通道时传入共享Jetty等高级配置。 |
| 24 | 24 | ||
| 25 | 配置对象创建后，可通过[HcommChannelConfigSetInt](HcommChannelConfigSetInt.md)设置属性，使用完毕后须通过[HcommChannelConfigDestroy](HcommChannelConfigDestroy.md)销毁。 | 25 | 配置对象创建后，可通过[HcommChannelConfigSetInt](HcommChannelConfigSetInt.md)设置属性，使用完毕后须通过[HcommChannelConfigDestroy](HcommChannelConfigDestroy.md)销毁。 |
| 26 | 26 | ||
| @@ -34,7 +34,7 @@ HcommResult HcommChannelConfigCreate(HcommChannelConfig *config) | |||
| 34 | 34 | ||
| 35 | | 参数名 | 输入/输出 | 描述 | | 35 | | 参数名 | 输入/输出 | 描述 | |
| 36 | | --- | --- | --- | | 36 | | --- | --- | --- | |
| 37 | -| config | 输出 | Channel 配置对象的不透明句柄。<br>HcommChannelConfig类型的定义请参见[HcommChannelConfig](../../datatype_definition/HcommChannelConfig.md)。<br>调用者仅需传入指针，由接口内部分配并返回句柄。 | | 37 | +| config | 输出 | Channel配置对象的不透明句柄。<br>HcommChannelConfig类型的定义请参见[HcommChannelConfig](../../datatype_definition/HcommChannelConfig.md)。<br>调用者仅需传入指针，由接口内部分配并返回句柄。 | |
| 38 | 38 | ||
| 39 | ## 返回值 | 39 | ## 返回值 |
| 40 | 40 | ||
| @@ -20,7 +20,7 @@ | |||
| 20 | 20 | ||
| 21 | ## 功能说明 | 21 | ## 功能说明 |
| 22 | 22 | ||
| 23 | -销毁通过[HcommChannelConfigCreate](HcommChannelConfigCreate.md)创建的 Channel 配置对象，释放其占用的内存资源。 | 23 | +销毁通过[HcommChannelConfigCreate](HcommChannelConfigCreate.md)创建的Channel配置对象，释放其占用的内存资源。 |
| 24 | 24 | ||
| 25 | ## 函数原型 | 25 | ## 函数原型 |
| 26 | 26 | ||
| @@ -32,7 +32,7 @@ HcommResult HcommChannelConfigDestroy(HcommChannelConfig config) | |||
| 32 | 32 | ||
| 33 | | 参数名 | 输入/输出 | 描述 | | 33 | | 参数名 | 输入/输出 | 描述 | |
| 34 | | --- | --- | --- | | 34 | | --- | --- | --- | |
| 35 | -| config | 输入 | 待销毁的 Channel 配置对象句柄。<br>HcommChannelConfig类型的定义请参见[HcommChannelConfig](../../datatype_definition/HcommChannelConfig.md)。<br>传入nullptr时直接返回成功，不会触发错误。 | | 35 | +| config | 输入 | 待销毁的Channel配置对象句柄。<br>HcommChannelConfig类型的定义请参见[HcommChannelConfig](../../datatype_definition/HcommChannelConfig.md)。<br>传入nullptr时直接返回成功，不会触发错误。 | |
| 36 | 36 | ||
| 37 | ## 返回值 | 37 | ## 返回值 |
| 38 | 38 | ||
| @@ -20,7 +20,7 @@ | |||
| 20 | 20 | ||
| 21 | ## 功能说明 | 21 | ## 功能说明 |
| 22 | 22 | ||
| 23 | -设置 Channel 配置对象的整型属性。目前支持的属性类型请参见[HcommChannelConfigType](../../datatype_definition/HcommChannelConfigType.md)。 | 23 | +设置Channel配置对象的整型属性。目前支持的属性类型请参见[HcommChannelConfigType](../../datatype_definition/HcommChannelConfigType.md)。 |
| 24 | 24 | ||
| 25 | ## 函数原型 | 25 | ## 函数原型 |
| 26 | 26 | ||
| @@ -32,7 +32,7 @@ HcommResult HcommChannelConfigSetInt(HcommChannelConfig config, HcommChannelConf | |||
| 32 | 32 | ||
| 33 | | 参数名 | 输入/输出 | 描述 | | 33 | | 参数名 | 输入/输出 | 描述 | |
| 34 | | --- | --- | --- | | 34 | | --- | --- | --- | |
| 35 | -| config | 输入 | Channel 配置对象句柄，须通过[HcommChannelConfigCreate](HcommChannelConfigCreate.md)创建。 | | 35 | +| config | 输入 | Channel配置对象句柄，须通过[HcommChannelConfigCreate](HcommChannelConfigCreate.md)创建。 | |
| 36 | | type | 输入 | 属性类型枚举值。<br>HcommChannelConfigType类型的定义请参见[HcommChannelConfigType](../../datatype_definition/HcommChannelConfigType.md)。 | | 36 | | type | 输入 | 属性类型枚举值。<br>HcommChannelConfigType类型的定义请参见[HcommChannelConfigType](../../datatype_definition/HcommChannelConfigType.md)。 | |
| 37 | | value | 输入 | 属性值。对于bool类型属性，0表示false，非0表示true。 | | 37 | | value | 输入 | 属性值。对于bool类型属性，0表示false，非0表示true。 | |
| 38 | 38 | ||
Mdocs/zh/api_ref/comm_opdev/control_plane_api/basic_resource_mgmt/HcommChannelCreateWithConfig.md+8-8
| @@ -20,11 +20,11 @@ | |||
| 20 | 20 | ||
| 21 | ## 功能说明 | 21 | ## 功能说明 |
| 22 | 22 | ||
| 23 | -通过配置对象创建通信通道，是[HcommChannelCreate](HcommChannelCreate.md)的增强版本，支持通过配置对象传入共享 Jetty 等高级配置。 | 23 | +通过配置对象创建通信通道，是[HcommChannelCreate](HcommChannelCreate.md)的增强版本，支持通过配置对象传入共享Jetty等高级配置。 |
| 24 | 24 | ||
| 25 | 当config为nullptr或未设置IS_SHARED_QUEUE时，行为与[HcommChannelCreate](HcommChannelCreate.md)完全等价。 | 25 | 当config为nullptr或未设置IS_SHARED_QUEUE时，行为与[HcommChannelCreate](HcommChannelCreate.md)完全等价。 |
| 26 | 26 | ||
| 27 | -当config中IS_SHARED_QUEUE=true时，启用共享 Jetty 模式： | 27 | +当config中IS_SHARED_QUEUE=true时，启用共享Jetty模式： |
| 28 | - 使用相同endpointHandle多次调用本接口创建的Channel，若源目的endpointPair相同，则共享同一个底层Jetty资源，实现通信资源的复用。 | 28 | - 使用相同endpointHandle多次调用本接口创建的Channel，若源目的endpointPair相同，则共享同一个底层Jetty资源，实现通信资源的复用。 |
| 29 | - 适用于需要频繁创建/销毁通信通道的场景，可显著降低建链开销。 | 29 | - 适用于需要频繁创建/销毁通信通道的场景，可显著降低建链开销。 |
| 30 | 30 | ||
| @@ -43,9 +43,9 @@ HcommResult HcommChannelCreateWithConfig(EndpointHandle endpointHandle, CommEngi | |||
| 43 | | --- | --- | --- | | 43 | | --- | --- | --- | |
| 44 | | endpointHandle | 输入 | 网络设备端点句柄，标识一个已创建的本地网络设备端点。<br>EndpointHandle类型的定义请参见[EndpointHandle](../../datatype_definition/EndpointHandle.md)，该句柄必须通过[HcommEndpointCreate](HcommEndpointCreate.md)成功创建，且未销毁。 | | 44 | | endpointHandle | 输入 | 网络设备端点句柄，标识一个已创建的本地网络设备端点。<br>EndpointHandle类型的定义请参见[EndpointHandle](../../datatype_definition/EndpointHandle.md)，该句柄必须通过[HcommEndpointCreate](HcommEndpointCreate.md)成功创建，且未销毁。 | |
| 45 | | engine | 输入 | 通信引擎类型，指定通道的执行位置。<br>CommEngine类型的定义请参见[CommEngine](../../datatype_definition/CommEngine.md)。 | | 45 | | engine | 输入 | 通信引擎类型，指定通道的执行位置。<br>CommEngine类型的定义请参见[CommEngine](../../datatype_definition/CommEngine.md)。 | |
| 46 | -| channelDescs | 输入 | 通道描述符数组，每个元素描述一个待创建通道的属性信息。<br>HcommChannelDesc类型的定义可参见[HcommChannelDesc](../../datatype_definition/HcclChannelDesc.md)。 | | 46 | +| channelDescs | 输入 | 通道描述符数组，每个元素描述一个待创建通道的属性信息。<br>HcommChannelDesc类型的定义请参见[HcommChannelDesc](../../datatype_definition/HcommChannelDesc.md)。 | |
| 47 | | channelNum | 输入 | 待创建的通道数量，取值范围：[1, 1048576]。 | | 47 | | channelNum | 输入 | 待创建的通道数量，取值范围：[1, 1048576]。 | |
| 48 | -| config | 输入 | Channel 配置对象指针，可为nullptr（等价于[HcommChannelCreate](HcommChannelCreate.md)）。<br>HcommChannelConfig类型的定义请参见[HcommChannelConfig](../../datatype_definition/HcommChannelConfig.md)。<br>通过[HcommChannelConfigCreate](HcommChannelConfigCreate.md)创建。 | | 48 | +| config | 输入 | Channel配置对象指针，可为nullptr（等价于[HcommChannelCreate](HcommChannelCreate.md)）。<br>HcommChannelConfig类型的定义请参见[HcommChannelConfig](../../datatype_definition/HcommChannelConfig.md)。<br>通过[HcommChannelConfigCreate](HcommChannelConfigCreate.md)创建。 | |
| 49 | | channels | 输出 | 通道句柄数组，用于返回创建成功的通道句柄列表。<br>ChannelHandle类型的定义请参见[ChannelHandle](../../datatype_definition/ChannelHandle.md)。<br>调用者分配的数组，需要至少包含channelNum个元素的空间。 | | 49 | | channels | 输出 | 通道句柄数组，用于返回创建成功的通道句柄列表。<br>ChannelHandle类型的定义请参见[ChannelHandle](../../datatype_definition/ChannelHandle.md)。<br>调用者分配的数组，需要至少包含channelNum个元素的空间。 | |
| 50 | 50 | ||
| 51 | ## 返回值 | 51 | ## 返回值 |
| @@ -89,13 +89,13 @@ HcommResult：接口成功返回0，其他失败。 | |||
| 89 | 89 | ||
| 90 | ## 调用示例 | 90 | ## 调用示例 |
| 91 | 91 | ||
| 92 | -以共享 Jetty 模式创建 AIV 通信通道为例： | 92 | +以共享Jetty模式创建AIV通信通道为例： |
| 93 | 93 | ||
| 94 | ```c | 94 | ```c |
| 95 | EndpointHandle endpointHandle = nullptr; | 95 | EndpointHandle endpointHandle = nullptr; |
| 96 | // ... 创建端点的代码（省略） | 96 | // ... 创建端点的代码（省略） |
| 97 | 97 | ||
| 98 | -// 1. 创建并配置 Channel 配置对象 | 98 | +// 1. 创建并配置Channel配置对象 |
| 99 | HcommChannelConfig config = nullptr; | 99 | HcommChannelConfig config = nullptr; |
| 100 | HcommChannelConfigCreate(&config); | 100 | HcommChannelConfigCreate(&config); |
| 101 | HcommChannelConfigSetInt(config, HCOMM_CHANNEL_CONFIG_TYPE_IS_SHARED_QUEUE, 1); | 101 | HcommChannelConfigSetInt(config, HCOMM_CHANNEL_CONFIG_TYPE_IS_SHARED_QUEUE, 1); |
| @@ -107,7 +107,7 @@ ChannelHandle channels[CHANNEL_NUM] = {0}; | |||
| 107 | for (uint32_t i = 0; i < CHANNEL_NUM; i++) { | 107 | for (uint32_t i = 0; i < CHANNEL_NUM; i++) { |
| 108 | HcommChannelDescInit(&channelDescs[i]); | 108 | HcommChannelDescInit(&channelDescs[i]); |
| 109 | channelDescs[i].remoteEndpoint.protocol = COMM_PROTOCOL_UBC_TP; | 109 | channelDescs[i].remoteEndpoint.protocol = COMM_PROTOCOL_UBC_TP; |
| 110 | - // 填充 localEndpoint / remoteEndpoint ... | 110 | + // 填充localEndpoint / remoteEndpoint ... |
| 111 | } | 111 | } |
| 112 | 112 | ||
| 113 | // 3. 使用配置创建通信通道 | 113 | // 3. 使用配置创建通信通道 |
| @@ -123,5 +123,5 @@ if (ret != 0) { | |||
| 123 | // 4. 销毁配置对象（Channel已创建，配置对象不再需要） | 123 | // 4. 销毁配置对象（Channel已创建，配置对象不再需要） |
| 124 | HcommChannelConfigDestroy(config); | 124 | HcommChannelConfigDestroy(config); |
| 125 | 125 | ||
| 126 | -// 5. 后续通过 HcommChannelGetStatus 推动建链状态机 | 126 | +// 5. 后续通过HcommChannelGetStatus推动建链状态机 |
| 127 | ``` | 127 | ``` |
| @@ -20,12 +20,12 @@ | |||
| 20 | 20 | ||
| 21 | ## 功能说明 | 21 | ## 功能说明 |
| 22 | 22 | ||
| 23 | -基于通信域和配置对象创建通信通道，是[HcclChannelAcquire](HcclChannelAcquire.md)的增强版本，支持通过配置对象传入共享 Jetty 等高级配置。 | 23 | +基于通信域和配置对象创建通信通道，是[HcclChannelAcquire](HcclChannelAcquire.md)的增强版本，支持通过配置对象传入共享Jetty等高级配置。 |
| 24 | 24 | ||
| 25 | 当config为nullptr或未设置IS_SHARED_QUEUE时，行为与[HcclChannelAcquire](HcclChannelAcquire.md)完全等价。 | 25 | 当config为nullptr或未设置IS_SHARED_QUEUE时，行为与[HcclChannelAcquire](HcclChannelAcquire.md)完全等价。 |
| 26 | 26 | ||
| 27 | -当config中IS_SHARED_QUEUE=true时，启用共享 Jetty 模式： | 27 | +当config中IS_SHARED_QUEUE=true时，启用共享Jetty模式： |
| 28 | -- 使用相同 SHARED_QUEUE_TAG 多次调用本接口创建的 Channel，若源目的 endpointPair 相同，则共享同一个底层 Jetty 资源，实现通信资源的复用。 | 28 | +- 使用相同SHARED_QUEUE_TAG多次调用本接口创建的Channel，若源目的endpointPair相同，则共享同一个底层Jetty资源，实现通信资源的复用。 |
| 29 | - 适用于需要频繁创建/销毁通信通道的场景，可显著降低建链开销。 | 29 | - 适用于需要频繁创建/销毁通信通道的场景，可显著降低建链开销。 |
| 30 | 30 | ||
| 31 | ## 函数原型 | 31 | ## 函数原型 |
| @@ -40,10 +40,10 @@ HcclResult HcclChannelAcquireWithConfig(HcclComm comm, CommEngine engine, | |||
| 40 | | 参数名 | 输入/输出 | 描述 | | 40 | | 参数名 | 输入/输出 | 描述 | |
| 41 | | --- | --- | --- | | 41 | | --- | --- | --- | |
| 42 | | comm | 输入 | 通信域句柄。<br>HcclComm类型的定义如下：<br>typedef void *HcclComm; | | 42 | | comm | 输入 | 通信域句柄。<br>HcclComm类型的定义如下：<br>typedef void *HcclComm; | |
| 43 | -| engine | 输入 | 通信引擎类型。<br>CommEngine类型的定义可参见[CommEngine](../../datatype_definition/CommEngine.md)。 | | 43 | +| engine | 输入 | 通信引擎类型。<br>CommEngine类型的定义请参见[CommEngine](../../datatype_definition/CommEngine.md)。 | |
| 44 | -| channelDescs | 输入 | 通信通道描述列表，列表长度为channelNum。<br>HcclChannelDesc类型的定义可参见[HcclChannelDesc](../../datatype_definition/HcclChannelDesc.md)。<br>**必须使用[HcclChannelDescInit](HcclChannelDescInit.md)进行初始化。** | | 44 | +| channelDescs | 输入 | 通信通道描述列表，列表长度为channelNum。<br>HcclChannelDesc类型的定义请参见[HcclChannelDesc](../../datatype_definition/HcclChannelDesc.md)。<br>**必须使用[HcclChannelDescInit](HcclChannelDescInit.md)进行初始化。** | |
| 45 | | channelNum | 输入 | 通信通道数量，取值范围为(0, 1024 * 1024]。 | | 45 | | channelNum | 输入 | 通信通道数量，取值范围为(0, 1024 * 1024]。 | |
| 46 | -| config | 输入 | Channel 配置对象指针，可为nullptr（等价于[HcclChannelAcquire](HcclChannelAcquire.md)）。<br>HcclChannelConfig类型的定义请参见[HcclChannelConfig](../../datatype_definition/HcclChannelConfig.md)。<br>通过[HcclChannelConfigCreate](HcclChannelConfigCreate.md)创建。 | | 46 | +| config | 输入 | Channel配置对象指针，可为nullptr（等价于[HcclChannelAcquire](HcclChannelAcquire.md)）。<br>HcclChannelConfig类型的定义请参见[HcclChannelConfig](../../datatype_definition/HcclChannelConfig.md)。<br>通过[HcclChannelConfigCreate](HcclChannelConfigCreate.md)创建。 | |
| 47 | | channels | 输出 | 通信通道句柄列表，列表长度为channelNum。 | | 47 | | channels | 输出 | 通信通道句柄列表，列表长度为channelNum。 | |
| 48 | 48 | ||
| 49 | ## 返回值 | 49 | ## 返回值 |
| @@ -60,10 +60,10 @@ HcclResult HcclChannelAcquireWithConfig(HcclComm comm, CommEngine engine, | |||
| 60 | - 仅支持AIV引擎。 | 60 | - 仅支持AIV引擎。 |
| 61 | - 仅支持UB网络语义协议（COMM_PROTOCOL_UBC_CTP、COMM_PROTOCOL_UBC_TP），不支持UBMem/RoCE/UBOE/UBG。 | 61 | - 仅支持UB网络语义协议（COMM_PROTOCOL_UBC_CTP、COMM_PROTOCOL_UBC_TP），不支持UBMem/RoCE/UBOE/UBG。 |
| 62 | - 必须设置SHARED_QUEUE_TAG（非空字符串）。 | 62 | - 必须设置SHARED_QUEUE_TAG（非空字符串）。 |
| 63 | - - channelDescs中所有元素的localEndpoint必须相同（复用的 Jetty 只能关联一个 endpoint）。 | 63 | + - channelDescs中所有元素的localEndpoint必须相同（复用的Jetty只能关联一个endpoint）。 |
| 64 | - 仅支持V2通信器（需通过HcclCommInitClusterInfoConfig等V2接口创建通信域）。 | 64 | - 仅支持V2通信器（需通过HcclCommInitClusterInfoConfig等V2接口创建通信域）。 |
| 65 | 65 | ||
| 66 | -4. 共享 Jetty 模式下，相同tag+endpointPair的Channel复用规则： | 66 | +4. 共享Jetty模式下，相同tag+endpointPair的Channel复用规则： |
| 67 | - 重复调用时，若已有Channel数量不足则创建新的补充，足够则直接按序返回已有Channel。 | 67 | - 重复调用时，若已有Channel数量不足则创建新的补充，足够则直接按序返回已有Channel。 |
| 68 | - Channel的销毁由通信域统一管理，调用者无需单独销毁。 | 68 | - Channel的销毁由通信域统一管理，调用者无需单独销毁。 |
| 69 | 69 | ||
| @@ -71,10 +71,10 @@ HcclResult HcclChannelAcquireWithConfig(HcclComm comm, CommEngine engine, | |||
| 71 | 71 | ||
| 72 | ## 调用示例 | 72 | ## 调用示例 |
| 73 | 73 | ||
| 74 | -以共享 Jetty 模式创建 AIV 通信通道为例： | 74 | +以共享Jetty模式创建AIV通信通道为例： |
| 75 | 75 | ||
| 76 | ```c | 76 | ```c |
| 77 | -// 1. 创建并配置 Channel 配置对象 | 77 | +// 1. 创建并配置Channel配置对象 |
| 78 | HcclChannelConfig config = nullptr; | 78 | HcclChannelConfig config = nullptr; |
| 79 | HcclChannelConfigCreate(&config); | 79 | HcclChannelConfigCreate(&config); |
| 80 | HcclChannelConfigSetInt(config, HCCL_CHANNEL_CONFIG_TYPE_IS_SHARED_QUEUE, 1); | 80 | HcclChannelConfigSetInt(config, HCCL_CHANNEL_CONFIG_TYPE_IS_SHARED_QUEUE, 1); |
| @@ -88,7 +88,7 @@ for (uint32_t i = 0; i < CHANNEL_NUM; i++) { | |||
| 88 | HcclChannelDescInit(&channelDescs[i], 1); | 88 | HcclChannelDescInit(&channelDescs[i], 1); |
| 89 | channelDescs[i].remoteRank = remoteRanks[i]; | 89 | channelDescs[i].remoteRank = remoteRanks[i]; |
| 90 | channelDescs[i].channelProtocol = COMM_PROTOCOL_UBC_TP; | 90 | channelDescs[i].channelProtocol = COMM_PROTOCOL_UBC_TP; |
| 91 | - // 填充 localEndpoint / remoteEndpoint ... | 91 | + // 填充localEndpoint / remoteEndpoint ... |
| 92 | } | 92 | } |
| 93 | 93 | ||
| 94 | // 3. 使用配置创建通信通道 | 94 | // 3. 使用配置创建通信通道 |
| @@ -103,7 +103,7 @@ if (ret != HCCL_SUCCESS) { | |||
| 103 | // 4. 销毁配置对象（Channel已创建，配置对象不再需要） | 103 | // 4. 销毁配置对象（Channel已创建，配置对象不再需要） |
| 104 | HcclChannelConfigDestroy(config); | 104 | HcclChannelConfigDestroy(config); |
| 105 | 105 | ||
| 106 | -// 5. 后续可重复调用，相同tag的channel会复用底层Jetty | 106 | +// 5. 后续可重复调用，相同tag的Channel会复用底层Jetty |
| 107 | // HcclChannelAcquireWithConfig(comm, COMM_ENGINE_AIV, | 107 | // HcclChannelAcquireWithConfig(comm, COMM_ENGINE_AIV, |
| 108 | // channelDescs2, CHANNEL_NUM2, config2, channels2); | 108 | // channelDescs2, CHANNEL_NUM2, config2, channels2); |
| 109 | ``` | 109 | ``` |
Mdocs/zh/api_ref/comm_opdev/control_plane_api/comms_domain_resource_mgmt/HcclChannelConfigCreate.md+3-3
| @@ -20,7 +20,7 @@ | |||
| 20 | 20 | ||
| 21 | ## 功能说明 | 21 | ## 功能说明 |
| 22 | 22 | ||
| 23 | -创建 Channel 配置对象，用于[HcclChannelAcquireWithConfig](HcclChannelAcquireWithConfig.md)接口创建通信通道时传入共享 Jetty 等高级配置。 | 23 | +创建Channel配置对象，用于[HcclChannelAcquireWithConfig](HcclChannelAcquireWithConfig.md)接口创建通信通道时传入共享Jetty等高级配置。 |
| 24 | 24 | ||
| 25 | 配置对象创建后，可通过[HcclChannelConfigSetInt](HcclChannelConfigSetInt.md)和[HcclChannelConfigSetStr](HcclChannelConfigSetStr.md)设置属性，使用完毕后须通过[HcclChannelConfigDestroy](HcclChannelConfigDestroy.md)销毁。 | 25 | 配置对象创建后，可通过[HcclChannelConfigSetInt](HcclChannelConfigSetInt.md)和[HcclChannelConfigSetStr](HcclChannelConfigSetStr.md)设置属性，使用完毕后须通过[HcclChannelConfigDestroy](HcclChannelConfigDestroy.md)销毁。 |
| 26 | 26 | ||
| @@ -33,8 +33,8 @@ HcclResult HcclChannelConfigCreate(HcclChannelConfig *config) | |||
| 33 | ## 参数说明 | 33 | ## 参数说明 |
| 34 | 34 | ||
| 35 | | 参数名 | 输入/输出 | 描述 | | 35 | | 参数名 | 输入/输出 | 描述 | |
| 36 | -| | --- | --- | | 36 | +| --- | --- | --- | |
| 37 | -| config | 输出 | Channel 配置对象的不透明句柄。<br>HcclChannelConfig类型的定义请参见[HcclChannelConfig](../../datatype_definition/HcclChannelConfig.md)。<br>调用者仅需传入指针，由接口内部分配并返回句柄。 | | 37 | +| config | 输出 | Channel配置对象的不透明句柄。<br>HcclChannelConfig类型的定义请参见[HcclChannelConfig](../../datatype_definition/HcclChannelConfig.md)。<br>调用者仅需传入指针，由接口内部分配并返回句柄。 | |
| 38 | 38 | ||
| 39 | ## 返回值 | 39 | ## 返回值 |
| 40 | 40 | ||
Mdocs/zh/api_ref/comm_opdev/control_plane_api/comms_domain_resource_mgmt/HcclChannelConfigDestroy.md+3-3
| @@ -20,7 +20,7 @@ | |||
| 20 | 20 | ||
| 21 | ## 功能说明 | 21 | ## 功能说明 |
| 22 | 22 | ||
| 23 | -销毁通过[HcclChannelConfigCreate](HcclChannelConfigCreate.md)创建的 Channel 配置对象，释放其占用的内存资源。 | 23 | +销毁通过[HcclChannelConfigCreate](HcclChannelConfigCreate.md)创建的Channel配置对象，释放其占用的内存资源。 |
| 24 | 24 | ||
| 25 | ## 函数原型 | 25 | ## 函数原型 |
| 26 | 26 | ||
| @@ -31,8 +31,8 @@ HcclResult HcclChannelConfigDestroy(HcclChannelConfig config) | |||
| 31 | ## 参数说明 | 31 | ## 参数说明 |
| 32 | 32 | ||
| 33 | | 参数名 | 输入/输出 | 描述 | | 33 | | 参数名 | 输入/输出 | 描述 | |
| 34 | -| | --- | --- | | 34 | +| --- | --- | --- | |
| 35 | -| config | 输入 | 待销毁的 Channel 配置对象句柄。<br>HcclChannelConfig类型的定义请参见[HcclChannelConfig](../../datatype_definition/HcclChannelConfig.md)。<br>传入nullptr时直接返回成功，不会触发错误。 | | 35 | +| config | 输入 | 待销毁的Channel配置对象句柄。<br>HcclChannelConfig类型的定义请参见[HcclChannelConfig](../../datatype_definition/HcclChannelConfig.md)。<br>传入nullptr时直接返回成功，不会触发错误。 | |
| 36 | 36 | ||
| 37 | ## 返回值 | 37 | ## 返回值 |
| 38 | 38 | ||
Mdocs/zh/api_ref/comm_opdev/control_plane_api/comms_domain_resource_mgmt/HcclChannelConfigSetInt.md+3-3
| @@ -20,7 +20,7 @@ | |||
| 20 | 20 | ||
| 21 | ## 功能说明 | 21 | ## 功能说明 |
| 22 | 22 | ||
| 23 | -设置 Channel 配置对象的整型属性。目前支持的属性类型请参见[HcclChannelConfigType](../../datatype_definition/HcclChannelConfigType.md)。 | 23 | +设置Channel配置对象的整型属性。目前支持的属性类型请参见[HcclChannelConfigType](../../datatype_definition/HcclChannelConfigType.md)。 |
| 24 | 24 | ||
| 25 | ## 函数原型 | 25 | ## 函数原型 |
| 26 | 26 | ||
| @@ -31,8 +31,8 @@ HcclResult HcclChannelConfigSetInt(HcclChannelConfig config, HcclChannelConfigTy | |||
| 31 | ## 参数说明 | 31 | ## 参数说明 |
| 32 | 32 | ||
| 33 | | 参数名 | 输入/输出 | 描述 | | 33 | | 参数名 | 输入/输出 | 描述 | |
| 34 | -| | --- | --- | | 34 | +| --- | --- | --- | |
| 35 | -| config | 输入 | Channel 配置对象句柄，须通过[HcclChannelConfigCreate](HcclChannelConfigCreate.md)创建。 | | 35 | +| config | 输入 | Channel配置对象句柄，须通过[HcclChannelConfigCreate](HcclChannelConfigCreate.md)创建。 | |
| 36 | | type | 输入 | 属性类型枚举值。<br>HcclChannelConfigType类型的定义请参见[HcclChannelConfigType](../../datatype_definition/HcclChannelConfigType.md)。 | | 36 | | type | 输入 | 属性类型枚举值。<br>HcclChannelConfigType类型的定义请参见[HcclChannelConfigType](../../datatype_definition/HcclChannelConfigType.md)。 | |
| 37 | | value | 输入 | 属性值。对于bool类型属性，0表示false，非0表示true。 | | 37 | | value | 输入 | 属性值。对于bool类型属性，0表示false，非0表示true。 | |
| 38 | 38 | ||
Mdocs/zh/api_ref/comm_opdev/control_plane_api/comms_domain_resource_mgmt/HcclChannelConfigSetStr.md+3-3
| @@ -20,7 +20,7 @@ | |||
| 20 | 20 | ||
| 21 | ## 功能说明 | 21 | ## 功能说明 |
| 22 | 22 | ||
| 23 | -设置 Channel 配置对象的字符串型属性。目前支持的属性类型请参见[HcclChannelConfigType](../../datatype_definition/HcclChannelConfigType.md)。 | 23 | +设置Channel配置对象的字符串型属性。目前支持的属性类型请参见[HcclChannelConfigType](../../datatype_definition/HcclChannelConfigType.md)。 |
| 24 | 24 | ||
| 25 | ## 函数原型 | 25 | ## 函数原型 |
| 26 | 26 | ||
| @@ -31,8 +31,8 @@ HcclResult HcclChannelConfigSetStr(HcclChannelConfig config, HcclChannelConfigTy | |||
| 31 | ## 参数说明 | 31 | ## 参数说明 |
| 32 | 32 | ||
| 33 | | 参数名 | 输入/输出 | 描述 | | 33 | | 参数名 | 输入/输出 | 描述 | |
| 34 | -| | --- | --- | | 34 | +| --- | --- | --- | |
| 35 | -| config | 输入 | Channel 配置对象句柄，须通过[HcclChannelConfigCreate](HcclChannelConfigCreate.md)创建。 | | 35 | +| config | 输入 | Channel配置对象句柄，须通过[HcclChannelConfigCreate](HcclChannelConfigCreate.md)创建。 | |
| 36 | | type | 输入 | 属性类型枚举值。<br>HcclChannelConfigType类型的定义请参见[HcclChannelConfigType](../../datatype_definition/HcclChannelConfigType.md)。 | | 36 | | type | 输入 | 属性类型枚举值。<br>HcclChannelConfigType类型的定义请参见[HcclChannelConfigType](../../datatype_definition/HcclChannelConfigType.md)。 | |
| 37 | | value | 输入 | 属性值字符串，以'\0'结尾。 | | 37 | | value | 输入 | 属性值字符串，以'\0'结尾。 | |
| 38 | 38 | ||
| @@ -2,7 +2,7 @@ | |||
| 2 | 2 | ||
| 3 | ## 功能说明 | 3 | ## 功能说明 |
| 4 | 4 | ||
| 5 | -Channel 配置对象的不透明句柄，用于[HcclChannelAcquireWithConfig](../control_plane_api/comms_domain_resource_mgmt/HcclChannelAcquireWithConfig.md)接口创建通信通道时传入共享 Jetty 等高级配置。 | 5 | +Channel配置对象的不透明句柄，用于[HcclChannelAcquireWithConfig](../control_plane_api/comms_domain_resource_mgmt/HcclChannelAcquireWithConfig.md)接口创建通信通道时传入共享Jetty等高级配置。 |
| 6 | 6 | ||
| 7 | ## 类型定义 | 7 | ## 类型定义 |
| 8 | 8 | ||
| @@ -2,7 +2,7 @@ | |||
| 2 | 2 | ||
| 3 | ## 功能说明 | 3 | ## 功能说明 |
| 4 | 4 | ||
| 5 | -Channel 配置属性类型枚举，用于[HcclChannelConfigSetInt](../control_plane_api/comms_domain_resource_mgmt/HcclChannelConfigSetInt.md)和[HcclChannelConfigSetStr](../control_plane_api/comms_domain_resource_mgmt/HcclChannelConfigSetStr.md)接口指定待设置的属性类型。 | 5 | +Channel配置属性类型枚举，用于[HcclChannelConfigSetInt](../control_plane_api/comms_domain_resource_mgmt/HcclChannelConfigSetInt.md)和[HcclChannelConfigSetStr](../control_plane_api/comms_domain_resource_mgmt/HcclChannelConfigSetStr.md)接口指定待设置的属性类型。 |
| 6 | 6 | ||
| 7 | ## 类型定义 | 7 | ## 类型定义 |
| 8 | 8 | ||
| @@ -20,4 +20,4 @@ typedef enum { | |||
| 20 | | --- | --- | --- | --- | | 20 | | --- | --- | --- | --- | |
| 21 | | HCCL_CHANNEL_CONFIG_TYPE_INVALID | -1 | 无效值，用于初始化校验。 | - | | 21 | | HCCL_CHANNEL_CONFIG_TYPE_INVALID | -1 | 无效值，用于初始化校验。 | - | |
| 22 | | HCCL_CHANNEL_CONFIG_TYPE_IS_SHARED_QUEUE | 0 | 是否启用共享队列模式（bool/int，默认0=false）。<br>设为true时，创建的多个Channel共享一个Jetty。<br>仅支持AIV引擎的UB网络语义协议（UBC_CTP/UBC_TP）。 | [HcclChannelConfigSetInt](../control_plane_api/comms_domain_resource_mgmt/HcclChannelConfigSetInt.md) | | 22 | | HCCL_CHANNEL_CONFIG_TYPE_IS_SHARED_QUEUE | 0 | 是否启用共享队列模式（bool/int，默认0=false）。<br>设为true时，创建的多个Channel共享一个Jetty。<br>仅支持AIV引擎的UB网络语义协议（UBC_CTP/UBC_TP）。 | [HcclChannelConfigSetInt](../control_plane_api/comms_domain_resource_mgmt/HcclChannelConfigSetInt.md) | |
| 23 | -| HCCL_CHANNEL_CONFIG_TYPE_SHARED_QUEUE_TAG | 1 | 共享队列的tag标识（string）。<br>仅IS_SHARED_QUEUE=true时有效，指定创建channel的tag。<br>重复调用时，使用相同tag创建出的channel共享一个jetty。 | [HcclChannelConfigSetStr](../control_plane_api/comms_domain_resource_mgmt/HcclChannelConfigSetStr.md) | | 23 | +| HCCL_CHANNEL_CONFIG_TYPE_SHARED_QUEUE_TAG | 1 | 共享队列的tag标识（string）。<br>仅IS_SHARED_QUEUE=true时有效，指定创建Channel的tag。<br>重复调用时，使用相同tag创建出的Channel共享一个Jetty。 | [HcclChannelConfigSetStr](../control_plane_api/comms_domain_resource_mgmt/HcclChannelConfigSetStr.md) | |
| @@ -2,7 +2,7 @@ | |||
| 2 | 2 | ||
| 3 | ## 功能说明 | 3 | ## 功能说明 |
| 4 | 4 | ||
| 5 | -Channel 配置对象的不透明句柄，用于[HcommChannelCreateWithConfig](../control_plane_api/basic_resource_mgmt/HcommChannelCreateWithConfig.md)接口创建通信通道时传入共享 Jetty 等高级配置。 | 5 | +Channel配置对象的不透明句柄，用于[HcommChannelCreateWithConfig](../control_plane_api/basic_resource_mgmt/HcommChannelCreateWithConfig.md)接口创建通信通道时传入共享Jetty等高级配置。 |
| 6 | 6 | ||
| 7 | ## 类型定义 | 7 | ## 类型定义 |
| 8 | 8 | ||
| @@ -2,7 +2,7 @@ | |||
| 2 | 2 | ||
| 3 | ## 功能说明 | 3 | ## 功能说明 |
| 4 | 4 | ||
| 5 | -Channel 配置属性类型枚举，用于[HcommChannelConfigSetInt](../control_plane_api/basic_resource_mgmt/HcommChannelConfigSetInt.md)接口指定待设置的属性类型。 | 5 | +Channel配置属性类型枚举，用于[HcommChannelConfigSetInt](../control_plane_api/basic_resource_mgmt/HcommChannelConfigSetInt.md)接口指定待设置的属性类型。 |
| 6 | 6 | ||
| 7 | ## 类型定义 | 7 | ## 类型定义 |
| 8 | 8 | ||