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
|
/**
* @file llchainio.h
* @author Phoenix
* @date 2005-08-04
* @brief This class declares the interface for constructing io chains.
*
* Copyright (c) 2005-2007, Linden Research, Inc.
*
* The source code in this file ("Source Code") is provided by Linden Lab
* to you under the terms of the GNU General Public License, version 2.0
* ("GPL"), unless you have obtained a separate licensing agreement
* ("Other License"), formally executed by you and Linden Lab. Terms of
* the GPL can be found in doc/GPL-license.txt in this distribution, or
* online at http://secondlife.com/developers/opensource/gplv2
*
* There are special exceptions to the terms and conditions of the GPL as
* it is applied to this Source Code. View the full text of the exception
* in the file doc/FLOSS-exception.txt in this software distribution, or
* online at http://secondlife.com/developers/opensource/flossexception
*
* By copying, modifying or distributing this software, you acknowledge
* that you have read and understood your obligations described above,
* and agree to abide by those obligations.
*
* ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
* WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
* COMPLETENESS OR PERFORMANCE.
*/
#ifndef LL_LLCHAINIO_H
#define LL_LLCHAINIO_H
#include "llpumpio.h"
/**
* @class LLDeferredChain
* @brief This class allows easy addition of a chain which will sleep
* and then process another chain.
*/
class LLDeferredChain
{
public:
/**
* @brief Add a chain to a pump in a finite # of seconds
*
* @prarm pump The pump to work on.
* @prarm in_seconds The number of seconds from now when chain should start.
* @prarm chain The chain to add in in_seconds seconds.
* @prarm chain_timeout timeout for chain on the pump.
* @return Returns true if the operation was queued.
*/
static bool addToPump(
LLPumpIO* pump,
F32 in_seconds,
const LLPumpIO::chain_t& chain,
F32 chain_timeout);
};
/**
* @class LLChainIOFactory
* @brief This class is an abstract base class for building io chains.
*
* This declares an abstract base class for a chain factory. The
* factory is used to connect an input pipe to the first pipe in the
* chain, and an output pipe to the last pipe in the chain. This will
* allow easy construction for buffer based io like services to for
* API centered IO while abstracting the input and output to simple
* data passing.
* To use this class, you should derive a class which implements the
* <code>build</code> method.
*/
class LLChainIOFactory
{
public:
// Constructor
LLChainIOFactory();
// Destructor
virtual ~LLChainIOFactory();
/**
* @brief Build the chian with in as the first and end as the last
*
* The caller of the LLChainIOFactory is responsible for managing
* the memory of the in pipe. All of the chains generated by the
* factory will be ref counted as usual, so the caller will also
* need to break the links in the chain.
* @param chain The chain which will have new pipes appended
* @param context A context for use by this factory if you choose
* @retrun Returns true if the call was successful.
*/
virtual bool build(LLPumpIO::chain_t& chain, LLSD context) const = 0;
protected:
};
/**
* @class LLSimpleIOFactory
* @brief Basic implementation for making a factory that returns a
* 'chain' of one object
*/
template<class Pipe>
class LLSimpleIOFactory : public LLChainIOFactory
{
public:
virtual bool build(LLPumpIO::chain_t& chain, LLSD context) const
{
chain.push_back(LLIOPipe::ptr_t(new Pipe));
return true;
}
};
/**
* @class LLCloneIOFactory
* @brief Implementation for a facory which copies a particular pipe.
*/
template<class Pipe>
class LLCloneIOFactory : public LLChainIOFactory
{
public:
LLCloneIOFactory(Pipe* original) :
mHandle(original),
mOriginal(original) {}
virtual bool build(LLPumpIO::chain_t& chain, LLSD context) const
{
chain.push_back(LLIOPipe::ptr_t(new Pipe(*mOriginal)));
return true;
}
protected:
LLIOPipe::ptr_t mHandle;
Pipe* mOriginal;
};
#endif // LL_LLCHAINIO_H
|
