/usr/include/gnelib/ChannelPacket.h is in libgnelib-dev 0.75+svn20091130-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | #ifndef _CHANNELPACKET_H_254jfa
#define _CHANNELPACKET_H_254jfa
/* GNE - Game Networking Engine, a portable multithreaded networking library.
* Copyright (C) 2001-2006 Jason Winnebeck
* Project website: http://www.gillius.org/gne/
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#include <gnelib/WrapperPacket.h>
namespace GNE {
/**
* @ingroup highlevel
*
* A ChannelPacket wraps around a normal Packet to give that Packet a channel
* destination and information about its source. This is a packet type meant
* to be used with the high-level API, and provides routing information for
* the Server class.
*/
class ChannelPacket : public WrapperPacket {
public:
/**
* Default constructor for the create function. The constructed
* ChannelPacket is valid only for a readPacket call. You must use the
* constructor with parameters to create a ChannelPacket for sending.
*/
ChannelPacket();
/**
* Inits a new ChannelPacket for the given channel, and from the given
* source ID. A copy of the passed packet is made and stored inside the
* ChannelPacket. This copy is made using the Packet::makeClone method.
*/
ChannelPacket( int channel, int from, const Packet& packet );
virtual ~ChannelPacket();
/**
* The ID for this type of packet.
*/
static const int ID;
/**
* Returns the channel this packet is meant to be sent to, or came in from,
* depending on the context.
*/
int getChannel() const;
/**
* Sets the channel this Packet is meant for. If the channel number given
* is out of range, this method has no effect, but in the debugging version
* of the library, an assert will be triggered.
*
* @param chan the channel number in the range of [0..255]
*/
void setChannel( int chan );
/**
* Returns the source ID for this packet. A source ID of 0 is commonly
* considered to be "unknown."
*/
int getSource() const;
/**
* Sets the source ID for this packet.
* @param source the source ID in the range [0..255]
*/
void setSource( int source );
/**
* Returns a newly allocated exact copy of this packet.
*/
virtual Packet* makeClone() const;
/**
* Returns the current size of this packet in bytes.
*/
virtual int getSize() const;
/**
* Writes the packet to the given Buffer.
*/
virtual void writePacket(Buffer& raw) const;
/**
* Reads this packet from the given Buffer.
*/
virtual void readPacket(Buffer& raw);
/**
* Returns a new instance of this class suitable only to call readPacket on.
*/
static Packet* create();
private:
guint8 channel;
guint8 from;
};
} //namespace GNE
#endif
|