Wt  3.3.2
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Types | Public Member Functions | Protected Member Functions | List of all members
Wt::WResource Class Referenceabstract

An object which can be rendered in the HTTP protocol. More...

#include <Wt/WResource>

Inheritance diagram for Wt::WResource:
Inheritance graph
[legend]

Public Types

enum  DispositionType { NoDisposition, Attachment, Inline }
 Values for the disposition type in the Content-Disposition header. More...
 
- Public Types inherited from Wt::WObject
typedef void(WObject::* Method )()
 Typedef for a WObject method without arguments.
 

Public Member Functions

 WResource (WObject *parent=0)
 Creates a new resource.
 
 ~WResource ()
 Destroys the resource. More...
 
void suggestFileName (const Wt::WString &name, DispositionType dispositionType=Attachment)
 Suggests a filename to the user for the data streamed by this resource. More...
 
const Wt::WStringsuggestedFileName () const
 Returns the suggested file name. More...
 
void setDispositionType (DispositionType cd)
 Configures the Content-Disposition header. More...
 
DispositionType dispositionType () const
 Returns the currently configured content disposition. More...
 
void setChanged ()
 Generates a new URL for this resource and emits the changed signal. More...
 
void setInternalPath (const std::string &path)
 Sets an internal path for this resource. More...
 
std::string internalPath () const
 Returns the internal path. More...
 
const std::string & generateUrl ()
 Generates an URL for this resource. More...
 
const std::string & url () const
 Returns the current URL for this resource. More...
 
SignaldataChanged ()
 Signal emitted when the data presented in this resource has changed. More...
 
void setUploadProgress (bool enabled)
 Indicate interest in upload progress. More...
 
Signal< ::uint64_t,::uint64_t > & dataReceived ()
 Signal emitted when data has been received for this resource. More...
 
void write (std::ostream &out, const Http::ParameterMap &parameters=Http::ParameterMap(), const Http::UploadedFileMap &files=Http::UploadedFileMap())
 Stream the resource to a stream. More...
 
virtual void handleRequest (const Http::Request &request, Http::Response &response)=0
 Handles a request. More...
 
void haveMoreData ()
 Indicate that more data is available. More...
 
- Public Member Functions inherited from Wt::WObject
 WObject (WObject *parent=0)
 Create a WObject with a given parent object. More...
 
virtual ~WObject ()
 Destructor. More...
 
virtual const std::string id () const
 Returns the (unique) identifier for this object. More...
 
virtual void setObjectName (const std::string &name)
 Sets an object name. More...
 
virtual std::string objectName () const
 Returns the object name. More...
 
void resetLearnedSlots ()
 Resets learned stateless slot implementations. More...
 
template<class T >
void resetLearnedSlot (void(T::*method)())
 Resets a learned stateless slot implementation. More...
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)())
 Declares a slot to be stateless and learn client-side behaviour on first invocation. More...
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)(), void(T::*undoMethod)())
 Declares a slot to be stateless and learn client-side behaviour in advance. More...
 
template<class T >
WStatelessSlot * implementJavaScript (void(T::*method)(), const std::string &jsCode)
 Provides a JavaScript implementation for a method. More...
 
void addChild (WObject *child)
 Adds a child object. More...
 
virtual void removeChild (WObject *child)
 Removes a child object. More...
 
const std::vector< WObject * > & children () const
 Returns the children.
 
WObjectparent () const
 Returns the parent object.
 

Protected Member Functions

void beingDeleted ()
 Prepares the resource for deletion. More...
 
- Protected Member Functions inherited from Wt::WObject
virtual WStatelessSlot * getStateless (Method method)
 On-demand stateless slot implementation. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from Wt::WObject
static WObjectsender ()
 Returns the sender of the current slot call. More...
 

Detailed Description

An object which can be rendered in the HTTP protocol.

Usage

Besides the main page, other objects may be rendered as additional resources, for example documents or images. Classes such as WAnchor or WImage can use a resource instead of a URL to provide their contents. Whenever the resource has changed, you should call the setChanged() method. setChanged() will make sure that the browser will use a new version of the resource by generating a new URL, and emits the dataChanged() signal to make those that refer to the resource aware that they should update their references to the new URL.

You can help the browser to start a suitable helper application to handle the downloaded resource, or suggest to the user a suitable filename for saving the resource, by setting an appropriate file name using suggestFileName().

