Feb 2024 - This site, and Kamaelia are being updated. There is significant work needed, and PRs are welcome.

Kamaelia.Protocol.HTTP.HTTPParser

HTTP Parser {#588}

This component is for transforming HTTP requests or responses into multiple easy-to-use dictionary objects.

Unless you are implementing a new HTTP component you should not use this component directly. Either SimpleHTTPClient, HTTPServer (in conjuncton with SimpleServer) or SingleShotHTTPClient will likely serve your needs.

If you want to use it directly, note that it doesn't output strings but ParsedHTTPHeader, ParsedHTTPBodyChunk and ParsedHTTPEnd objects.

Example Usage {#589}

If you want to play around with parsing HTTP responses: (like a client):

pipeline(
    ConsoleReader(),
    HTTPParser(mode="response"),
    ConsoleEchoer()
).run()

If you want to play around with parsing HTTP requests: (like a server):

pipeline(
    ConsoleReader(),
    HTTPParser(mode="response"),
    ConsoleEchoer()
).run()

Kamaelia.Protocol.HTTP.HTTPParser.HTTPParser

class HTTPParser(Axon.Component.component)

Component that transforms HTTP requests or responses from a single TCP connection into multiple easy-to-use dictionary objects.

Inboxes

  • control : UNUSED
  • inbox : Raw HTTP requests/responses

Outboxes

  • debug : Debugging information
  • outbox : HTTP request object
  • signal : UNUSED

Methods defined here

Warning!

You should be using the inbox/outbox interface, not these methods (except construction). This documentation is designed as a roadmap as to their functionalilty for maintainers and new component developers.

__init__(self, mode, **argd)

closeConnection(self)

dataFetch(self)

Read once from inbox (generally a TCP connection) and add what is received to the readbuffer. This is somewhat inefficient for long lines maybe O(n^2)

debug(self, msg)

getBody(self, requestobject)

getBodyDependingOnHalfClose(self)

getBody_ChunkTransferEncoding(self, requestobject)

getBody_KnownContentLength(self, requestobject)

getHeaders(self, requestobject)

getInitialLine(self)

handleInitialLine(self, requestobject)

handle_requestline(self, splitline, requestobject)

initialiseRequestObject(self)

main(self)

nextLine(self)

Fetch the next complete line in the readbuffer, if there is one

setConnectionMode(self, requestobject)

setServer(self, requestobject)

shouldShutdown(self)

splitProtocolVersion(self, protvers, requestobject)

Feedback

Got a problem with the documentation? Something unclear that could be clearer? Want to help improve it? Constructive criticism is very welcome - especially if you can suggest a better rewording!

Please leave you feedback here in reply to the documentation thread in the Kamaelia blog.

-- Automatic documentation generator, 05 Jun 2009 at 03:01:38 UTC/GMT