State for one independent, full-duplex ISO-TP conversation. More...

#include <isotp.h>

Data Fields
int32_t	send_protocol_result
uint8_t	send_status
int	receive_protocol_result
uint8_t	receive_status
void *	user_send_can_arg

Detailed Description

State for one independent, full-duplex ISO-TP conversation.

Allocate one link for each conversation that can have independent send or receive state. Initialise it with isotp_init_link() before use and keep the object and its buffers alive for the complete lifetime of the link.

Calls that access the same link must be serialised. Applications may observe the documented status/result members and set user_send_can_arg when enabled; all other members are implementation state.

Examples: isotp_example_callbacks.c, isotp_example_can_fd.c, isotp_example_polling.c, and isotp_example_streaming.c.

Definition at line 48 of file isotp.h.

Field Documentation

◆ receive_protocol_result

int IsoTpLink::receive_protocol_result

Result of the current or most recent receive operation.

Definition at line 86 of file isotp.h.

◆ receive_status

uint8_t IsoTpLink::receive_status

Current IsoTpReceiveStatusTypes value. Prefer isotp_receive() to consume completed data.

Definition at line 88 of file isotp.h.

◆ send_protocol_result

int32_t IsoTpLink::send_protocol_result

Result of the current or most recent segmented transmission.

Definition at line 67 of file isotp.h.

◆ send_status

uint8_t IsoTpLink::send_status

Current IsoTpSendStatusTypes value.

Definition at line 69 of file isotp.h.

◆ user_send_can_arg

void* IsoTpLink::user_send_can_arg

Application value passed to isotp_user_send_can() for this link.

Set this after isotp_init_link(), which initially clears it to NULL. A CAN controller or driver context pointer is a typical value.

Examples: isotp_example_can_fd.c.

Definition at line 106 of file isotp.h.

The documentation for this struct was generated from the following file:

isotp.h