hio.core.http.serving

hio.core.http.serving classes

nonblocking http server

Module Contents

Classes

Requestant	Nonblocking HTTP Server Requestant class
Responder	Nonblocking HTTP WSGI Responder class
Server	Server WSGI HTTP Server Class
CustomResponder	Nonblocking HTTP Server Response class for non-wsgi applications
Steward	Manages the associated requestant and responder for an incoming connection
BareServer	BareServer class nonblocking Bare (non-WSGI) HTTP server
StaticSink	Class that provides Falcon sink endpoint for serving static files in support
ServerDoer	HTTP WSGI Server Doer

Functions

openServer(cls=None, **kwa)

Wrapper to create and open HTTP Server instances

Attributes

logger
CRLF
LF
CR
WsgiServer

hio.core.http.serving.logger

hio.core.http.serving.CRLF = b'\r\n'

hio.core.http.serving.LF = b'\n'

hio.core.http.serving.CR = b'\r'

class hio.core.http.serving.Requestant(remoter=None, **kwa)

Bases: hio.core.http.httping.Parsent

Nonblocking HTTP Server Requestant class Parses request msg

checkPersisted(self)

Checks headers to determine if connection should be kept open until client closes it Sets the .persisted flag

parseHead(self)

Generator to parse headers in heading of .msg Yields None if more to parse Yields True if done parsing

parseBody(self)

Parse body

class hio.core.http.serving.Responder(incomer, app, environ, chunkable=False, delay=None)

Nonblocking HTTP WSGI Responder class

HttpVersionString

Delay = 1.0

close(self)

Close any resources

reset(self, environ, chunkable=None)

Reset attributes for another request-response

build(self)

Return built head bytes from .status and .headers

write(self, msg)

WSGI write callback This writes out the headers the first time its called otherwise writes the msg bytes

start(self, status, response_headers, exc_info=None)

WSGI application start_response callable

Parameters:

status is string of status code and status reason ‘200 OK’ or simple

status code int which will be replaced with string

response_headers is list of tuples of strings of the form (field, value)

one tuple for each header example: [

(‘Content-type’, ‘text/plain’), (‘X-Some-Header’, ‘value’)

]

exc_info is optional exception info if exception occurred while

processing request in wsgi application If exc_info is supplied, and no HTTP headers have been output yet, start_response should replace the currently-stored HTTP response headers with the newly-supplied ones, thus allowing the application to “change its mind” about the output when an error has occurred.

However, if exc_info is provided, and the HTTP headers have already been sent, start_response must raise an error, and should re-raise using the exc_info tuple. That is:

raise exc_info[1].with_traceback(exc_info[2]) (python3)

Nonstandard modifiction to allow for iterable/generator of body to change

headers and status before first write to support async processing of responses whose iterator/generator yields empty before first non-empty yield. In .service yielding empty does not cause write so status line and headers are not sent until first non-empty write.

The mode is that the app.headers and app.status are consulted to see if changed from when .start = wsgi start_response was first called.

service(self)

Service wsgi compatible application

hio.core.http.serving.openServer(cls=None, **kwa)

Wrapper to create and open HTTP Server instances When used in with statement block, calls .close() on exit of with block

Parameters

instance (cls is Class instance of subclass) –

Usage:

with openServer() as server0:

server0.

with openServer(cls=BareServer) as server0:

server0.

class hio.core.http.serving.Server(name='hio.wsgi.server', app=None, reqs=None, reps=None, servant=None, bufsize=8096, wl=None, ha=None, host='', port=None, eha=None, scheme='', tymeout=None, **kwa)

Server WSGI HTTP Server Class

Tymeout = 5.0

wind(self, tymth)

Inject new tymist.tymth as new ._tymth. Changes tymist.tyme base. Updates winds .tymer .tymth

reopen(self)

Return result of .servant.reopen()

close(self)

Close all reqs, reps, and ixes

idle(self)

Returns True if no connections have requests in process Useful for debugging

buildEnviron(self, requestant)

Returns wisgi environment dictionary for supplied requestant

closeConnection(self, ca)

Close and remove connection given by ca

serviceConnects(self)

Service new incoming connections Create requestants Timeout stale connections

serviceReqs(self)

Service pending requestants

serviceReps(self)

Service pending responders

service(self)

Service request response

hio.core.http.serving.WsgiServer

class hio.core.http.serving.CustomResponder(steward=None, status=200, headers=None, body=b'', data=None)

Nonblocking HTTP Server Response class for non-wsgi applications Used by Steward

HTTP/1.1 200 OK

Content-Length: 122

Content-Type: application/json

Date: Thu, 30 Apr 2015 19:37:17 GMT

Server: IoBook.local

HttpVersionString

reinit(self, status=None, headers=None, body=None, data=None)

Reinitialize anything that is not None This enables creating another response on a connection

build(self, status=None, headers=None, body=None, data=None)

Build and return response message

class hio.core.http.serving.Steward(remoter, requestant=None, responder=None, dictable=False)

Manages the associated requestant and responder for an incoming connection for BareServer (non-wsgi) HTTP server

refresh(self)

Restart incomer tymer

respond(self)

Respond to request Override in subclass Echo request

pour(self)

Run generator to stream response message

class hio.core.http.serving.BareServer(servant=None, stewards=None, name='', bufsize=8096, wl=None, ha=None, host='', port=None, eha=None, scheme='', dictable=False, timeout=None, **kwa)

BareServer class nonblocking Bare (non-WSGI) HTTP server Define CustomResponder subclass to respond to requests as per Steward

Timeout = 5.0

reopen(self)

Return result of .servant.reopen()

idle(self)

Returns True if no connections have requests in process Useful for debugging

close(self)

Close all ixes for all stewards

closeConnection(self, ca)

Close and remove connection and associated steward given by ca

serviceConnects(self)

Service new incoming connections Create requestants Timeout stale connections

serviceStewards(self)

Service pending requestants and responders

service(self)

Service request response

class hio.core.http.serving.StaticSink(staticDirPath=None)

Class that provides Falcon sink endpoint for serving static files in support of a client side web app.

StaticSinkBasePath = /static

DefaultStaticSinkBasePath = /

__call__(self, req, rep)

class hio.core.http.serving.ServerDoer(server, **kwa)

Bases: hio.base.doing.Doer

HTTP WSGI Server Doer

See Doer for inherited attributes, properties, and methods.

.server is HTTP WSGI Server instance

Properties:

wind(self, tymth)

Inject new tymist.tymth as new ._tymth. Changes tymist.tyme base. Updates winds .tymer .tymth

enter(self)

recur(self, tyme)

exit(self)