NETIO Packet API

NETIO_Packet implementation. More...

Data Structures
struct	NETIO_Packet
	Implementation of the abstract NETIO_Packet type. More...

Typedefs
typedef struct NETIO_Packet	NETIO_Packet_T
	A NETIO Packet.

Functions
void *	NETIO_Packet_get_head (const NETIO_Packet_T *const packet)
	Get a pointer to the current head.
RTI_BOOL	NETIO_Packet_set_payload (NETIO_Packet_T *const packet, void *buffer, RTI_INT32 buffer_length)
	Initialize a packet with a payload.
RTI_SIZE_T	NETIO_Packet_get_payload_length (const NETIO_Packet_T *const packet)
	Get the length the packet payload.

---

Detailed Description

NETIO_Packet implementation.

---

Typedef Documentation

typedef struct NETIO_Packet NETIO_Packet_T

A NETIO Packet.

The NETIO layers passed NETIO_Packet structures upstream/downstream.

---

Function Documentation

void* NETIO_Packet_get_head

(

const NETIO_Packet_T *const

packet

)

Get a pointer to the current head.

Get a pointer to the current head. Note that it can be assumed that the payload buffer is contiguous.

Parameters:

packet

<<in>> A packet to get the head pointer for.

Returns:

A pointer to the packet head.

MT Safety:

This operation is not thread safe.

RTI_BOOL NETIO_Packet_set_payload	(	NETIO_Packet_T *const	packet,
		void *	buffer,
		RTI_INT32	buffer_length
	)

Initialize a packet with a payload.

Parameters:

packet	<<in>> The packet to initialize.
buffer	<<in>> The payload to initialize a packet with.
buffer_length	<<in>> The length of the payload in bytes.

Returns:

RTI_TRUE on success, RTI_FALSE on failure.

MT Safety:

This operation is not thread safe.

RTI_SIZE_T NETIO_Packet_get_payload_length

(

const NETIO_Packet_T *const

packet

)

Get the length the packet payload.

Parameters:

packet

<<in>> The packet to return the payload length for.

Returns:

Length of payload, 0xffffffff if the length is invalid.

MT Safety:

This operation is not thread safe.