src/packet.h

   1 ///
   2 /// \file       packet.h
   3 ///             Low level protocol packet builder class.
   4 ///             Has knowledge of specific protocol commands in order
   5 ///             to hide protocol details behind an API.
   6 ///
   7
   8 /*
   9     Copyright (C) 2005-2008, Net Direct Inc. (http://www.netdirect.ca/)
  10
  11     This program is free software; you can redistribute it and/or modify
  12     it under the terms of the GNU General Public License as published by
  13     the Free Software Foundation; either version 2 of the License, or
  14     (at your option) any later version.
  15
  16     This program is distributed in the hope that it will be useful,
  17     but WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  19
  20     See the GNU General Public License in the COPYING file at the
  21     root directory of this project for more details.
  22 */
  23
  24 #ifndef __BARRY_PACKET_H__
  25 #define __BARRY_PACKET_H__
  26
  27 #include <stdint.h>
  28
  29 namespace Barry { class Data; }
  30
  31 namespace Barry {
  32
  33 // forward declarations
  34 class Parser;
  35 class Builder;
  36 class SocketZero;
  37 class Socket;
  38 namespace Mode {
  39         class Desktop;
  40 }
  41
  42 class Packet
  43 {
  44         friend class SocketZero;
  45         friend class Socket;
  46
  47 protected:
  48         Data &m_send, &m_receive;
  49
  50         Data& GetSend() { return m_send; }
  51         Data& GetReceive() { return m_receive; }
  52
  53 public:
  54         Packet(Data &send, Data &receive)
  55                 : m_send(send), m_receive(receive)
  56                 {}
  57         virtual ~Packet() {}
  58
  59         //////////////////////////////////
  60         // common response analysis
  61
  62         unsigned int Command() const;   // throws Error if receive isn't big enough
  63 };
  64
  65 //
  66 // ZeroPacket class
  67 //
  68 /// Provides an API for building and analyzing socket-0 protocol packets.
  69 /// This class relies on 2 external objects: a send and receive Data buffer.
  70 ///
  71 /// Note that the receive buffer may be modified
  72 /// during a packet send, and this DBPacket class provides API helpers
  73 /// to analyze the results.
  74 ///
  75 class ZeroPacket : public Packet
  76 {
  77         friend class Socket;
  78
  79 public:
  80         ZeroPacket(Data &send, Data &receive);
  81         ~ZeroPacket();
  82
  83         //////////////////////////////////
  84         // meta access
  85
  86         //////////////////////////////////
  87         // packet building
  88
  89         void GetAttribute(unsigned int object, unsigned int attribute);
  90
  91
  92         //////////////////////////////////
  93         // response analysis
  94
  95         unsigned int ObjectID() const;
  96         unsigned int AttributeID() const;
  97         uint32_t ChallengeSeed() const;
  98         unsigned int RemainingTries() const;
  99         unsigned int SocketResponse() const;
 100         unsigned char SocketSequence() const;
 101 };
 102
 103
 104 //
 105 // DBPacket class
 106 //
 107 /// Provides an API for building and analyzing raw DB protocol packets.
 108 /// This class relies on 3 external objects: a Mode::Desktop object,
 109 /// a send Data buffer, and a receive data buffer.  Socket and
 110 /// connection details are retrieved on a readonly basis from the
 111 /// Mode::Desktop object, but both send and receive buffers can be
 112 /// modified.
 113 ///
 114 /// Note that the receive buffer may be modified
 115 /// during a packet send, and this DBPacket class provides API helpers
 116 /// to analyze the results.
 117 ///
 118 class DBPacket : public Packet
 119 {
 120         friend class Socket;
 121
 122 private:
 123         Mode::Desktop &m_con;
 124         unsigned int m_last_dbop;       // last database operation
 125
 126 protected:
 127
 128 public:
 129         DBPacket(Mode::Desktop &con, Data &send, Data &receive);
 130         ~DBPacket();
 131
 132         //////////////////////////////////
 133         // meta access
 134
 135         //////////////////////////////////
 136         // packet building
 137
 138         // commands that correspond to the DB operation
 139         // constants in protocol.h
 140         void ClearDatabase(unsigned int dbId);
 141         void GetDBDB();
 142         void GetRecordStateTable(unsigned int dbId);
 143         void SetRecordFlags(unsigned int dbId, unsigned int stateTableIndex, uint8_t flag1);
 144         void DeleteRecordByIndex(unsigned int dbId, unsigned int stateTableIndex);
 145         void GetRecordByIndex(unsigned int dbId, unsigned int stateTableIndex);
 146         bool SetRecordByIndex(unsigned int dbId, unsigned int stateTableIndex, Builder &build);
 147         void GetRecords(unsigned int dbId);
 148         bool SetRecord(unsigned int dbId, Builder &build);
 149
 150
 151         //////////////////////////////////
 152         // response analysis
 153
 154         // DB command response functions
 155         unsigned int ReturnCode() const;        // throws FIXME if packet doesn't support it
 156         unsigned int DBOperation() const; // throws Error on size trouble
 157
 158         bool Parse(Parser &parser);     // switches based on last m_send command
 159
 160         // response parsers
 161 };
 162
 163 } // namespace Barry
 164
 165 #endif
 166