/usr/include/Wt/Http/ResponseContinuation is in libwt-dev 3.3.0-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2009 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef HTTP_RESPONSE_CONTINUATION_H_
#define HTTP_RESPONSE_CONTINUATION_H_
#include <Wt/WDllDefs.h>
#include <boost/any.hpp>
namespace Wt {
class WResource;
class WebResponse;
class WebSession;
namespace Http {
class Response;
/*! \class ResponseContinuation Wt/Http/ResponseContinuation Wt/Http/ResponseContinuation
* \brief A resource response continuation object.
*
* A response continuation object is used to keep track of a response
* which is to be continued.
*
* You may associate data with the object using setData().
*
* A continuation is used to resume sending more data later for this
* response. There are two possible reasons for this:
* - the entire response is quite big and you may want to read and send
* it in smaller chunks. This avoids unbounded memory usage since the
* I/O layer buffers the response first in memory to send it then out
* to a possibly slow client using async I/O.
* - you may not have any more data available, currently, but expect more
* data later. In that case you can call waitForMoreData() and later call
* WResource::haveMoreData() when more data is available.
*
* \sa Response::createContinuation(), Request::continuation()
*
* \ingroup http
*/
class WT_API ResponseContinuation
{
public:
/*! \brief Set data associated with the continuation.
*
* You could do this to keep track of the state of sending the data
* for a WResource.
*/
void setData(const boost::any& data);
/*! \brief Return data associated with the continuation.
*
* \sa setData()
*/
boost::any data() { return data_; }
/*! \brief Return the resource.
*/
WResource *resource() const { return resource_; }
/*! \brief Wait for more data.
*
* This suspends the handling of this request until more data is
* available, which is indicated to a resource using
* WResource::haveMoreData().
*/
void waitForMoreData();
/*! \brief Returns whether this continuation is waiting for data.
*
* \sa waitForMoreData()
*/
bool isWaitingForMoreData() const { return waiting_; }
/*
* Only useful for server-side events: force continuation.
*/
void doContinue();
private:
WResource *resource_;
WebResponse *response_;
boost::any data_;
bool waiting_;
ResponseContinuation(WResource *resource, WebResponse *response);
ResponseContinuation(const ResponseContinuation&);
~ResponseContinuation();
void stop();
WebResponse *response() { return response_; }
friend class Wt::WResource;
friend class Wt::WebSession;
friend class Response;
};
}
}
#endif // HTTP_RESPONSE_CONTINUATION_H_
|