Base module

FlagPacket

Packet for sending bitwise flags along the packet stream.

FlagPacket

#include <icy/packet.h>

Inherits: IPacket

Packet for sending bitwise flags along the packet stream.

Public Methods

ReturnNameDescription
FlagPacket inline#### Parameters
std::unique_ptr< IPacket >clone virtual const inline#### Returns
FlagPacket inline#### Parameters
ssize_tread virtual inlineNo-op read; FlagPacket carries no payload data.
voidwrite virtual const inlineNo-op write; FlagPacket carries no payload data.
const char *className virtual const inlineReturns the class name of this packet type for logging and diagnostics.

FlagPacket

inline

inline FlagPacket(unsigned flags)

Parameters

  • flags Bitwise flags to carry in this packet.

clone

virtual const inline

virtual inline std::unique_ptr< IPacket > clone() const

Returns

Owning pointer to a deep copy of this packet.


FlagPacket

inline

inline FlagPacket(const FlagPacket & that)

Parameters

  • that Source packet to copy from.

read

virtual inline

virtual inline ssize_t read(const ConstBuffer &)

No-op read; FlagPacket carries no payload data.

Returns

Always returns true (1).


write

virtual const inline

virtual inline void write(Buffer &) const

No-op write; FlagPacket carries no payload data.


className

virtual const inline

virtual inline const char * className() const

Returns the class name of this packet type for logging and diagnostics.