NL_Message
NL_Message
nl
1998 12-06
CLASS
NL_Message - a message object for use with NL_Channel derived from GPL_Message
SYNOPSIS
NL_MESSAGE is basicly a buffer of memory with methods to pack
and extract data as well
as send and receive over an NL_Channel.
For reading a current 'position' is maintained which is moved forward through
the message as data is read.
PARENTS
MEMBER FUNCTIONS
long Send(NL_Channel *channel)
Send the message over channel. Return TRUE on success, FALSE on failure.
long Receive(NL_Channel *channel, long msec_timeout)
Receive a message over channel. Timeout after waiting for
msec_timeout milliseconds.
Return TRUE on success, FALSE on EOF or no returned bytes, NL_CHANNEL_ERROR on
error, NL_CHANNEL_WOULD_BLOCK if a non-blocking channel would have blocked,
and NL_CHANNEL_TIMED_OUT on a timeout.
long Receive(NL_Channel *channel)
Equivalent to Receive(channel, 0).
long Send(NL_Bus *bus)
Send the message over the message bus bus.
Return TRUE on success, FALSE on failure.
long Receive(NL_Bus *bus, long msec_timeout)
Receive a message over the message bus bus. Timeout after waiting for
msec_timeout milliseconds.
Return TRUE on success, FALSE on EOF or a delivery error.
"bus->GetError()" may be used to determine the cause for error.
long Receive(NL_Bus *bus)
Equivalent to "Receive(bus, 0)".
long Position(long jump)
Jump position by the amount specified by jump.
Return the final position.