CAN Stream Functions

Classes
struct	HAL_CANStreamMessage
	Storage for CAN Stream Messages. More...
HAL_CANStreamHandle	HAL_CAN_OpenStreamSession (int32_t busId, uint32_t messageId, uint32_t messageIDMask, uint32_t maxMessages, int32_t *status)
	Opens a CAN stream.
void	HAL_CAN_CloseStreamSession (HAL_CANStreamHandle sessionHandle)
	Closes a CAN stream.
void	HAL_CAN_ReadStreamSession (HAL_CANStreamHandle sessionHandle, struct HAL_CANStreamMessage *messages, uint32_t messagesToRead, uint32_t *messagesRead, int32_t *status)
	Reads a CAN stream message.

Detailed Description

Function Documentation

HAL_CAN_CloseStreamSession()

void HAL_CAN_CloseStreamSession

(

HAL_CANStreamHandle

sessionHandle

)

Closes a CAN stream.

Parameters

sessionHandle

the session to close

HAL_CAN_OpenStreamSession()

HAL_CANStreamHandle HAL_CAN_OpenStreamSession	(	int32_t	busId,
		uint32_t	messageId,
		uint32_t	messageIDMask,
		uint32_t	maxMessages,
		int32_t *	status )

Opens a CAN stream.

Parameters

[in]	busId	the bus number
[in]	messageId	the message ID to read
[in]	messageIDMask	the message ID mask
[in]	maxMessages	the maximum number of messages to stream
[out]	status	Error status variable. 0 on success.

Returns

the stream handle

HAL_CAN_ReadStreamSession()

void HAL_CAN_ReadStreamSession	(	HAL_CANStreamHandle	sessionHandle,
		struct HAL_CANStreamMessage *	messages,
		uint32_t	messagesToRead,
		uint32_t *	messagesRead,
		int32_t *	status )

Reads a CAN stream message.

Parameters

[in]	sessionHandle	the session handle
[in]	messages	array of messages
[in]	messagesToRead	the max number of messages to read
[out]	messagesRead	the number of messages actually read
[out]	status	Error status variable. 0 on success.