CANOE SOME/IP IL函数API

前提：要使用CAPL函数，必须调用 SomeIP_IL.vmodule （在节点的配置里添加此库文件，.vmodule会自动适配32/64位）

1、Callback Functions 回调函数

Functions	Short Description
<OnSomeIpEventReceived>	CAPL handler to receive events. 接收事件的CAPL处理程序。
<OnSomeIpFieldNotification>	CAPL handler to receive field change notifications. 接收字段更改通知的CAPL处理程序。
<OnSomeIpMethodError>	A callback function with this signature must be passed to the CAPL function SomeIpCreateMethodCall. 带有此签名的回调函数必须传递给CAPL函数SomeIpCreateMethodCall。
<OnSomeIpMethodRequest>	CAPL handler to request a method. 请求方法的CAPL处理程序。
<OnSomeIpMethodResponse>	CAPL handler to response a method. 响应方法的CAPL处理程序。
<OnSomeIpPrepareEvent>	CAPL handler to prepare an event before sending. 在发送之前准备事件的CAPL处理程序。
OnSomeIpClientAepConnected	This callback gets called when a client-side SOME/IP Application Endpoint gets connected to a remote peer. 当客户端SOME/IP应用程序端点连接到远程对等点时，将调用此回调。
OnSomeIpNewServerAep	This callback gets called when a server-side SOME/IP Application Endpoint gets opened. 当打开服务器端SOME/IP应用程序端点时，将调用此回调。
OnSomeIpClosedIPv6TCPConnection	CAPL handler to be called after a IL’s TCP connection has been closed CAPL处理程序将在IL的TCP连接关闭后调用
OnSomeIpEstablishedIPv6TCPConnection	CAPL handler to be called after an incoming or outgoing TCP connection. 在传入或传出TCP连接后调用的CAPL处理程序。
OnSomeIpClosedTLSConnection	This callback will be called after a (D)TLS connection between the local endpoint and remote endpoint has been closed and it indicates whether the connection was closed by peer. 此回调将在本地端点和远程端点之间的(D)TLS连接关闭后调用，它指示连接是否被对等端关闭。
OnSomeIpEstablishedTLSConnection	This callback will be called after a (D)TLS connection between the local endpoint and remote endpoint has been established. 此回调将在本地端点和远程端点之间建立(D)TLS连接后调用。
OnSomeIpMessage	CAPL handler to receive SOME/IP messages. 接收SOME/IP消息的CAPL处理程序。
OnSomeIpProcessRxMessage	CAPL handler to be called when the IL has received a SOME/IP message. CAPL处理程序将在IL接收到SOME/IP消息时调用。
OnSomeIpProcessTxMessage	CAPL handler to be called when the IL wants to send a SOME/IP message. 当IL想要发送SOME/IP消息时调用的CAPL处理程序。
OnSomeIpSDClientEventGroupStatusChanged	CAPL handler to be called when the status of an Event Group changes. 当事件组的状态发生变化时调用的CAPL处理程序。
OnSomeIpSDClientServiceStatusChanged	CAPL handler to be called when the status of a service changes. 服务状态更改时调用的CAPL处理程序。
OnSomeIpSDServerEventGroupStatusChanged	CAPL handler to be called when a Client executes the Require Service or Release Service. 当客户端执行请求服务或释放服务时调用的CAPL处理程序。
OnSomeIpSDServerEventGroupStatusChangedIPv6	CAPL handler to be called when a Client executes the Require Service or Release Service. 当客户端执行请求服务或释放服务时调用的CAPL处理程序。

2、Client-Side API 客户端API

Functions	Short Description
SomeIpAddConsumedEventGroup	Adds an Event Group to a Consumed Service Instance 将事件组添加到使用的服务实例
SomeIpCallMethod	Sends a request to the server. 向服务器发送请求。
SomeIpCreateConsumedServiceInstance	Creates a Consumed Service Instance. 创建一个消费服务实例。
SomeIpCreateEventConsumer	Adds an Event Consumer to a Consumed Service Instance. 将事件使用者添加到消费服务实例。
SomeIpCreateFieldConsumer	Adds a Field Consumer to a Consumed Service Instance. 向已消费服务实例添加字段消费者。
SomeIpCreateMethodCall	Creates a method call. 创建一个方法调用。
SomeIpReleaseConsumedServiceInstance	Deletes a Consumed Service Instance. 删除已使用的服务实例。
SomeIpRemoveConsumedEventGroup	Removes an Event Group. 删除事件组。
SomeIpRemoveEventConsumer	Deletes an Event Consumer. 删除事件使用者。
SomeIpRemoveFieldConsumer	Deletes a Field Consumer. 删除字段消费者。
SomeIpRemoveMethodCall	Deletes a method call 删除方法调用

3、Control API 控制API

Functions	Short Description
SomeIpILControlGetStatus	Returns current status of SOME/IP IL. 返回SOME/IP IL的当前状态。
SomeIpILControlInit	Initializes the SOME/IP IL. 初始化SOME/IP IL。
SomeIpILControlResume	Starts to send periodic messages 开始发送周期消息
SomeIpILControlStart	Starts the SOME/IP IL. 启动SOME/IP IL。
SomeIpILControlStop	Stops the SOME/IP IL. 停止SOME/IP IL。
SomeIpILControlWait	Stops sending cyclic messages. 停止发送循环消息。

4、Endpoints 端点

Functions	Short Description
SomeIpCloseLocalApplicationEndpoint	Closes an application endpoint. 关闭应用程序端点。
SomeIpOpenLocalApplicationEndpoint	Opens an endpoint for SOME/IP. 为SOME/IP打开一个端点。
SomeIpTlsAuthenticateAsServerWithConfiguration	Starts the (D)TLS authentication handshake as server. 作为服务器启动(D)TLS认证握手。
SomeIpTlsAuthenticateAsClientWithConfiguration	Starts the (D)TLS authentication handshake as client. 作为客户端启动(D)TLS身份验证握手。

5、General Functions 通用函数

Functions	Short Description
SomeIpGetLastError	Interface to retrieve the last error which occurs in the SOME/IP IL. 接口，用于检索在SOME/IP IL中发生的最后一个错误。
SomeIpGetLastErrorText	Interface to retrieve the last error that occurred in the SOME/IP IL as string. 接口，以字符串形式检索在SOME/IP IL中发生的最后一个错误。
SomeIpGetSecurityValidationState	Returns the Security-Validation-State of a received SOME/IP message. 返回收到的SOME/IP消息的安全验证状态。
SomeIpSetProperty	Sets a property of the SOME/IP IL. 设置SOME/IP IL的属性。
SomeIpSetVerbosity	Sets the verbosity level of the SOME/IP IL. 设置SOME/IP IL的冗长级别。

6、Low-level API 低等级API

Functions	Short Description
SomeIpCreateMessage	Creates a SOME/IP message. 创建一个SOME/IP消息。
SomeIpOutputMessage	Sends a SOME/IP message. 发送一个SOME/IP消息。
SomeIpPostMessage	Posts a SOME/IP message. 发布一个SOME/IP消息。
SomeIpReleaseMessage	Deletes a SOME/IP message. 删除一个SOME/IP消息。

7、Raw Data Access 原始数据访问

Functions	Short Description
SomeIpGetData	Queries the raw data of a SOME/IP message. 查询SOME/IP消息的原始数据。
SomeIpSerializeMessage	Serializes the SOME/IP message including the header into a buffer. 将包含报头的SOME/IP消息序列化到缓冲区中。
SomeIpSetData	Sets the raw data of a SOME/IP message. 设置SOME/IP消息的原始数据。

8、Server-Side API  服务端 API

