Imported Upstream version 0.3
[anytun.git] / src / buffer.h
1 /*
2  *  anytun
3  *
4  *  The secure anycast tunneling protocol (satp) defines a protocol used
5  *  for communication between any combination of unicast and anycast
6  *  tunnel endpoints.  It has less protocol overhead than IPSec in Tunnel
7  *  mode and allows tunneling of every ETHER TYPE protocol (e.g.
8  *  ethernet, ip, arp ...). satp directly includes cryptography and
9  *  message authentication based on the methodes used by SRTP.  It is
10  *  intended to deliver a generic, scaleable and secure solution for
11  *  tunneling and relaying of packets of any protocol.
12  *
13  *
14  *  Copyright (C) 2007-2008 Othmar Gsenger, Erwin Nindl, 
15  *                          Christian Pointner <satp@wirdorange.org>
16  *
17  *  This file is part of Anytun.
18  *
19  *  Anytun is free software: you can redistribute it and/or modify
20  *  it under the terms of the GNU General Public License version 3 as
21  *  published by the Free Software Foundation.
22  *
23  *  Anytun is distributed in the hope that it will be useful,
24  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
25  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  *  GNU General Public License for more details.
27  *
28  *  You should have received a copy of the GNU General Public License
29  *  along with anytun.  If not, see <http://www.gnu.org/licenses/>.
30  */
31
32 #ifndef _BUFFER_H_
33 #define _BUFFER_H_
34
35 #include "datatypes.h"
36 #include <string>
37
38 class TunDevice;
39 class UDPPacketSource;
40
41 class Buffer
42 {
43 public:
44   Buffer(bool allow_realloc = true);
45   Buffer(u_int32_t length, bool allow_realloc = true);
46   Buffer(u_int8_t* data, u_int32_t length, bool allow_realloc = true);
47   Buffer(std::string hex_data, bool allow_realloc = true);
48   virtual ~Buffer();
49   Buffer(const Buffer &src);
50   void operator=(const Buffer &src);
51   bool operator==(const Buffer &cmp) const;
52   Buffer operator^(const Buffer &xor_by) const;
53
54   u_int32_t getLength() const;
55   virtual void setLength(u_int32_t new_length);
56   u_int8_t* getBuf();
57   u_int8_t& operator[](u_int32_t index);
58   u_int8_t operator[](u_int32_t index) const;
59   std::string getHexDump() const;
60   std::string getHexDumpOneLine() const;
61
62   bool isReallocAllowed() const;
63
64   operator u_int8_t*();
65
66 protected:
67   virtual void reinit() {};
68
69   u_int8_t *buf_;
70   u_int32_t length_;
71   u_int32_t real_length_;
72   bool allow_realloc_;
73
74   static const u_int32_t OVER_SIZE_ = 100;
75 };
76
77 #endif