PhGetNextTransportHdr()

Get the next header from a buffer of packed transport data

Synopsis:

PhTransportHdr_t * PhGetNextTransportHdr(
                      PhTransportHdr_t *last_hdr,
                      PhTransportHdr_t *trans_hdr );

Library:

ph

Description:

This function gets the next header out of a buffer of packed transport data. This header contains information needed to unpack the data that follows the header.

The last_hdr argument points to the last transport header that was unpacked, or to the beginning of the buffer. The information for the next header found is stored in the structure pointed to by trans_hdr.

Returns:

The same pointer as trans_hdr, or NULL if there isn't another header in the buffer.

Errors:

EINVAL
The structure pointed to by last_hdr has a NULL buffer pointer.
ENOENT
The size of the buffer in the structure pointed to by trans_hdr is 0, or there's no entry for the header in the transport registry.

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PhGetAllTransportHdrs(), PhGetTransportHdr(), PhLocateTransHdr(), PhReleaseTransportHdrs(), PhUnlinkTransportHdr()

Drag and Drop chapter of the Photon Programmer's Guide