Functions	Short Description
SomeIpAddEvent	Adds an event to a Provided Service Instance. 将事件添加到提供的服务实例。
SomeIpAddEventToEventgroup	Assigns an event to an Event Group. 将事件分配给事件组。
SomeIpAddField	Adds a Field to a Provided Service Instance. 向提供的服务实例添加字段。
SomeIpAddFieldToEventgroup	Assigns a Field to an Event Group. 将字段分配给事件组。
SomeIpAddMethod	Adds a method to a Provided Service Instance. 向提供的服务实例添加方法。
SomeIpAddProvidedEventGroup	Adds an Event Group to a Provided Service Instance. 将事件组添加到提供的服务实例。
SomeIpCommitField	Commit field changes and send a field notification. 提交字段更改并发送字段通知。
SomeIpCreateProvidedServiceInstance	Creates a Provided Service Instance. 创建提供的服务实例。
SomeIpReleaseProvidedServiceInstance	Deletes a Provided Service Instance. 删除提供的服务实例。
SomeIpRemoveEvent	Removes an event from a Provided Service Instance. 从提供的服务实例中删除事件。
SomeIpRemoveEventFromEventgroup	Removes an event from an Event Group. 从事件组中删除事件。
SomeIpRemoveField	Removes a field from a Provided Service Instance. 从提供的服务实例中删除字段。
SomeIpRemoveFieldFromEventgroup	Removes a Field from an Event Group. 从事件组中删除字段。
SomeIpRemoveMethod	Removes a method from a Provided Service Instance. 从提供的服务实例中移除方法。
SomeIpRemoveProvidedEventGroup	Removes an Event Group from a Provided Service Instance. 从提供的服务实例中删除事件组。
SomeIpTriggerEvent	Triggers sending of an event. 触发事件的发送。

9、Service Discovery 服务发现

Functions	Short Description
SomeIpSDDesubscribeEventGroup	Informs the Remote-SD that Event Group is no longer needed. 通知Remote-SD不再需要事件组。
SomeIpSDReleaseService	Informs the local SD that the Remote Service is no longer needed. 通知本地SD不再需要远程服务。
SomeIpSDRequireService	Informs the local SD that the Remote Service is needed. 通知本地SD需要远程服务。
SomeIpSDSetServiceStatus	Informs the Service Discovery of the current status of a provided Service Instance. 通知服务发现所提供的服务实例的当前状态。
SomeIpSDSubscribeEventGroup	Sends a Subscribe message. 发送订阅消息。

10、Static Configuration 静态配置

Functions	Short Description
SomeIpProvidedEventGroupAddConsumer	Adds a consumer to a provided event group 将使用者添加到提供的事件组
SomeIpProvidedEventGroupRemoveConsumer	Removes a consumer from a provided event group 从提供的事件组中删除使用者
SomeIpProvidedEventsAndFieldsAddConsumer	Adds a consumer to a provided service instance 将使用者添加到所提供的服务实例
SomeIpProvidedEventsAndFieldsRemoveConsumer	Removes a consumer from a provided service instance 从提供的服务实例中移除使用者
SomeIpProvidedEventAddConsumer	Adds a consumer to a provided event 向提供的事件添加使用者
SomeIpProvidedEventRemoveConsumer	Removes a consumer from a provided event 从提供的事件中移除使用者
SomeIpProvidedFieldAddConsumer	Adds a consumer to a provided field 将使用者添加到提供的字段
SomeIpProvidedFieldRemoveConsumer	Removes a consumer from a provided field 从提供的字段中删除消费者
SomeIpSetMulticastReceiverEndpoints	Sets the multicast endpoint of a consumed event group 设置已使用事件组的多播端点
SomeIpSetProviderEndpoints	Sets the remote endpoints of a consumed service instance 设置所使用服务实例的远程端点

11、Symbolic Database Access 符号数据库访问

Functions	Short Description
SomeIpGetConsumedObjectHandle	Enables to search for a consumed object which has been created separately. 启用搜索已单独创建的已消费对象。
SomeIpGetProvidedObjectHandle	Enables to search for a provided object which has been created separately. 允许搜索单独创建的提供对象。
SomeIpRegisterCallback	Enables to register/unregister a CAPL callback function for an object which has been created separately. 允许为单独创建的对象注册/取消注册CAPL回调函数。

12、TCP Handling TCP处理

