src/socket.h

   1 ///
   2 /// \file       socket.h
   3 ///             Class wrapper to encapsulate the Blackberry USB logical socket
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2008, Net Direct Inc. (http://www.netdirect.ca/)
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  17
  18     See the GNU General Public License in the COPYING file at the
  19     root directory of this project for more details.
  20 */
  21
  22 #ifndef __BARRY_SOCKET_H__
  23 #define __BARRY_SOCKET_H__
  24
  25 #include "dll.h"
  26 #include <stdint.h>
  27 #include <queue>
  28 #include <memory>
  29 #include "router.h"
  30
  31 // forward declarations
  32 namespace Usb { class Device; }
  33 namespace Barry {
  34         class Data;
  35         class Packet;
  36         class SocketRoutingQueue;
  37 }
  38
  39 namespace Barry {
  40
  41 class Socket;
  42 typedef std::auto_ptr<Socket>   SocketHandle;
  43
  44 class BXEXPORT SocketZero
  45 {
  46         friend class Socket;
  47
  48         Usb::Device *m_dev;
  49         SocketRoutingQueue *m_queue;
  50         int m_writeEp, m_readEp;
  51         uint8_t m_zeroSocketSequence;
  52
  53         uint32_t m_sequenceId;
  54
  55         // half open socket stata, for passwords
  56         bool m_halfOpen;
  57         uint32_t m_challengeSeed;
  58         unsigned int m_remainingTries;
  59
  60 private:
  61         static void AppendFragment(Data &whole, const Data &fragment);
  62         static unsigned int MakeNextFragment(const Data &whole, Data &fragment,
  63                 unsigned int offset = 0);
  64         void CheckSequence(uint16_t socket, const Data &seq);
  65
  66         void SendOpen(uint16_t socket, Data &receive);
  67         void SendPasswordHash(uint16_t socket, const char *password, Data &receive);
  68
  69         // Raw send and receive functions, used for all low level
  70         // communication to the USB level.
  71         void RawSend(Data &send, int timeout = -1);
  72         void RawReceive(Data &receive, int timeout = -1);
  73
  74 public:
  75         explicit SocketZero(SocketRoutingQueue &queue, int writeEndpoint,
  76                 uint8_t zeroSocketSequenceStart = 0);
  77         SocketZero(Usb::Device &dev, int writeEndpoint, int readEndpoint,
  78                 uint8_t zeroSocketSequenceStart = 0);
  79         ~SocketZero();
  80
  81         uint8_t GetZeroSocketSequence() const { return m_zeroSocketSequence; }
  82
  83         void SetRoutingQueue(SocketRoutingQueue &queue);
  84         void UnlinkRoutingQueue();
  85
  86         // Send functions for socket 0 only.
  87         // These functions will overwrite:
  88         //     - the zeroSocketSequence byte *inside* the packet
  89         //     - the socket number to 0
  90         //
  91         void Send(Data &send, int timeout = -1);        // send only
  92         void Send(Data &send, Data &receive, int timeout = -1); // send+recv
  93         void Send(Barry::Packet &packet, int timeout = -1);
  94 //      void Receive(Data &receive, int timeout = -1);
  95
  96         // Opens a new socket and returns a Socket object to manage it
  97         SocketHandle Open(uint16_t socket, const char *password = 0);
  98         void Close(Socket &socket);
  99 };
 100
 101
 102 //
 103 // Socket class
 104 //
 105 /// Encapsulates a "logical socket" in the Blackberry USB protocol.
 106 /// By default, provides raw send/receive access, as well as packet
 107 /// writing on socket 0, which is always open.
 108 ///
 109 /// There are Open and Close members to open data sockets which are used
 110 /// to transfer data to and from the device.
 111 ///
 112 /// The destructor will close any non-0 open sockets automatically.
 113 ///
 114 /// Requires an active Usb::Device object to work on.
 115 ///
 116 class BXEXPORT Socket
 117 {
 118         friend class SocketZero;
 119
 120         SocketZero *m_zero;
 121         uint16_t m_socket;
 122         uint8_t m_closeFlag;
 123
 124         bool m_registered;
 125
 126 protected:
 127         void CheckSequence(const Data &seq);
 128         void ForceClosed();
 129
 130         Socket(SocketZero &zero, uint16_t socket, uint8_t closeFlag);
 131
 132 public:
 133         ~Socket();
 134
 135         uint16_t GetSocket() const { return m_socket; }
 136         uint8_t GetCloseFlag() const { return m_closeFlag; }
 137
 138         void Close();
 139
 140         // Send and Receive are available before Open...
 141         // an unopened socket defaults to socket 0, which you need
 142         // in order to set the blackberry mode
 143         // The send function will overwrite the zeroSocketSequence byte
 144         // *inside* the packet, if the current m_socket is 0.
 145         void Send(Data &send, int timeout = -1);        // send only
 146         void Send(Data &send, Data &receive, int timeout = -1); // send+recv
 147         void Send(Barry::Packet &packet, int timeout = -1);
 148         void Receive(Data &receive, int timeout = -1);
 149
 150         // sends the send packet down to the device, fragmenting if
 151         // necessary, and returns the response in receive, defragmenting
 152         // if needed
 153         // Blocks until response received or timed out in Usb::Device
 154         void Packet(Data &send, Data &receive, int timeout = -1);
 155         void Packet(Barry::Packet &packet, int timeout = -1);
 156
 157         // some handy wrappers for the Packet() interface
 158         void NextRecord(Data &receive);
 159
 160         // Register a callback for incoming data from the device.
 161         // This function assumes that this socket is based on a socketZero
 162         // that has a SocketRoutingQueue, otherwise throws logic_error.
 163         void RegisterInterest(SocketRoutingQueue::SocketDataHandler handler, void *context);
 164         void UnregisterInterest();
 165 };
 166
 167
 168 } // namespace Barry
 169
 170 #endif
 171