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
|
/*
* Copyright (C) 2011 Intel Corporation
*
* 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; either
* version 2.1 of the License, or (at your option) version 3.
*
* 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
*/
#ifndef INFO_REQ_H
#define INFO_REQ_H
#include <string>
#include "gdbus-cxx-bridge.h"
#include "timeout.h"
#include <boost/signals2.hpp>
#include <syncevo/declarations.h>
SE_BEGIN_CXX
class Server;
/**
* A wrapper for handling info request and response.
*/
class InfoReq {
public:
typedef std::map<std::string, std::string> InfoMap;
// status of current request
enum Status {
ST_RUN, // request is running
ST_OK, // ok, response is gotten
ST_TIMEOUT, // timeout
ST_CANCEL // request is cancelled
};
/**
* constructor
* The default timeout is 120 seconds
*/
InfoReq(Server &server,
const std::string &type,
const InfoMap ¶meters,
const std::string &sessionPath,
uint32_t timeout = 120);
~InfoReq();
std::string getId() const { return m_id; }
std::string getSessionPath() const;
std::string getInfoStateStr() const { return infoStateToString(m_infoState); }
std::string getHandler() const { return m_handler; }
std::string getType() const { return m_type; }
const InfoMap& getParam() const { return m_param; }
/**
* Connect to this signal to be notified that a final response has
* been received.
*/
typedef boost::signals2::signal<void (const InfoMap &)> ResponseSignal_t;
ResponseSignal_t m_responseSignal;
/**
* Connect to this signal to be notified when it is considered timed out.
* The timeout counting restarts each time any client sends any kind of
* response.
*/
typedef boost::signals2::signal<void ()> TimeoutSignal_t;
TimeoutSignal_t m_timeoutSignal;
/** get current status in string format */
std::string getStatusStr() const { return statusToString(m_status); }
/** set response from dbus clients */
void setResponse(const GDBusCXX::Caller_t &caller, const std::string &state, const InfoMap &response);
private:
static std::string statusToString(Status status);
enum InfoState {
IN_REQ, //request
IN_WAIT, // waiting
IN_DONE // done
};
static std::string infoStateToString(InfoState state);
Server &m_server;
/** caller's session, might be NULL */
const std::string m_sessionPath;
/** unique id of this info request */
std::string m_id;
/** times out this amount of seconds after last interaction with client */
uint32_t m_timeoutSeconds;
Timeout m_timeout;
/** info req state defined in dbus api */
InfoState m_infoState;
/** status to indicate the info request is timeout, ok, abort, etc */
Status m_status;
/** the handler of the responsed dbus client */
GDBusCXX::Caller_t m_handler;
/** the type of the info request */
std::string m_type;
/** parameters from info request callers */
InfoMap m_param;
/** response returned from dbus clients */
InfoMap m_response;
void done();
};
SE_END_CXX
#endif // INFO_REQ_H
|