Functions	Short Description
SomeIpCloseEstablishedTCPConnection	Closes one or multiple database defined TCP connection(s). 关闭一个或多个数据库定义的TCP连接。
SomeIpEstablishTCPConnection	Establishes one or multiple database defined TCP connection(s). 建立一个或多个数据库定义的TCP连接。
SomeIpTCPListen	Listen on application endpoint 监听应用程序端点

13、Value Access 值访问

Functions	Short Description
SomeIpFillValues	Fills the fields of SOME/IP events, methods and fields with increasing values for test purposes. 用递增的值填充SOME/IP事件、方法和字段的字段，用于测试目的。
SomeIpGetDestinationAddress	Returns the IPv4 destination address. 返回IPv4目的地址。
SomeIpGetDestinationPort	Returns the destination port (UDP/TCP). 返回目的端口(UDP/TCP)。
SomeIpGetInterfaceVersion	Returns the Interface Version from the SOME/IP header. 从SOME/IP报头返回接口版本。
SomeIpGetLength	Returns the length in bytes that is in the SOME/IP header. 返回SOME/IP报头中的长度(以字节为单位)。
SomeIpGetMessageId	Returns the Message ID from the SOME/IP header. 从SOME/IP报头返回消息ID。
SomeIpGetMessageType	Returns the Message Type from the SOME/IP header. 从SOME/IP报头返回消息类型。
SomeIpGetProtocol	Returns the protocol (UDP/TCP) the SOME/IP message was transmitted with. 返回发送SOME/IP消息时使用的协议(UDP/TCP)。
SomeIpGetProtocolVersion	Returns the Protocol Version from the SOME/IP header. 从SOME/IP报头返回协议版本。
SomeIpGetRequestId	Returns the Request ID from the SOME/IP header. 从SOME/IP报头返回请求ID。
SomeIpGetReturnCode	Returns the Return Code from the SOME/IP header. 从SOME/IP报头返回返回码。
SomeIpGetSourceAddress	Returns the IPv4 sender address. 返回IPv4发送地址。
SomeIpGetSourcePort	Returns the Source Port (UDP/TCP). 返回源端口(UDP/TCP)。
SomeIpGetValueDWord	Gets the parameters of a SOME/IP message. 获取SOME/IP消息的参数。
SomeIpGetValueFloat	Gets the parameters of a SOME/IP message. 获取SOME/IP消息的参数。
SomeIpGetValueInt64	Gets the parameters of a SOME/IP message. 获取SOME/IP消息的参数。
SomeIpGetValueLong	Gets the parameters of a SOME/IP message. 获取SOME/IP消息的参数。
SomeIpGetValuePhys	Gets the physical parameters of a SOME/IP message. 获取SOME/IP消息的物理参数。
SomeIpGetValueQWord	Gets the parameters of a SOME/IP message. 获取SOME/IP消息的参数。
SomeIpGetValueString	Gets the string parameters of a SOME/IP message. 获取SOME/IP消息的字符串参数。
SomeIpIsOptional	Reads out if a parameter or member of the object is optional or mandatory. 读取对象的参数或成员是可选的还是强制的。
SomeIpRemoveValue	Removes the parameters of a SOME/IP message. 删除SOME/IP消息的参数。
SomeIpSetRequestId	Sets the Request ID. 设置请求ID。
SomeIpSetReturnCode	Sets the return code. 设置返回代码。
SomeIpSetValueDWord	Sets the parameters of a SOME/IP message. 设置SOME/IP消息的参数。
SomeIpSetValueFloat	Sets the parameters of a SOME/IP message. 设置SOME/IP消息的参数。
SomeIpSetValueInt64	Sets the parameters of a SOME/IP message. 设置SOME/IP消息的参数。
SomeIpSetValueLong	Sets the parameters of a SOME/IP message. 设置SOME/IP消息的参数。
SomeIpSetValuePhys	Sets the physical parameters of a SOME/IP message. 设置SOME/IP消息的物理参数。
SomeIpSetValueQWord	Sets the parameters of a SOME/IP message. 设置SOME/IP消息的参数。
SomeIpSetValueString	Sets the string parameters of a SOME/IP message. 设置SOME/IP消息的字符串参数。