Packets

DGTL Packets API. More...

Files
file	dgtl_pkt.h
	Declarations for DGTL Packets API.

Enumerations
enum	dgtl_pkt_type_t
	DGTL message packet type indicator.

Functions
__STATIC_INLINE size_t	dgtl_pkt_get_header_length (const dgtl_pkt_t *pkt)
	Get header length of packet. More...
__STATIC_INLINE size_t	dgtl_pkt_get_param_length (const dgtl_pkt_t *pkt)
	Get parameters length of packet. More...
__STATIC_INLINE size_t	dgtl_pkt_get_length (const dgtl_pkt_t *pkt)
	Get length of packet. More...

Detailed Description

DGTL Packets API.

Function Documentation

dgtl_pkt_get_header_length()

__STATIC_INLINE size_t dgtl_pkt_get_header_length

(

const dgtl_pkt_t *

pkt

)

Get header length of packet.

This function returns header length (including packet type indicator) of given packet. The packet has to have at least pkt_type field initialized.

Parameters

[in]

pkt

pointer to a packet buffer

Returns

header length

dgtl_pkt_get_length()

__STATIC_INLINE size_t dgtl_pkt_get_length

(

const dgtl_pkt_t *

pkt

)

Get length of packet.

This function returns length of given packet. The packet has to have header initialized properly as otherwise return value in undefined.

Parameters

[in]

pkt

pointer to a packet buffer

Returns

packet length

dgtl_pkt_get_param_length()

__STATIC_INLINE size_t dgtl_pkt_get_param_length

(

const dgtl_pkt_t *

pkt

)

Get parameters length of packet.

This function returns parameters length of given packet. The packet has to have header initialized properly as otherwise return value in undefined.

Parameters

[in]

pkt

pointer to a packet buffer

Returns

parameters length