ServiceProcedure.h
1 /*
2  * Copyright (C) 2009-2014 by Marc Duerner
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * As a special exception, you may use this file as part of a free
10  * software library without restriction. Specifically, if other files
11  * instantiate templates or use macros or inline functions from this
12  * file, or you compile this file and link it with other files to
13  * produce an executable, this file does not by itself cause the
14  * resulting executable to be covered by the GNU General Public
15  * License. This exception does not however invalidate any other
16  * reasons why the executable file might be covered by the GNU Library
17  * General Public License.
18  *
19  * This library is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22  * Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public
25  * License along with this library; if not, write to the Free Software
26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27  */
28 
29 #ifndef PT_REMOTING_SERVICEPROCEDURE_H
30 #define PT_REMOTING_SERVICEPROCEDURE_H
31 
32 #include <Pt/Remoting/Api.h>
33 #include <Pt/Remoting/Responder.h>
34 #include <Pt/System/EventLoop.h>
35 #include <Pt/Decomposer.h>
36 #include <Pt/Composer.h>
37 
38 namespace Pt {
39 
40 namespace Remoting {
41 
45 {
46  public:
50  {}
51 
54  void setReady()
55  { _responder->setReady(); }
56 
58  Composer** beginArgs()
59  { return onBeginArgs(); }
60 
62  void beginCall(System::EventLoop& loop)
63  { onBeginCall(loop); }
64 
66  Decomposer* endCall()
67  { return onEndCall(); }
68 
69  protected:
73  : _responder( &r )
74  {}
75 
77  virtual Composer** onBeginArgs() = 0;
78 
80  virtual void onBeginCall(System::EventLoop& loop) = 0;
81 
83  virtual Decomposer* onEndCall() = 0;
84 
85  private:
86  Responder* _responder;
87 };
88 
89 
90 class ServiceProcedureDef
91 {
92  public:
93  virtual ~ServiceProcedureDef()
94  {}
95 
96  ServiceProcedure* createProcedure(Responder& r) const
97  { return this->onCreateProcedure(r); }
98 
99  protected:
100  ServiceProcedureDef()
101  {}
102 
103  virtual ServiceProcedure* onCreateProcedure(Responder& r) const = 0;
104 };
105 
106 } // namespace Remoting
107 
108 } // namespace Pt
109 
110 #endif // PT_REMOTING_SERVICEPROCEDURE_H
111 
112 #include <Pt/Remoting/BasicProcedure.h>
113 #include <Pt/Remoting/ActiveProcedure.h>
XML-RPC service procedure.
Definition: ServiceProcedure.h:44
ServiceProcedure(Responder &r)
Constructor.
Definition: ServiceProcedure.h:72
Composes types during serialization.
Definition: Composer.h:42
void setReady()
Indicates that the procedure has finished.
Definition: ServiceProcedure.h:54
Thread-safe event loop supporting I/O multiplexing and Timers.
Definition: EventLoop.h:72
virtual ~ServiceProcedure()
Destructor.
Definition: ServiceProcedure.h:49
Dispatches requests to a service procedure.
Definition: Responder.h:49
Manages the decomposition of types during serialization.
Definition: Decomposer.h:43