trunk/Src/DasherCore/SocketInputBase.h

   1 // SocketInputBase.h
   2 //
   3 // (C) Copyright Seb Wills 2005
   4 //
   5 // Abstract base class for socket input: parent of non-abstract classes in each implementation (Windows, Linux, ...),
   6
   7 #ifndef __socketinputbase_h__
   8 #define __socketinputbase_h__
   9
  10 #include "../DasherCore/DasherInput.h"
  11 #include "../DasherCore/DasherComponent.h"
  12 #include "../DasherCore/EventHandler.h"
  13
  14 #include <iostream>
  15
  16 #define DASHER_SOCKET_INPUT_MAX_COORDINATE_COUNT 2      // just X and Y for now
  17 #define DASHER_SOCKET_INPUT_MAX_COORDINATE_LABEL_LENGTH 128
  18
  19 namespace Dasher {
  20   class CSocketInputBase;
  21 }
  22
  23 using namespace Dasher;
  24 using namespace std;
  25 /// \ingroup Input
  26 /// \{
  27 class Dasher::CSocketInputBase : public CDasherInput {
  28
  29 public:
  30
  31   CSocketInputBase(CEventHandler * pEventHandler, CSettingsStore * pSettingsStore);
  32
  33   virtual ~CSocketInputBase();
  34
  35   virtual void HandleEvent(Dasher::CEvent * pEvent);
  36
  37   virtual void SetDebug(bool _debug);
  38
  39   virtual bool StartListening();
  40
  41   virtual void StopListening();
  42
  43   virtual bool isListening() {
  44     return readerRunning;
  45   }
  46
  47   virtual void SetReaderPort(int port);
  48
  49   virtual int GetPort() {
  50     return port;
  51   }
  52
  53   void SetCoordinateCount(int _coordinateCount) {
  54     DASHER_ASSERT(_coordinateCount <= DASHER_SOCKET_INPUT_MAX_COORDINATE_COUNT);
  55     coordinateCount = _coordinateCount;
  56   }
  57
  58   // Fills pCoordinates with iN coordinate values, return 0 if the
  59   // values were in screen coordinates or 1 if the values were in
  60   // Dasher coordinates.
  61
  62   int GetCoordinates(int iN, myint * pCoordinates) {
  63
  64     for(int i = 0; i < iN && i < coordinateCount; i++) {
  65       pCoordinates[i] = dasherCoordinates[i];
  66     }
  67     return 1;
  68   };
  69
  70   // Get the number of co-ordinates that this device supplies
  71
  72   int GetCoordinateCount() {
  73     return coordinateCount;
  74   };
  75
  76   void SetMaxCoordinates(int iN, myint * iDasherMax) {
  77     for(int i = 0; i < iN && i < DASHER_SOCKET_INPUT_MAX_COORDINATE_COUNT; i++) {
  78       dasherMaxCoordinateValues[i] = iDasherMax[i];
  79     }
  80   };
  81
  82   void Activate() {
  83     StartListening();
  84   };
  85
  86   void Deactivate() {
  87     StopListening();
  88   };
  89
  90   // Defines the label used in the input stream for a particular coordinate.
  91   // We make our own copy of the label, in our own buffer. This should ensure thread-safety.
  92   // Even if this method is called while our other thread is doing a strcmp on the label,
  93   // the buffer will always be null-terminated somewhere (even if the last byte of the buffer, which is
  94   // never overwritten), so won't segfault.
  95   virtual void SetCoordinateLabel(int iWhichCoordinate, const char *Label);
  96
  97   virtual void SetRawRange(int iWhich, double dMin, double dMax);
  98
  99   bool GetSettings(SModuleSettings **pSettings, int *iCount);
 100
 101 protected:
 102
 103   myint dasherCoordinates[DASHER_SOCKET_INPUT_MAX_COORDINATE_COUNT];
 104   myint dasherMaxCoordinateValues[DASHER_SOCKET_INPUT_MAX_COORDINATE_COUNT];
 105   double rawMinValues[DASHER_SOCKET_INPUT_MAX_COORDINATE_COUNT];
 106   double rawMaxValues[DASHER_SOCKET_INPUT_MAX_COORDINATE_COUNT];
 107   int coordinateCount;
 108   char coordinateNames[DASHER_SOCKET_INPUT_MAX_COORDINATE_COUNT][DASHER_SOCKET_INPUT_MAX_COORDINATE_LABEL_LENGTH + 1];
 109
 110   int port;
 111   bool debug_socket_input;
 112
 113   int sock;
 114
 115   char buffer[4096];
 116
 117   bool readerRunning;
 118
 119   virtual bool LaunchReaderThread() =0;
 120
 121   virtual void CancelReaderThread() =0;
 122
 123   virtual void ReadForever();
 124
 125   virtual void ParseMessage(char *message);
 126
 127   virtual void ReportErrnoError(std::string prefix); // override as appropriate for each platform
 128
 129   virtual void ReportError(std::string s); // override as appropriate for each platform
 130
 131   virtual void SocketDebugMsg(const char *pszFormat, ...);
 132
 133 };
 134 /// \}
 135 #endif
 136
 137
 138