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
|
/*
Copyright (C) 2001 Stefan Westerfeld
[email protected]
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef ARTS_MCOP_DELAYEDRETURN_H
#define ARTS_MCOP_DELAYEDRETURN_H
#include "arts_export.h"
/*
* BC - Status (2002-03-08): DelayedReturn
*
* This class will be kept binary compatible. It has a private d-pointer for
* further extensions.
*/
namespace Arts {
class AnyConstRef;
class Buffer;
class Connection;
class DelayedReturnPrivate;
/**
* The "DelayedReturn" class implements delayed returning from functions.
*
* For instance, suppose you would like to return from a wait() operation
* only after a certain time has passed, without blocking other clients
* from using your interface during this time.
*
* Your implementation (in the skel file) of wait should look like this
*
* <pre>
* static DelayedReturn *delayedReturn = 0;
*
* bool TimeServer::waitUntil(long time)
* {
* if(time(0) < time)
* {
* // ... initialize timer here ...
* delayedReturn = Dispatcher::the()->delayReturn();
* }
* return false;
* }
*
* void timerEvent()
* {
* delayedReturn->doReturn(true);
* }
* </pre>
*
* NOTE: this class breaks for local use (i.e. you can only use it if the
* call was a remote call), so it is strongly recommended not to use it
* unless there is no alternative (and you should really know what you are
* doing, too).
*/
class ARTS_EXPORT DelayedReturn {
friend class Dispatcher;
private:
DelayedReturnPrivate *d;
protected:
Buffer *buffer;
Connection *connection;
DelayedReturn();
void initialize(Connection *connection, Buffer *buffer);
~DelayedReturn();
public:
/**
* call this only once to make the request really return
*/
void doReturn(const AnyConstRef& value);
/**
* return without value (for void functions)
*/
void doReturn();
};
}
#endif /* ARTS_MCOP_DELAYEDRETURN_H */
|
