isotp-c
Platform-independent ISO 15765-2 transport for embedded C
Loading...
Searching...
No Matches
Link status and protocol results

Observable state for asynchronous send and receive operations. More...

Macros

#define ISOTP_PROTOCOL_RESULT_OK   0
#define ISOTP_PROTOCOL_RESULT_TIMEOUT_A   -1
#define ISOTP_PROTOCOL_RESULT_TIMEOUT_BS   -2
#define ISOTP_PROTOCOL_RESULT_TIMEOUT_CR   -3
#define ISOTP_PROTOCOL_RESULT_WRONG_SN   -4
#define ISOTP_PROTOCOL_RESULT_INVALID_FS   -5
#define ISOTP_PROTOCOL_RESULT_UNEXP_PDU   -6
#define ISOTP_PROTOCOL_RESULT_WFT_OVRN   -7
#define ISOTP_PROTOCOL_RESULT_BUFFER_OVFLW   -8
#define ISOTP_PROTOCOL_RESULT_ERROR   -9

Enumerations

enum  IsoTpSendStatusTypes { ISOTP_SEND_STATUS_IDLE , ISOTP_SEND_STATUS_INPROGRESS , ISOTP_SEND_STATUS_ERROR }
enum  IsoTpReceiveStatusTypes { ISOTP_RECEIVE_STATUS_IDLE , ISOTP_RECEIVE_STATUS_INPROGRESS , ISOTP_RECEIVE_STATUS_FULL }

Detailed Description

Observable state for asynchronous send and receive operations.

Macro Definition Documentation

◆ ISOTP_PROTOCOL_RESULT_BUFFER_OVFLW

#define ISOTP_PROTOCOL_RESULT_BUFFER_OVFLW   -8

The sender reported overflow, or an incoming message exceeded the receive buffer.

Definition at line 389 of file isotp_defines.h.

◆ ISOTP_PROTOCOL_RESULT_ERROR

#define ISOTP_PROTOCOL_RESULT_ERROR   -9

Reserved generic protocol error; not currently produced.

Definition at line 391 of file isotp_defines.h.

◆ ISOTP_PROTOCOL_RESULT_INVALID_FS

#define ISOTP_PROTOCOL_RESULT_INVALID_FS   -5

Reserved result for invalid Flow Control status; not currently produced.

Definition at line 383 of file isotp_defines.h.

◆ ISOTP_PROTOCOL_RESULT_OK

#define ISOTP_PROTOCOL_RESULT_OK   0

Protocol operation completed without an error.

Definition at line 373 of file isotp_defines.h.

◆ ISOTP_PROTOCOL_RESULT_TIMEOUT_A

#define ISOTP_PROTOCOL_RESULT_TIMEOUT_A   -1

Reserved result for an N_As transmission timeout; not currently produced.

Definition at line 375 of file isotp_defines.h.

◆ ISOTP_PROTOCOL_RESULT_TIMEOUT_BS

#define ISOTP_PROTOCOL_RESULT_TIMEOUT_BS   -2

Timeout waiting for a Flow Control frame.

Definition at line 377 of file isotp_defines.h.

◆ ISOTP_PROTOCOL_RESULT_TIMEOUT_CR

#define ISOTP_PROTOCOL_RESULT_TIMEOUT_CR   -3

Timeout waiting for a Consecutive Frame.

Definition at line 379 of file isotp_defines.h.

◆ ISOTP_PROTOCOL_RESULT_UNEXP_PDU

#define ISOTP_PROTOCOL_RESULT_UNEXP_PDU   -6

A protocol data unit arrived in an incompatible link state.

Definition at line 385 of file isotp_defines.h.

◆ ISOTP_PROTOCOL_RESULT_WFT_OVRN

#define ISOTP_PROTOCOL_RESULT_WFT_OVRN   -7

The peer sent more Flow Control Wait frames than ISO_TP_MAX_WFT_NUMBER.

Definition at line 387 of file isotp_defines.h.

◆ ISOTP_PROTOCOL_RESULT_WRONG_SN

#define ISOTP_PROTOCOL_RESULT_WRONG_SN   -4

An incoming Consecutive Frame had the wrong sequence number.

Definition at line 381 of file isotp_defines.h.

Enumeration Type Documentation

◆ IsoTpReceiveStatusTypes

Current reassembly state stored in IsoTpLink::receive_status.

Enumerator
ISOTP_RECEIVE_STATUS_IDLE 

No message is being reassembled.

ISOTP_RECEIVE_STATUS_INPROGRESS 

Consecutive Frames are expected.

ISOTP_RECEIVE_STATUS_FULL 

A complete message or streaming chunk is available.

Definition at line 135 of file isotp_defines.h.

◆ IsoTpSendStatusTypes

Current segmented-transmission state stored in IsoTpLink::send_status.

Enumerator
ISOTP_SEND_STATUS_IDLE 

No segmented transmission is active.

ISOTP_SEND_STATUS_INPROGRESS 

Consecutive Frames or Flow Control are pending.

ISOTP_SEND_STATUS_ERROR 

Transmission stopped; inspect IsoTpLink::send_protocol_result.

Definition at line 128 of file isotp_defines.h.