To serve resources that you create on the fly, you need to specialize this class and implement handleRequest().

Example for a custom resource implementation:

class MyResource : public Wt::WResource
{
public:
MyResource(Wt::WObject *parent = 0)
: Wt::WResource(parent)
{
suggestFileName("data.txt");
}
~MyResource() {
beingDeleted(); // see "Concurrency issues" below.
}
void handleRequest(const Wt::Http::Request& request,
Wt::Http::Response& response) {
response.setMimeType("plain/text");
response.out() << "I am a text file." << std::endl;
}
};

Concurrency issues

Because of the nature of the web, a resource may be requested one time or multiple times at the discretion of the browser, and therefore your resource should in general not have any side-effects except for what is needed to render its own contents. Unlike event notifications to a Wt application, resource requests are not serialized, but are handled concurrently. You need to grab the application lock if you want to access or modify other widget state from within the resource. When deleting a resource, any pending request is cancelled first. For this mechanism to work you need to specialize the destructor and call beingDeleted(). This method may safely be called multiple times (i.e. from within each destructor in the hierachy).

Continuations for asynchronous I/O

With respect to I/O, the current strategy is to cache the whole response first in a buffer and use async I/O to push the data to the client, in order to free the thread while waiting for I/O on a possibly slow link. You do not necessarily have to provide all output at once, instead you can obtain a Http::ResponseContinuation object for a response, construct the response piecewise. A new request() will be made to continue the response.

Example for a custom resource implementation using continuations:

class MyResource : public Wt::WResource
{
public:
MyResource(int iterations, Wt::WObject *parent = 0)
: Wt::WResource(parent),
iterations_(iterations)
{
suggestFileName("data.txt");
}
~MyResource() {
}
void handleRequest(const Wt::Http::Request& request,
Wt::Http::Response& response) {
// see if this request is for a continuation:
Wt::Http::ResponseContinuation *continuation = request.continuation();
// calculate the current start
int iteration = continuation ? boost::any_cast<int>(continuation->data()) : 0;
if (iteration == 0)
response.setMimeType("plain/text");
int last = std::min(iterations_, iteration + 100);
for (int i = iteration; i < last; ++i)
response.out() << "Data item " << i << std::endl;
// if we have not yet finished, create a continuation to serve more
if (last < iterations_) {
continuation = response.createContinuation();
// remember what to do next
continuation->setData(last);
}
}
private:
int iterations_;
};

Global and private resources

By default, a resource is private to an application: access to it is protected by same secret session Id that protects any other access to the application.

You can also deploy static resources, which are global, using WServer::addResource().

Monitoring upload progress

A resource may also handle the uploading of files (in fact, WFileUpload uses a WResource to do exactly that) or transmission of other large bodies of data being POST'ed or PUT to the resource URL. For these requests, it may be convenient to enable upload progress monitoring using setUploadProgress(), which allows you to be notified of data being received.

See Also
WAnchor, WImage

Member Enumeration Documentation

Values for the disposition type in the Content-Disposition header.

Enumerator
NoDisposition 

Do not specify a disposition type.

Attachment 

Open with a helper application or show 'Save As' dialog.

Inline 

View with a browser plugin.

Constructor & Destructor Documentation

Wt::WResource::~WResource ( )

Destroys the resource.

When specializing a resource, you MUST call beingDeleted() from within the specialized destructor, in order to stop any further requests to the resource.

Member Function Documentation

void Wt::WResource::beingDeleted ( )
protected

Prepares the resource for deletion.

When specializing a resource, you MUST call beingDeleted() from within the specialized destructor, in order to stop any further requests to the resource.

Signal& Wt::WResource::dataChanged ( )

Signal emitted when the data presented in this resource has changed.

Widgets that reference the resource (such as anchors and images) will make sure the new data is rendered.

It is better to call setChanged() than to emit this signal. setChanged generates a new URL for this resource to avoid caching problems and then emits this signal.

Signal< ::uint64_t, ::uint64_t >& Wt::WResource::dataReceived ( )

Signal emitted when data has been received for this resource.

When this signal is emitted, you have the update lock to modify the application. Because there is however no corresponding request from the browser, any update to the user interface is not immediately reflected in the client. To update the client interface, you need to use a WTimer or enable server-push.

See Also
setUploadProgress()
DispositionType Wt::WResource::dispositionType ( ) const

