/usr/include/gnelib/CustomPacket.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 118 119 120 121 122 123 124 125 126 127 | #ifndef _CUSTOMPACKET_H_
#define _CUSTOMPACKET_H_
/* 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/Packet.h>
#include <gnelib/Buffer.h>
namespace GNE {
/**
* @ingroup midlevel
*
* Many times, especially during connection, you want to send some more
* "free-form" data that may or may not all be related and will only be sent
* once. It may not make sense to create a completely new packet type just
* to send a few things one time. This packet type will allow you to send
* whatever you want. Basically, CustomPacket is just a packet that contains
* a Buffer. You can use the Buffer to put in data and pull it out.
* Remember Buffer does endian and processor-type conversions for you.
*
* The maximum amount of data that can be stored in the CustomPacket is
* defined by its Buffer's capacity, which at the current time is 3 bytes
* smaller than Buffer::RAW_PACKET_LEN.
*
* See the documentation for Packet for more info on some of these functions.
*/
class CustomPacket : public Packet {
public: //typedefs
typedef SmartPtr<CustomPacket> sptr;
typedef WeakPtr<CustomPacket> wptr;
public:
CustomPacket();
CustomPacket( const CustomPacket& o );
virtual ~CustomPacket();
/**
* Returns the capacity of Buffers created by CustomPacket made for writing.
*/
static int getMaxUserDataSize();
/**
* The ID for this type of packet.
*/
static const int ID;
/**
* Returns the Buffer for reading or writing. You should not keep the
* returned reference longer than the packet's destruction, or a reset or
* readPacket call.
*
* When writing data to the buffer, do not call "flip" after writing data.
* The position should be left at the point after your last write call.
*
* After a CustomPacket has been read, and you are pulling data out of it,
* the position will be the number of bytes stored in this CustomPacket. You
* need to call flip on the buffer before pulling data from it, or a buffer
* overflow exception will result.
*
* You can use the return from this method directly to modify the buffer, or
* you can store the returned reference (for a very short time) and work on
* that. Here are two examples:
*
* <pre> CustomPacket cp;
* cp.getBuffer() << 15 << "whatever";
* //or
* Buffer& buf( cp.getBuffer() );
* buf << 15 << "whatever";</pre>
*/
Buffer& getBuffer();
/**
* If you want to reuse a CustomPacket after using it for reading or
* writing, you should call clear which will reset this object as if it were
* newly constructed with the default constructor.
*/
void clear();
/**
* @see Packet::getSize()
*/
virtual int getSize() const;
/**
* Writes a CustomPacket to the given Buffer. Flip will be called on the
* Buffer then it will be written to the passed Buffer, so the final result
* will be an unchanged position, but limit == position.
*/
virtual void writePacket( Buffer& raw ) const;
/**
* Reads a CustomPacket from the given Buffer. The data in this packet
* will be erased and replaced by the new data. Then flip is called on the
* Buffer, so position is 0 and the bytes this CustomPacket contains is the
* Buffer's limit.
*/
virtual void readPacket( Buffer& raw );
private:
//This may be changed to a Buffer* to conserve memory like the old CustomPacket
//did when it was using RawPacket.
mutable Buffer buf;
};
} //namespace GNE
#endif //#ifndef _CUSTOMPACKET_H_
|