source: xplra/src/xplra/GetDataRefTask.h@ 3:459106f9bf9a

Last change on this file since 3:459106f9bf9a was 3:459106f9bf9a, checked in by István Váradi <ivaradi@…>, 12 years ago

Very basic client and server functionality works

File size: 4.3 KB
Line 
1// Copyright (c) 2013 by István Váradi
2
3// This file is part of XPLRA, a remote-access plugin for X-Plane
4
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions are met:
7
8// 1. Redistributions of source code must retain the above copyright notice, this
9// list of conditions and the following disclaimer.
10// 2. Redistributions in binary form must reproduce the above copyright notice,
11// this list of conditions and the following disclaimer in the documentation
12// and/or other materials provided with the distribution.
13
14// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
15// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
18// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24
25// The views and conclusions contained in the software and documentation are those
26// of the authors and should not be interpreted as representing official policies,
27// either expressed or implied, of the FreeBSD Project.
28
29#ifndef XPLRA_GETDATAREFTASK_H
30#define XPLRA_GETDATAREFTASK_H
31//------------------------------------------------------------------------------
32
33#include "DataRefTask.h"
34
35//------------------------------------------------------------------------------
36
37namespace xplra {
38
39//------------------------------------------------------------------------------
40
41/**
42 * A dataref task which retrieves the value of a byte array.
43 */
44class GetByteArrayDataRefTask : public DataRefTask
45{
46private:
47 /**
48 * The maximal number of bytes accepted.
49 */
50 int maxBytes;
51
52 /**
53 * The offset within the dataref's value to start querying from.
54 */
55 int offset;
56
57 /**
58 * The array to store the data in.
59 */
60 unsigned char* data;
61
62 /**
63 * The actual length of the data retrieved.
64 */
65 int length;
66
67public:
68 /**
69 * Construct the task for the dataref with the given name.
70 *
71 * @param maxBytes the maximal number of bytes to retrieve. If <0,
72 * the function will perform an extra query to retrieve the size
73 * of the dataref's data, which it will store in the task, so
74 * later on it can be reused.
75 */
76 GetByteArrayDataRefTask(const std::string& name,
77 int maxBytes = -1, int offset = 0);
78
79 /**
80 * Construct the task for the given dataref
81 *
82 * @param maxBytes the maximal number of bytes to retrieve. If <0,
83 * the function will perform an extra query to retrieve the size
84 * of the dataref's data, which it will store in the task, so
85 * later on it can be reused.
86 */
87 GetByteArrayDataRefTask(XPLMDataRef dataRef,
88 int maxBytes = -1, int offset = 0);
89
90
91 /**
92 * Destroy the task object.
93 */
94 virtual ~GetByteArrayDataRefTask();
95
96 /**
97 * Get the data.
98 */
99 const unsigned char* getData() const;
100
101 /**
102 * Get the length of the data.
103 */
104 int getLength() const;
105
106protected:
107 /**
108 * Process the dataref by querying its value.
109 */
110 virtual void process();
111};
112
113//------------------------------------------------------------------------------
114// Inline definitions
115//------------------------------------------------------------------------------
116
117inline const unsigned char* GetByteArrayDataRefTask::getData() const
118{
119 return data;
120}
121
122//------------------------------------------------------------------------------
123
124inline int GetByteArrayDataRefTask::getLength() const
125{
126 return length;
127}
128
129//------------------------------------------------------------------------------
130
131} /* namespace xplra */
132
133//------------------------------------------------------------------------------
134#endif // XPLRA_GETDATAREFTASK_H
135
136// Local Variables:
137// mode: C++
138// c-basic-offset: 4
139// indent-tabs-mode: nil
140// End:
Note: See TracBrowser for help on using the repository browser.