Returns the currently configured content disposition.

See Also
setDispositionType()
const std::string & Wt::WResource::generateUrl ( )

Generates an URL for this resource.

Generates a new url that refers to this resource. The url is unique to assure that it is not cached by the web browser, and can thus be used to refer to a new "version" of the resource, which can be indicated by emitting the dataChanged() signal.

The old urls are not invalidated by calling this method.

virtual void Wt::WResource::handleRequest ( const Http::Request request,
Http::Response response 
)
pure virtual

Handles a request.

Reimplement this method so that a proper response is generated for the given request. From the request object you can access request parameters and whether the request is a continuation request. In the response object, you should set the mime type and stream the output data.

A request may also concern a continuation, indicated in Http::Request::continuation(), in which case the next part for a previously created continuation should be served.

While handling a request, which may happen at any time together with event handling, the library makes sure that the resource is not being concurrently deleted, but multiple requests may happend simultaneously for a single resource.

Implemented in Wt::WPdfImage, Wt::WRasterImage, Wt::WFileResource, Wt::WMemoryResource, Wt::WSvgImage, and Wt::Ext::DataStore.

void Wt::WResource::haveMoreData ( )

Indicate that more data is available.

In some occasions, data may be requested for a resource which is currently not yet available. Then you can suspend the response using a continuation which you let wait for more data.

Using this method you can indicate that more data is available. This will resume all responses that are currently waiting for more data.

If no responses are currently waiting for data, then this method has no effect.

See Also
ResponseContinuation::waitForMoreData()
std::string Wt::WResource::internalPath ( ) const

Returns the internal path.

See Also
setInternalPath().
void Wt::WResource::setChanged ( )

Generates a new URL for this resource and emits the changed signal.

This does not work when the resource is deployed at an internal path using setInternalPath().

void Wt::WResource::setDispositionType ( DispositionType  cd)

Configures the Content-Disposition header.

The Content-Disposition header allows to instruct the browser that a resource should be shown inline or as attachment. This function enables you to set this property.

This is often used in combination with suggestFilename(). The Content-Disposition must not be None when a filename is given; if this case is encountered, None will be rendered as Attachment.

See Also
suggestFilename().
void Wt::WResource::setInternalPath ( const std::string &  path)

Sets an internal path for this resource.

Using this method you can deploy the resource at a fixed path. Unless you deploy using cookies for session tracking (not recommended), a session identifier will be appended to the path.

You should use internal paths that are different from internal paths handled by your application (WApplication::setInternalPath()), if you do not want a conflict between these two when the browser does not use AJAX (and thus url fragments for its internal paths).

The default value is empty. By default the URL for a resource is unspecified and a URL will be generated by the library.

The internal path for a static resource is the deployment path specified using WServer::addResource().

void Wt::WResource::setUploadProgress ( bool  enabled)

Indicate interest in upload progress.

When supported, you can track upload progress using this signal. While data is being received, and before handleRequest() is called, progress information is indicated using dataReceived().

We envision that in the future support will depend on a combination of browser and connector. Currently only the wthttp connector provides support for this across all AJAX browsers. In the future, we are likely to implement this also using JavaScript File API features making it independent of connectors.

The default value is false.

const Wt::WString& Wt::WResource::suggestedFileName ( ) const

Returns the suggested file name.

See Also
suggestFileName();
void Wt::WResource::suggestFileName ( const Wt::WString name,
DispositionType  dispositionType = Attachment 
)

Suggests a filename to the user for the data streamed by this resource.

For resources, intended to be downloaded by the user, suggest a name used for saving. The filename extension may also help the browser to identify the correct program for opening the resource.

The disposition type determines if the resource is intended to be opened by a plugin in the browser (Inline), or to be saved to disk (Attachment). NoDisposition is not a valid Content-Disposition when a filename is suggested; this will be rendered as Attachment.

See Also
setDispositionType().
const std::string & Wt::WResource::url ( ) const

Returns the current URL for this resource.

Returns the url that references this resource.

void Wt::WResource::write ( std::ostream &  out,
const Http::ParameterMap parameters = Http::ParameterMap(),
const Http::UploadedFileMap files = Http::UploadedFileMap() 
)

Stream the resource to a stream.

This is a convenience method to serialize to a stream (for example a file stream).


Generated on Wed Mar 12 2014 for the C++ Web Toolkit (Wt) by doxygen 1.8.4