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
|
/*
Copyright (C) 2000 Stefan Westerfeld
stefan@space.twc.de
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 MCOP_DYNAMICREQUEST_H
#define MCOP_DYNAMICREQUEST_H
#include "buffer.h"
#include "anyref.h"
#include <vector>
#include <string>
#include "arts_export.h"
/*
* BC - Status (2002-03-08): DynamicRequest
*
* Has to be kept binary compatible (use d ptr).
*/
namespace Arts {
class Object;
class Type;
class DynamicRequestPrivate;
/**
* The DynamicRequest class can be used to invoke requests on objects, without
* using IDL generated code to do so (i.e. you can talk to objects without
* having to know their interfaces at compile time)
*
* Suppose you have the interface
*
* interface SimpleSoundServer {
* [...]
* long play(string file); // plays a file and returns an id
* [...]
* };
*
* And server is of type SimpleSoundServer, you can write in your C++ code:
*
* long id;
* if(DynamicRequest(server).method("play").param("/tmp/bong.wav").invoke(id))
* {
* cout << "playing file now, id is " << id << endl;
* }
* else
* {
* cout << "something went wrong with the dynamic request" << endl;
* }
*
* You can of course also add parameters and other information one-by-one:
*
* DynamicRequest request(server);
* request.method("play");
* request.param("/tmp/bong.wav");
*
* long id;
* if(request.invoke(id)) cout << "success" << endl;
*/
class ARTS_EXPORT DynamicRequest {
public:
/**
* creates a dynamic request which will be sent to a specific object
*/
DynamicRequest(const Object& object);
/**
* deletes the dynamic request
*/
~DynamicRequest();
/**
* says that the following method will be a oneway method, for example
*
* DynamicRequest(someobject).oneway().method("stop").invoke();
*/
DynamicRequest& oneway();
/**
* sets the method to invoke
*/
DynamicRequest& method(const std::string& method);
/**
* adds a parameter to the call
*/
DynamicRequest& param(const AnyConstRef& value);
/**
* executes the request, call this if you don't expect a return type
*
* @returns true if the request could be performed
*/
bool invoke();
/**
* executes the request: this version accepts an AnyRef& as result type
*
* @returns true if the request could be performed
*/
bool invoke(const AnyRef& result);
/*
* TODO: Some types can't yet be used in dynamic requests, these are
* enum, sequence<enum>, type, sequence<type>, object, sequence<object>
*/
private:
DynamicRequestPrivate *d;
};
}
#endif /* MCOP_DYNAMICREQUEST_H */
|
