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
|
/**
* @file llioutil.h
* @author Phoenix
* @date 2005-10-05
* @brief Helper classes for dealing with IOPipes
*
* $LicenseInfo:firstyear=2005&license=viewerlgpl$
* Second Life Viewer Source Code
* Copyright (C) 2010, Linden Research, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License only.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
* $/LicenseInfo$
*/
#ifndef LL_LLIOUTIL_H
#define LL_LLIOUTIL_H
#include "llbuffer.h"
#include "lliopipe.h"
#include "llpumpio.h"
/**
* @class LLIOFlush
* @brief This class is used as a mini chain head which drains the buffer.
* @see LLIOPipe
*
* An instance of this class acts as a useful chain head when all data
* is known, and you simply want to get the chain moving.
*/
class LLIOFlush : public LLIOPipe
{
public:
LLIOFlush() {}
virtual ~LLIOFlush() {}
protected:
/* @name LLIOPipe virtual implementations
*/
//@{
/**
* @brief Process the data in buffer
*/
EStatus process_impl(
const LLChannelDescriptors& channels,
buffer_ptr_t& buffer,
bool& eos,
LLSD& context,
LLPumpIO* pump);
//@}
protected:
};
/**
* @class LLIOSleep
* @brief This is a simple helper class which will hold a chain and
* process it later using pump mechanisms
* @see LLIOPipe
*/
class LLIOSleep : public LLIOPipe
{
public:
LLIOSleep(F64 sleep_seconds) : mSeconds(sleep_seconds) {}
virtual ~LLIOSleep() {}
protected:
/* @name LLIOPipe virtual implementations
*/
//@{
/**
* @brief Process the data in buffer
*/
EStatus process_impl(
const LLChannelDescriptors& channels,
buffer_ptr_t& buffer,
bool& eos,
LLSD& context,
LLPumpIO* pump);
//@}
protected:
F64 mSeconds;
};
/**
* @class LLIOAddChain
* @brief Simple pipe that just adds a chain to a pump.
* @see LLIOPipe
*/
class LLIOAddChain : public LLIOPipe
{
public:
LLIOAddChain(const LLPumpIO::chain_t& chain, F32 timeout) :
mChain(chain),
mTimeout(timeout)
{}
virtual ~LLIOAddChain() {}
protected:
/* @name LLIOPipe virtual implementations
*/
//@{
/**
* @brief Process the data in buffer
*/
EStatus process_impl(
const LLChannelDescriptors& channels,
buffer_ptr_t& buffer,
bool& eos,
LLSD& context,
LLPumpIO* pump);
//@}
protected:
LLPumpIO::chain_t mChain;
F32 mTimeout;
};
/**
* @class LLChangeChannel
* @brief This class changes the channel of segments in the buffer
* @see LLBufferArray
*
* This class is useful for iterating over the segments in a buffer
* array and changing each channel that matches to a different
* channel.
* Example:
* <code>
* set_in_to_out(LLChannelDescriptors channels, LLBufferArray* buf)
* {
* std::for_each(
* buf->beginSegment(),
* buf->endSegment(),
* LLChangeChannel(channels.in(), channels.out()));
* }
* </code>
*/
class LLChangeChannel
{
public:
/**
* @brief Constructor for iterating over a segment range to change channel.
*
* @param is The channel to match when looking at a segment.
* @param becomes The channel to set the segment when a match is found.
*/
LLChangeChannel(S32 is, S32 becomes);
/**
* @brief Do the work of changing the channel
*/
void operator()(LLSegment& segment);
protected:
S32 mIs;
S32 mBecomes;
};
#endif // LL_LLIOUTIL_H
|
