Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
RpcController.h
1 /*
2  * This library is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU Lesser General Public
4  * License as published by the Free Software Foundation; either
5  * version 2.1 of the License, or (at your option) any later version.
6  *
7  * This library is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10  * Lesser General Public License for more details.
11  *
12  * You should have received a copy of the GNU Lesser General Public
13  * License along with this library; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15  *
16  * RpcController.h
17  * The RpcController.
18  * Copyright (C) 2005 Simon Newton
19  */
20 
21 #ifndef COMMON_RPC_RPCCONTROLLER_H_
22 #define COMMON_RPC_RPCCONTROLLER_H_
23 
24 #include <ola/Callback.h>
25 #include <string>
26 
27 namespace ola {
28 namespace rpc {
29 
30 class RpcSession;
31 
43  public:
48  explicit RpcController(RpcSession *session = NULL);
49  ~RpcController() {}
50 
54  void Reset();
55 
60  bool Failed() const { return m_failed; }
61 
66  std::string ErrorText() const { return m_error_text; }
67 
72  void SetFailed(const std::string &reason);
73 
81 
82  private:
83  RpcSession *m_session;
84  bool m_failed;
85  std::string m_error_text;
86 };
87 } // namespace rpc
88 } // namespace ola
89 
90 #endif // COMMON_RPC_RPCCONTROLLER_H_
Represents the RPC session between a client and server.
Definition: RpcSession.h:45
std::string ErrorText() const
Return the error string if the RPC failed.
Definition: RpcController.h:66
void SetFailed(const std::string &reason)
Mark this RPC as failed.
Definition: RpcController.cpp:40
RpcController(RpcSession *session=NULL)
Create a new RpcController.
Definition: RpcController.cpp:29
RpcSession * Session()
Get the session information for this RPC.
Definition: RpcController.cpp:45
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
A RpcController object is passed every time an RPC is invoked and is used to indicate the success or ...
Definition: RpcController.h:42
bool Failed() const
Check if the RPC call this controller was associated with failed.
Definition: RpcController.h:60
void Reset()
Reset the state of this controller. Does not affect the session.
Definition: RpcController.cpp:35