Message

Data Structures
struct	peak_message_info
	peak message info struct More...

Typedefs
typedef struct peak_message *	peak_message_handle
	peak queue handle The value for an invalid queue handle is PEAK_INVALID_HANDLE.

Functions
peak_status	peak_Message_Release (peak_message_handle hMessage)
	Release a message.
peak_status	peak_Message_GetInfo (peak_message_handle hMessage, peak_message_info *messageInfo)
	Get the info for a message.
peak_status	peak_Message_Type_Get (peak_message_handle hMessage, peak_message_type *messageType)
	Get the message type.
peak_status	peak_Message_CameraHandle_Get (peak_message_handle hMessage, peak_camera_handle *hCam)
	Get the camera handle for a message.
peak_status	peak_Message_ID_Get (peak_message_handle hMessage, uint64_t *messageID)
	Get the message id.
peak_status	peak_Message_HostTimestamp_Get (peak_message_handle hMessage, uint64_t *hostTimestamp_ns)
	Get the host timestamp for a message.

Detailed Description

Definitions on the Queue Message.

Function Documentation

peak_Message_CameraHandle_Get()

peak_status peak_Message_CameraHandle_Get	(	peak_message_handle	hMessage,
		peak_camera_handle *	hCam )

Get the camera handle for a message.

May be PEAK_INVALID_HANDLE if no camera is associated with the message.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	hCam	The camera handle of the origin camera or PEAK_INVALID_HANDLE if origin is not the camera e.g. the camera manager.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.

PEAK_STATUS_INVALID_PARAMETER hCam is an invalid pointer.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.5

peak_Message_GetInfo()

peak_status peak_Message_GetInfo	(	peak_message_handle	hMessage,
		peak_message_info *	messageInfo )

Get the info for a message.

See also peak_message_info for the message info struct.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	messageInfo	The message info.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.

PEAK_STATUS_INVALID_PARAMETER messageInfo is an invalid pointer.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.5

peak_Message_HostTimestamp_Get()

peak_status peak_Message_HostTimestamp_Get	(	peak_message_handle	hMessage,
		uint64_t *	hostTimestamp_ns )

Get the host timestamp for a message.

This timestamp is in nanoseconds and originates from the system clock. It represents time since epoch e.g. on most systems this means Unix Time.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	hostTimestamp_ns	The host timestamp the message was created.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.

PEAK_STATUS_INVALID_PARAMETER hostTimestamp_ns is an invalid pointer.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.5

peak_Message_ID_Get()

peak_status peak_Message_ID_Get	(	peak_message_handle	hMessage,
		uint64_t *	messageID )

Get the message id.

The message id is continuous and only reset after a call to peak_Library_Exit.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	messageID	The message ID of the message. This is incremented continuous.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.

PEAK_STATUS_INVALID_PARAMETER messageID is an invalid pointer.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.5

peak_Message_Release()

peak_status peak_Message_Release

(

peak_message_handle

hMessage

)

Release a message.

The message instance with hMessage will be freed.

Parameters

[in]

hMessage

Handle for a message instance.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.5

peak_Message_Type_Get()

peak_status peak_Message_Type_Get	(	peak_message_handle	hMessage,
		peak_message_type *	messageType )

Get the message type.

See peak_message_type for a list of those.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	messageType	The type of the message.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.

PEAK_STATUS_INVALID_PARAMETER messageType is an invalid pointer.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.5