SHUTTLE/DCSClient/AliDCSMessage.h

   1 #ifndef ALI_DCS_MESSAGE_H
   2 #define ALI_DCS_MESSAGE_H
   3
   4 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   5  * See cxx source for full Copyright notice                               */
   6
   7 /* $Id$ */
   8
   9 //
  10 // This class is a wrapper of AliDCSMessage.
  11 // These are the messages which form AliDCSProtocol.
  12 // Used by AliDCSClient to communicate with the DCS Amanda server
  13 //
  14
  15 #include <TString.h>
  16 #include <TObjArray.h>
  17 #include "AliDCSValue.h"
  18
  19 #define HEADER_SIZE 8
  20 #define ID_OFFSET 0
  21 #define VERSION_OFFSET 2
  22 #define TYPE_OFFSET 3
  23 #define BODY_SIZE_OFFSET 4
  24
  25 #define MAX_BODY_SIZE 500000
  26
  27 #define REQUEST_TYPE_OFFSET HEADER_SIZE
  28 #define START_TIME_OFFSET (HEADER_SIZE + 1)
  29 #define END_TIME_OFFSET (HEADER_SIZE + 5)
  30 #define REQUEST_STRING_OFFSET (HEADER_SIZE + 9)
  31
  32 #define REQUEST_STRINGS_OFFSET REQUEST_STRING_OFFSET
  33
  34 #define COUNT_OFFSET HEADER_SIZE
  35
  36 #define INDEX_OFFSET HEADER_SIZE
  37 #define SVT_OFFSET (INDEX_OFFSET + 4)
  38 #define VALUE_COUNT_OFFSET (SVT_OFFSET + 1)
  39 #define VALUES_OFFSET (VALUE_COUNT_OFFSET + 4)
  40
  41 #define ERROR_CODE_OFFSET HEADER_SIZE
  42 #define ERROR_STRING_OFFSET (HEADER_SIZE + 1)
  43
  44 class AliDCSMessage: public TObject {
  45 public:
  46         enum Type {
  47                 kInvalid = 0,
  48                 kRequest = 1,
  49                 kCount = 2,
  50                 kResultSet = 3,
  51                 kError = 4,
  52                 kMultiRequest = 5,
  53                 kNext = 6
  54         };
  55
  56         enum RequestType {
  57                 kNoneType = 0,
  58                 kAlias = 1,
  59                 kDPName = 2
  60         };
  61
  62         enum ErrorCode {
  63                 kNoneError = 0,
  64                 kUnknownAliasDPName = 1,
  65                 kInvalidTimeRange = 2,
  66                 kInvalidBufferSize = 3,
  67                 kInvalidRequest = 4,
  68                 kUnsupportedType = 5,
  69                 kUnknownError = 255
  70         };
  71
  72
  73         AliDCSMessage();
  74
  75         AliDCSMessage(const char* buffer, UInt_t size);
  76         virtual ~AliDCSMessage();
  77
  78         void CreateRequestMessage(RequestType type,
  79                 UInt_t startTime, UInt_t endTime, const char* request);
  80
  81         void CreateMultiRequestMessage(RequestType type,
  82                 UInt_t startTime, UInt_t endTime);
  83
  84         void CreateCountMessage(UInt_t count);
  85         void CreateResultSetMessage(AliDCSValue::Type type);
  86         void CreateErrorMessage(ErrorCode code, const char* errorString);
  87
  88         void CreateNextMessage();
  89
  90         void DestroyMessage();
  91
  92
  93         Bool_t SetRawHeader(const char* header);
  94
  95         void StoreToBuffer();
  96
  97         void LoadFromBuffer();
  98
  99         void DestroyBuffer();
 100
 101
 102         Bool_t IsValid() const {return fType != kInvalid;};
 103
 104         UInt_t GetMessageSize() const {return fMessageSize;};
 105
 106         char* GetMessage() const {return fMessage;};
 107
 108         UInt_t GetBodySize() const {return fMessageSize - HEADER_SIZE;};
 109
 110         char* GetBody() const {return fMessage + HEADER_SIZE;};
 111
 112         Type GetType() const {return fType;};
 113
 114          // RequestType and MultiReuqestType Message getters
 115         RequestType GetRequestType() const;
 116
 117         UInt_t GetStartTime() const;
 118
 119         UInt_t GetEndTime() const;
 120
 121         TString GetRequestString() const;
 122
 123         // MultiRequestType Message getters and setters
 124         void GetRequestStrings(TObjArray& result) const;
 125
 126         Bool_t AddRequestString(const char* request);
 127
 128         void ClearRequestStrings();
 129
 130         // CountType Message getters
 131         UInt_t GetCount() const;
 132
 133         // ResultSetType Message getters ans setters
 134         AliDCSValue::Type GetValueType() const;
 135
 136         Int_t GetOwnerIndex() const { return fOwnerIndex; }
 137
 138         UInt_t GetValueCount() const;
 139
 140         UInt_t GetValues(TObjArray* result) const;
 141
 142         Bool_t AddValue(AliDCSValue& value);
 143
 144         void ClearValues();
 145
 146         // ErrorType Message getters
 147         ErrorCode GetErrorCode() const;
 148
 149         TString GetErrorString() const;
 150
 151
 152         virtual void Print(Option_t* option = NULL) const;
 153
 154         static void PrintBuffer(const char* buf, UInt_t size, TString& output);
 155
 156 private:
 157
 158         AliDCSMessage(const AliDCSMessage& other);
 159         AliDCSMessage& operator= (const AliDCSMessage& other);
 160
 161
 162         char* fMessage;         // Array of bytes building the message
 163
 164         UInt_t fMessageSize;    // Size of the message array
 165
 166
 167         Type fType;             // Message type (request, count...)
 168
 169         //Request message fields
 170         RequestType fRequestType;       // Type of request message
 171
 172         UInt_t fStartTime;              // Start time of query
 173
 174         UInt_t fEndTime;                // End time of query
 175
 176         TString fRequestString;         // Request string
 177
 178         //Count message fields
 179         UInt_t fCount;                  // count counter
 180
 181         //ResultSet message fields
 182   Int_t fOwnerIndex;  // owner index of this result
 183         AliDCSValue::Type fValueType; // Simple value type
 184
 185         TObjArray* fValues;             // array of received values
 186
 187         //Error message fields
 188         ErrorCode fErrorCode;           // error code
 189
 190         TString fErrorString;           // error string
 191
 192         //MultiRequest message fields
 193         TObjArray fRequestStrings;      // multi request string array
 194
 195
 196         // Message setter helpers
 197         void StoreHeader();
 198
 199         void StoreRequestMessage();
 200
 201         void StoreCountMessage();
 202
 203         void StoreResultSetMessage();
 204
 205         void StoreErrorMessage();
 206
 207         void StoreMultiRequestMessage();
 208
 209         void StoreNextMessage();
 210
 211
 212         Bool_t ValidateHeader(const char* buf);
 213
 214         void LoadRequestMessage();
 215
 216         void LoadCountMessage();
 217
 218         void LoadResultSetMessage();
 219
 220         void LoadErrorMessage();
 221
 222         void LoadMultiRequestMessage();
 223
 224         void LoadNextMessage();
 225
 226         // Buffer helpers
 227         static void SetBool(char* buf, Bool_t val);
 228
 229         static void SetByte(char* buf, Char_t val);
 230
 231         static void SetUByte(char* buf, UChar_t val);
 232
 233         static void SetInt(char* buf, Int_t val);
 234
 235         static void SetUInt(char* buf, UInt_t val);
 236
 237         static void SetFloat(char* buf, Float_t val);
 238
 239         static Bool_t GetBool(const char* buf);
 240
 241         static Char_t GetByte(const char* buf);
 242
 243         static UChar_t GetUByte(const char* buf);
 244
 245         static Int_t GetInt(const char* buf);
 246
 247         static UInt_t GetUInt(const char* buf);
 248
 249         static Float_t GetFloat(const char* buf);
 250
 251         static TString GetString(const char* buf, Int_t maxLen);
 252
 253
 254         ClassDef(AliDCSMessage, 0);
 255 };
 256
 257 #endif