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
34namespace Pt {
35
36namespace System {
37class EventLoop;
38}
39
40namespace Http {
41
42class Request;
43class Reply;
44class Service;
45class Acceptor;
46
108class PT_HTTP_API Responder
109{
110 public:
113 explicit Responder(Service& s);
114
117 virtual ~Responder();
118
122 { return _service; }
123
126 const Service& service() const
127 { return _service; }
128
130 void setAcceptor(Acceptor& a)
131 { _acceptor = &a; }
132
135 void beginRequest(Request& request, Reply& reply,
136 System::EventLoop& loop);
137
140 void readRequest(Request& request, Reply& reply,
141 System::EventLoop& loop);
142
145 void beginReply(const Request& request, Reply& reply,
146 System::EventLoop& loop);
147
150 void writeReply(const Request& request, Reply& reply,
151 System::EventLoop& loop);
152
153 protected:
156 virtual void onBeginRequest(Request& request, Reply& reply,
157 System::EventLoop& loop) = 0;
158
161 virtual void onReadRequest(Request& request, Reply& reply,
162 System::EventLoop& loop) = 0;
163
166 virtual void onBeginReply(const Request& request, Reply& reply,
167 System::EventLoop& loop) = 0;
168
171 virtual void onWriteReply(const Request& request, Reply& reply,
172 System::EventLoop& loop) = 0;
173
174 // TODO: setFinished() -> setReady()
175
178 void setReady(bool isFinished);
179
182 void setFinished(bool isFinished);
183
184 private:
185 Service& _service;
186 Acceptor* _acceptor;
187};
188
189} // namespace Http
190
191} // namespace Pt
192
193#endif // Pt_Http_Responder_h
HTTP reply message.
Definition Reply.h:64
HTTP request message.
Definition Request.h:65
void writeReply(const Request &request, Reply &reply, System::EventLoop &loop)
Write responding reply.
virtual void onWriteReply(const Request &request, Reply &reply, System::EventLoop &loop)=0
Write responding reply.
virtual ~Responder()
Destructor.
Service & service()
Returns the service for which to respond.
Definition Responder.h:121
void setFinished(bool isFinished)
Sets whether the exchange is finished.
Responder(Service &s)
Construct with service.
virtual void onReadRequest(Request &request, Reply &reply, System::EventLoop &loop)=0
Called for each chunk of the request body.
void beginReply(const Request &request, Reply &reply, System::EventLoop &loop)
Called when request is complete.
void setReady(bool isFinished)
Sets whether the current step is complete.
void beginRequest(Request &request, Reply &reply, System::EventLoop &loop)
Called when the request header was received.
virtual void onBeginReply(const Request &request, Reply &reply, System::EventLoop &loop)=0
Called when request is complete.
const Service & service() const
Returns the service for which to respond.
Definition Responder.h:126
virtual void onBeginRequest(Request &request, Reply &reply, System::EventLoop &loop)=0
Called when the request header was received.
void readRequest(Request &request, Reply &reply, System::EventLoop &loop)
Called when request body data was received.
Factory for request responders.
Definition Service.h:77
Event loop of a thread or process.
Definition EventLoop.h:83
HTTP clients and servers.
System programming
Definition Connection.h:26
Core module.
Definition Allocator.h:33