Responder.h
1 /*
2  * Copyright (C) 2012 by Marc Boris 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_Http_Responder_h
30 #define Pt_Http_Responder_h
31 
32 #include <Pt/Http/Api.h>
33 
34 namespace Pt {
35 
36 namespace System {
37 class EventLoop;
38 }
39 
40 namespace Http {
41 
42 class Request;
43 class Reply;
44 class Service;
45 class Acceptor;
46 
49 class PT_HTTP_API Responder
50 {
51  public:
54  explicit Responder(Service& s);
55 
58  virtual ~Responder();
59 
63  { return _service; }
64 
67  const Service& service() const
68  { return _service; }
69 
70  void setAcceptor(Acceptor& a)
71  { _acceptor = &a; }
72 
75  void beginRequest(Request& request, Reply& reply,
76  System::EventLoop& loop);
77 
80  void readRequest(Request& request, Reply& reply,
81  System::EventLoop& loop);
82 
85  void beginReply(const Request& request, Reply& reply,
86  System::EventLoop& loop);
87 
90  void writeReply(const Request& request, Reply& reply,
91  System::EventLoop& loop);
92 
93  protected:
96  virtual void onBeginRequest(Request& request, Reply& reply,
97  System::EventLoop& loop) = 0;
98 
99  virtual void onReadRequest(Request& request, Reply& reply,
100  System::EventLoop& loop) = 0;
101 
104  virtual void onBeginReply(const Request& request, Reply& reply,
105  System::EventLoop& loop) = 0;
106 
109  virtual void onWriteReply(const Request& request, Reply& reply,
110  System::EventLoop& loop) = 0;
111 
112  // TODO: setFinished() -> setReady()
113 
114  void setReady(bool isFinished);
115 
116  void setFinished(bool isFinished);
117 
118  private:
119  Service& _service;
120  Acceptor* _acceptor;
121 };
122 
123 } // namespace Http
124 
125 } // namespace Pt
126 
127 #endif // Pt_Http_Responder_h
Core module.
Definition: pt-gfx-images.dox:14
HTTP request message.
Definition: Request.h:44
Responder(Service &s)
Construct with service.
HTTP reply message.
Definition: Reply.h:44
void beginRequest(Request &request, Reply &reply, System::EventLoop &loop)
Called when the request header was received.
virtual ~Responder()
Destructor.
void readRequest(Request &request, Reply &reply, System::EventLoop &loop)
Called when request body data was received.
virtual void onBeginRequest(Request &request, Reply &reply, System::EventLoop &loop)=0
Called when the request header was received.
HTTP service.
Definition: Service.h:47
virtual void onWriteReply(const Request &request, Reply &reply, System::EventLoop &loop)=0
Write responding reply.
void beginReply(const Request &request, Reply &reply, System::EventLoop &loop)
Called when request is complete.
HTTP service responder.
Definition: Responder.h:50
const Service & service() const
Returns the service for which to respond.
Definition: Responder.h:67
void writeReply(const Request &request, Reply &reply, System::EventLoop &loop)
Write responding reply.
Service & service()
Returns the service for which to respond.
Definition: Responder.h:62
Thread-safe event loop supporting I/O multiplexing and Timers.
Definition: EventLoop.h:74
virtual void onBeginReply(const Request &request, Reply &reply, System::EventLoop &loop)=0
Called when request is complete.