From 10caa4c1dfb17ffef608729b3428a7ae5b9f897f Mon Sep 17 00:00:00 2001 From: colin-adams Date: Wed, 7 Aug 2013 09:48:38 -0700 Subject: [PATCH] Updated Writing the handlers (markdown) --- Writing-the-handlers.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/Writing-the-handlers.md b/Writing-the-handlers.md index e82961ec..461e2a1b 100644 --- a/Writing-the-handlers.md +++ b/Writing-the-handlers.md @@ -7,6 +7,7 @@ Now you have to implement each handler. You need to inherit from WSF_SKELETON_HA ### is_chunking HTTP/1.1 supports streaming responses (and providing you have configured your server to use a proxy server in WSF_PROXY_USE_POLICY, this framework guarantees you have an HTTP/1.1 client to deal with). It is up to you whether or not you choose to make use of it. If so, then you have to serve the response one chunk at a time (but you could generate it all at once, and slice it up as you go). In this routine you just say whether or not you will be doing this. So the framework n=knows which other routines to call. +Currently we only support chunking for GET or HEAD routines. This might change in the future, so if you intend to return True, you should call req.is_get_head_request_method. ### includes_response_entity @@ -59,6 +60,33 @@ You need to implement this. If you do not have information about when a resource This routine when a PUT request is made to a resource that does not exist. See [PUT](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.6) in the HTTP/1.1 specification for why you might want to return zero. +## allow_post_to_missing_resource + +POST requests are normally made to an existing entity. However it is possible to create new resources using a POST, if the server allows it. This is where you make that decision. + +If you return True, and the resource is created, a 201 Created response will be returned. + +## content_length + +If you are not streaming the result, the the HTTP protocol requires that the length of the entity is known. You need to implement this routine to provide that information. + +## finished + +If you are streaming the response, then you need to tell the framework when the last chunk has been sent. +To implement this routine, you will probably need to call req.set_execution_variable (some-name, True) in ensure_content_avaiable and generate_next_chunk, and call attached {BOOLEAN} req.execution_variable (some-name) in this routine. + +## description + +This is for the automatically generated documentation that the framework will generate in response to a request that you have not mapped into an handler. + +## delete + +This routine is for carrying out a DELETE request to a resource. If it is valid to delete the named resource, then you should either go ahead and do it, or queue a deletion request somewhere (if you do that then you will probably need to call req.set_execution_variable (some-name-or-other, True). Otherwise you should call req.error_handler.add_custom_error to explain why the DELETE could not proceed (you should also do this if the attempt to delete the resource fails). +Of course, if you have not mapped any DELETE requests to the URI space of this handler, then you can just do nothing. + +## delete_queued + +If in the delete routine, you elected to queue the request, then you need to return True here. You will probably need to check the execution variable you set in the delete routine. ## Implementing the policies * [WSF_OPTIONS_POLICY](./WSF_OPTIONS_POLICY)