aboutsummaryrefslogtreecommitdiff
path: root/nxcomp/GetProperty.h
blob: bee84d0c319bf9c05bd597fd7fb1a73f88775921 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/**************************************************************************/
/*                                                                        */
/* Copyright (c) 2001, 2009 NoMachine, http://www.nomachine.com/.         */
/*                                                                        */
/* NXCOMP, NX protocol compression and NX extensions to this software     */
/* are copyright of NoMachine. Redistribution and use of the present      */
/* software is allowed according to terms specified in the file LICENSE   */
/* which comes in the source distribution.                                */
/*                                                                        */
/* Check http://www.nomachine.com/licensing.html for applicability.       */
/*                                                                        */
/* NX and NoMachine are trademarks of Medialogic S.p.A.                   */
/*                                                                        */
/* All rights reserved.                                                   */
/*                                                                        */
/**************************************************************************/

#ifndef GetProperty_H
#define GetProperty_H

#include "Message.h"

//
// Set the verbosity level.
//

#define PANIC
#define WARNING
#undef  TEST
#undef  DEBUG
#undef  DUMP

//
// Set default values.
//

#define GETPROPERTY_ENABLE_CACHE               1
#define GETPROPERTY_ENABLE_DATA                0
#define GETPROPERTY_ENABLE_SPLIT               0
#define GETPROPERTY_ENABLE_COMPRESS            0

#define GETPROPERTY_DATA_LIMIT                 0
#define GETPROPERTY_DATA_OFFSET                24

#define GETPROPERTY_CACHE_SLOTS                2000
#define GETPROPERTY_CACHE_THRESHOLD            2
#define GETPROPERTY_CACHE_LOWER_THRESHOLD      1

//
// The message class.
//

class GetPropertyMessage : public Message
{
  friend class GetPropertyStore;

  public:

  GetPropertyMessage()
  {
  }

  ~GetPropertyMessage()
  {
  }

  //
  // Put here the fields which constitute 
  // the 'identity' part of the message.
  //

  private:

  unsigned char  property_delete;
  unsigned long  window;
  unsigned long  property;
  unsigned long  type;
  unsigned long  long_offset;
  unsigned long  long_length;
};

class GetPropertyStore : public MessageStore
{

  //
  // Constructors and destructors.
  //

  public:

  GetPropertyStore() : MessageStore()
  {
    enableCache    = GETPROPERTY_ENABLE_CACHE;
    enableData     = GETPROPERTY_ENABLE_DATA;
    enableSplit    = GETPROPERTY_ENABLE_SPLIT;
    enableCompress = GETPROPERTY_ENABLE_COMPRESS;

    dataLimit  = GETPROPERTY_DATA_LIMIT;
    dataOffset = GETPROPERTY_DATA_OFFSET;

    cacheSlots          = GETPROPERTY_CACHE_SLOTS;
    cacheThreshold      = GETPROPERTY_CACHE_THRESHOLD;
    cacheLowerThreshold = GETPROPERTY_CACHE_LOWER_THRESHOLD;

    messages_ -> resize(cacheSlots);

    for (T_messages::iterator i = messages_ -> begin();
             i < messages_ -> end(); i++)
    {
      *i = NULL;
    }

    temporary_ = NULL;
  }

  virtual ~GetPropertyStore()
  {
    for (T_messages::iterator i = messages_ -> begin();
             i < messages_ -> end(); i++)
    {
      destroy(*i);
    }

    destroy(temporary_);
  }

  virtual const char *name() const
  {
    return "GetProperty";
  }

  virtual unsigned char opcode() const
  {
    return X_GetProperty;
  }

  virtual unsigned int storage() const
  {
    return sizeof(GetPropertyMessage);
  }

  //
  // Message handling methods.
  //

  protected:

  virtual Message *create() const
  {
    return new GetPropertyMessage();
  }

  virtual Message *create(const Message &message) const
  {
    return new GetPropertyMessage((const GetPropertyMessage &) message);
  }

  virtual void destroy(Message *message) const
  {
    delete (GetPropertyMessage *) message;
  }

  virtual int parseIdentity(Message *message, const unsigned char *buffer,
                                unsigned int size, int bigEndian) const;

  virtual int unparseIdentity(const Message *message, unsigned char *buffer,
                                  unsigned int size, int bigEndian) const;

  virtual void identityChecksum(const Message *message, const unsigned char *buffer,
                                    unsigned int size, int bigEndian) const;

  virtual void dumpIdentity(const Message *message) const;
};

#endif /* GetProperty_H */