GNE  0.75.0
GNE::EmptyPacket Class Reference

The EmptyPacket is a packet that has no information. More...

#include <EmptyPacket.h>

Inheritance diagram for GNE::EmptyPacket:
GNE::Packet

Public Types

typedef SmartPtr< EmptyPacketsptr
typedef WeakPtr< EmptyPacketwptr
- Public Types inherited from GNE::Packet
typedef SmartPtr< Packetsptr
typedef WeakPtr< Packetwptr

Public Member Functions

 EmptyPacket ()
 Constructs an EmptyPacket.
- Public Member Functions inherited from GNE::Packet
PacketmakeClone () const
 Returns a newly allocated exact copy of this packet, using the PacketParser::clonePacket function.
int getType () const
 Returns the type of this instance.
virtual int getSize () const
 Returns the current size of this packet in bytes.
virtual void writePacket (Buffer &raw) const
 Writes the packet to the given Buffer.
virtual void readPacket (Buffer &raw)
 Reads this packet from the given Buffer.

Static Public Attributes

static const int ID = 0
 The ID for this type of packet.

Additional Inherited Members

- Protected Member Functions inherited from GNE::Packet
 Packet (int id)
 Constructs a packet with the given ID.
 Packet (const Packet &o)
 Copy constructor.
Packetoperator= (const Packet &rhs)
 Copy operator you can use to help you in creating your own.

Detailed Description

The EmptyPacket is a packet that has no information.

This packet type is a replacement for when Packet with a default constructor was used. Normally sending blank packets are not useful; however, there are a few purposes for them, such as a "keep alive" packet to keep a connection alive. If you are wanting to use a blank packet for some purpose such as a end-of-data marker or sending some message that requires no data, it is suggested that you simply derive a class from Packet that adds no data, but has a unique ID so it can be "recognized" easier.


The documentation for this class was generated from the following files: