Static Configuration
SomeIpProvidedEventAddConsumer
函数
向提供的事件添加消费者。之后,事件通知将发送到此消费者。
语法
capl
long SomeIpProvidedEventAddConsumer(dword pevHandle, dword remoteIPv4Address, dword remoteUDPPort, dword remoteTCPPort); // 形式1
long SomeIpProvidedEventAddConsumer(dword pevHandle, byte remoteIPv6Address[], dword remoteUDPPort, dword remoteTCPPort); // 形式2
long SomeIpProvidedEventAddConsumer(dword pevHandle, IP_Endpoint remoteIPEndpoint); // 形式3
参数
pevHandle:提供的事件句柄(可通过SomeIpGetProvidedObjectHandle获取)。remoteIPv4Address:消费者的IPv4地址(网络字节序)。remoteIPv6Address:消费者的IPv6地址。remoteUDPPort:消费者的UDP端口号(无则为0)。remoteTCPPort:消费者的TCP端口号(无则为0)。remoteIPEndpoint:包含消费者地址/端口的IP_Endpoint类型对象。
返回值
- 0:函数执行成功。
-
0:错误代码。
可用性
- 形式1-2:CANoe 11.0 SP3及以上,仅适用于以太网仿真/测试环境。
- 形式3:CANoe 12.0 SP2及以上,仅适用于以太网仿真/测试环境。
SomeIpProvidedEventGroupAddConsumer
函数
向提供的事件组添加消费者。之后,事件/字段通知将发送到此消费者。
语法
capl
long SomeIpProvidedEventGroupAddConsumer(dword pevgHandle, dword remoteIPv4Address, dword remoteUDPPort, dword remoteTCPPort); // 形式1
long SomeIpProvidedEventGroupAddConsumer(dword pevgHandle, byte remoteIPv6Address[], dword remoteUDPPort, dword remoteTCPPort); // 形式2
long SomeIpProvidedEventGroupAddConsumer(dword pevgHandle, IP_Endpoint remoteIPEndpoint); // 形式3
参数
pevgHandle:提供的事件组句柄(可通过SomeIpGetProvidedObjectHandle获取)。remoteIPv4Address:消费者的IPv4地址(网络字节序)。remoteIPv6Address:消费者的IPv6地址。remoteUDPPort:消费者的UDP端口号(无则为0)。remoteTCPPort:消费者的TCP端口号(无则为0)。remoteIPEndpoint:包含消费者地址/端口的IP_Endpoint类型对象。
返回值
- 0:函数执行成功。
-
0:错误代码。
可用性
- 形式1-2:CANoe 11.0 SP3及以上,仅适用于以太网仿真/测试环境。
- 形式3:CANoe 12.0 SP2及以上,仅适用于以太网仿真/测试环境。
SomeIpProvidedEventGroupRemoveConsumer
函数
从提供的事件组中移除消费者。之后,事件/字段通知将不再发送到此消费者。
语法
capl
long SomeIpProvidedEventGroupRemoveConsumer(dword pevgHandle, dword remoteIPv4Address, dword remoteUDPPort, dword remoteTCPPort); // 形式1
long SomeIpProvidedEventGroupRemoveConsumer(dword pevgHandle, byte remoteIPv6Address[], dword remoteUDPPort, dword remoteTCPPort); // 形式2
long SomeIpProvidedEventGroupRemoveConsumer(dword pevgHandle, IP_Endpoint remoteIPEndpoint); // 形式3
参数
pevgHandle:提供的事件组句柄(可通过SomeIpGetProvidedObjectHandle获取)。remoteIPv4Address:消费者的IPv4地址(网络字节序)。remoteIPv6Address:消费者的IPv6地址。remoteUDPPort:消费者的UDP端口号(无则为0)。remoteTCPPort:消费者的TCP端口号(无则为0)。remoteIPEndpoint:包含消费者地址/端口的IP_Endpoint类型对象。
返回值
- 0:函数执行成功。
-
0:错误代码。
可用性
- 形式1-2:CANoe 11.0 SP3及以上,仅适用于以太网仿真/测试环境。
- 形式3:CANoe 12.0 SP2及以上,仅适用于以太网仿真/测试环境。
SomeIpProvidedEventRemoveConsumer
函数
从提供的事件中移除通过 SomeIpProvidedEventAddConsumer 添加的消费者。
语法
capl
long SomeIpProvidedEventRemoveConsumer(dword pevHandle, dword remoteIPv4Address, dword remoteUDPPort, dword remoteTCPPort); // 形式1
long SomeIpProvidedEventRemoveConsumer(dword pevHandle, byte remoteIPv6Address[], dword remoteUDPPort, dword remoteTCPPort); // 形式2
long SomeIpProvidedEventRemoveConsumer(dword pevHandle, IP_Endpoint remoteIPEndpoint); // 形式3
参数
pevHandle:提供的事件句柄(可通过SomeIpGetProvidedObjectHandle获取)。remoteIPv4Address:消费者的IPv4地址(网络字节序)。remoteIPv6Address:消费者的IPv6地址。remoteUDPPort:消费者的UDP端口号(无则为0)。remoteTCPPort:消费者的TCP端口号(无则为0)。remoteIPEndpoint:包含消费者地址/端口的IP_Endpoint类型对象。
返回值
- 0:函数执行成功。
-
0:错误代码。
可用性
- 形式1-2:CANoe 11.0 SP3及以上,仅适用于以太网仿真/测试环境。
- 形式3:CANoe 12.0 SP2及以上,仅适用于以太网仿真/测试环境。
SomeIpProvidedEventsAndFieldsAddConsumer
函数
向提供的服务实例添加消费者。之后,该服务实例的所有事件/字段通知将发送到此消费者。
语法
capl
long SomeIpProvidedEventsAndFieldsAddConsumer(dword psiHandle, dword remoteIPv4Address, dword remoteUDPPort, dword remoteTCPPort); // 形式1
long SomeIpProvidedEventsAndFieldsAddConsumer(dword psiHandle, byte remoteIPv6Address[], dword remoteUDPPort, dword remoteTCPPort); // 形式2
long SomeIpProvidedEventsAndFieldsAddConsumer(dword psiHandle, IP_Endpoint remoteIPEndpoint); // 形式3
参数
psiHandle:提供的服务实例句柄(可通过SomeIpGetProvidedObjectHandle获取)。remoteIPv4Address:消费者的IPv4地址(网络字节序)。remoteIPv6Address:消费者的IPv6地址。remoteUDPPort:消费者的UDP端口号(无则为0)。remoteTCPPort:消费者的TCP端口号(无则为0)。remoteIPEndpoint:包含消费者地址/端口的IP_Endpoint类型对象。
返回值
- 0:函数执行成功。
-
0:错误代码。
可用性
- 形式1-2:CANoe 11.0 SP3及以上,仅适用于以太网仿真/测试环境。
- 形式3:CANoe 12.0 SP2及以上,仅适用于以太网仿真/测试环境。
SomeIpProvidedEventsAndFieldsRemoveConsumer
函数
从提供的服务实例中移除通过 SomeIpProvidedEventsAndFieldsAddConsumer 添加的消费者。
语法
capl
long SomeIpProvidedEventsAndFieldsRemoveConsumer(dword psiHandle, dword remoteIPv4Address, dword remoteUDPPort, dword remoteTCPPort); // 形式1
long SomeIpProvidedEventsAndFieldsRemoveConsumer(dword psiHandle, byte remoteIPv6Address[], dword remoteUDPPort, dword remoteTCPPort); // 形式2
long SomeIpProvidedEventsAndFieldsRemoveConsumer(dword psiHandle, IP_Endpoint remoteIPEndpoint); // 形式3
参数
psiHandle:提供的服务实例句柄(可通过SomeIpGetProvidedObjectHandle获取)。remoteIPv4Address:消费者的IPv4地址(网络字节序)。remoteIPv6Address:消费者的IPv6地址。remoteUDPPort:消费者的UDP端口号(无则为0)。remoteTCPPort:消费者的TCP端口号(无则为0)。remoteIPEndpoint:包含消费者地址/端口的IP_Endpoint类型对象。
返回值
- 0:函数执行成功。
-
0:错误代码。
可用性
- 形式1-2:CANoe 11.0 SP3及以上,仅适用于以太网仿真/测试环境。
- 形式3:CANoe 12.0 SP2及以上,仅适用于以太网仿真/测试环境。
SomeIpProvidedFieldAddConsumer
函数
向提供的字段添加消费者。之后,字段通知将发送到此消费者。
语法
capl
long SomeIpProvidedFieldAddConsumer(dword pfHandle, dword remoteIPv4Address, dword remoteUDPPort, dword remoteTCPPort); // 形式1
long SomeIpProvidedFieldAddConsumer(dword pfHandle, byte remoteIPv6Address[], dword remoteUDPPort, dword remoteTCPPort); // 形式2
long SomeIpProvidedFieldAddConsumer(dword pfHandle, IP_Endpoint remoteIPEndpoint); // 形式3
参数
pfHandle:提供的字段句柄(可通过SomeIpGetProvidedObjectHandle获取)。remoteIPv4Address:消费者的IPv4地址(网络字节序)。remoteIPv6Address:消费者的IPv6地址。remoteUDPPort:消费者的UDP端口号(无则为0)。remoteTCPPort:消费者的TCP端口号(无则为0)。remoteIPEndpoint:包含消费者地址/端口的IP_Endpoint类型对象。
返回值
- 0:函数执行成功。
-
0:错误代码。
可用性
- 形式1-2:CANoe 11.0 SP3及以上,仅适用于以太网仿真/测试环境。
- 形式3:CANoe 12.0 SP2及以上,仅适用于以太网仿真/测试环境。
SomeIpProvidedFieldRemoveConsumer
函数
从提供的字段中移除通过 SomeIpProvidedFieldAddConsumer 添加的消费者。
语法
capl
long SomeIpProvidedFieldRemoveConsumer(dword pfHandle, dword remoteIPv4Address, dword remoteUDPPort, dword remoteTCPPort); // 形式1
long SomeIpProvidedFieldRemoveConsumer(dword pfHandle, byte remoteIPv6Address[], dword remoteUDPPort, dword remoteTCPPort); // 形式2
long SomeIpProvidedFieldRemoveConsumer(dword pfHandle, IP_Endpoint remoteIPEndpoint); // 形式3
参数
pfHandle:提供的字段句柄(可通过SomeIpGetProvidedObjectHandle获取)。remoteIPv4Address:消费者的IPv4地址(网络字节序)。remoteIPv6Address:消费者的IPv6地址。remoteUDPPort:消费者的UDP端口号(无则为0)。remoteTCPPort:消费者的TCP端口号(无则为0)。remoteIPEndpoint:包含消费者地址/端口的IP_Endpoint类型对象。
返回值
- 0:函数执行成功。
-
0:错误代码。
可用性
- 形式1-2:CANoe 11.0 SP3及以上,仅适用于以太网仿真/测试环境。
- 形式3:CANoe 12.0 SP2及以上,仅适用于以太网仿真/测试环境。
SomeIpSetMulticastReceiverEndpoints
函数
为消费的事件组设置多播端点,用于通过多播接收字段/事件通知。
语法
capl
long SomeIpSetMulticastReceiverEndpoints(dword cevgHandle, dword multicastIPv4Address, dword udpPort); // 形式1
long SomeIpSetMulticastReceiverEndpoints(dword cevgHandle, byte multicastIPv6Address[], dword udpPort); // 形式2
long SomeIpSetMulticastReceiverEndpoints(dword cevgHandle, IP_Endpoint multicastIPEndpoint); // 形式3
参数
cevgHandle:消费的事件组句柄(可通过SomeIpGetConsumedObjectHandle获取)。multicastIPv4Address:接收事件/字段的多播IPv4地址(网络字节序)。multicastIPv6Address:接收事件/字段的多播IPv6地址。udpPort:接收事件/字段的UDP端口号(不再通过多播接收则为0)。multicastIPEndpoint:包含多播端点地址/端口的IP_Endpoint类型对象(端口为0时删除现有端点)。
返回值
- 0:函数执行成功。
-
0:错误代码。
可用性
- 形式1-2:CANoe 11.0 SP3及以上,仅适用于以太网仿真/测试环境。
- 形式3:CANoe 12.0 SP2及以上,仅适用于以太网仿真/测试环境。
SomeIpSetProviderEndpoints
函数
为消费的服务实例设置UDP和TCP端点,用于访问对应的提供的服务实例。
语法
capl
long SomeIpSetProviderEndpoints(dword csiHandle, dword remoteIPv4Address, dword remoteUDPPort, dword remoteTCPPort); // 形式1
long SomeIpSetProviderEndpoints(dword csiHandle, byte remoteIPv6Address[], dword remoteUDPPort, dword remoteTCPPort); // 形式2
long SomeIpSetProviderEndpoints(dword csiHandle, IP_Endpoint remoteIPEndpoint); // 形式3
参数
csiHandle:消费的服务实例句柄(可通过SomeIpGetConsumedObjectHandle获取)。remoteIPv4Address:提供者的IPv4地址(网络字节序)。remoteIPv6Address:提供者的IPv6地址。remoteUDPPort:提供者的UDP端口号(无则为0)。remoteTCPPort:提供者的TCP端口号(无则为0)。remoteIPEndpoint:包含提供者地址/端口的IP_Endpoint类型对象(端口为0时删除现有端点)。
返回值
- 0:函数执行成功。
-
0:错误代码。
可用性
- 形式1-2:CANoe 11.0 SP3及以上,仅适用于以太网仿真/测试环境。
- 形式3:CANoe 12.0 SP2及以上,仅适用于以太网仿真/测试环境。