tornado.httpserver
— Non-blocking HTTP server¶
A non-blocking, single-threaded HTTP server.
Typical applications have little direct interaction with the HTTPServer
class except to start a server at the beginning of the process
(and even that is often done indirectly via tornado.web.Application.listen
).
Changed in version 4.0: The HTTPRequest
class that used to live in this module has been moved
to tornado.httputil.HTTPServerRequest
. The old name remains as an alias.
HTTP Server¶
-
class
tornado.httpserver.
HTTPServer
(request_callback, no_keep_alive=False, io_loop=None, xheaders=False, ssl_options=None, protocol=None, decompress_request=False, chunk_size=None, max_header_size=None, idle_connection_timeout=None, body_timeout=None, max_body_size=None, max_buffer_size=None)[source]¶ A non-blocking, single-threaded HTTP server.
A server is defined by a subclass of
HTTPServerConnectionDelegate
, or, for backwards compatibility, a callback that takes anHTTPServerRequest
as an argument. The delegate is usually atornado.web.Application
.HTTPServer
supports keep-alive connections by default (automatically for HTTP/1.1, or for HTTP/1.0 when the client requestsConnection: keep-alive
).If
xheaders
isTrue
, we support theX-Real-Ip
/X-Forwarded-For
andX-Scheme
/X-Forwarded-Proto
headers, which override the remote IP and URI scheme/protocol for all requests. These headers are useful when running Tornado behind a reverse proxy or load balancer. Theprotocol
argument can also be set tohttps
if Tornado is run behind an SSL-decoding proxy that does not set one of the supportedxheaders
.To make this server serve SSL traffic, send the
ssl_options
dictionary argument with the arguments required for thessl.wrap_socket
method, includingcertfile
andkeyfile
. (In Python 3.2+ you can pass anssl.SSLContext
object instead of a dict):HTTPServer(applicaton, ssl_options={ "certfile": os.path.join(data_dir, "mydomain.crt"), "keyfile": os.path.join(data_dir, "mydomain.key"), })
HTTPServer
initialization follows one of three patterns (the initialization methods are defined ontornado.tcpserver.TCPServer
):listen
: simple single-process:server = HTTPServer(app) server.listen(8888) IOLoop.instance().start()
In many cases,
tornado.web.Application.listen
can be used to avoid the need to explicitly create theHTTPServer
.bind
/start
: simple multi-process:server = HTTPServer(app) server.bind(8888) server.start(0) # Forks multiple sub-processes IOLoop.instance().start()
When using this interface, an
IOLoop
must not be passed to theHTTPServer
constructor.start
will always start the server on the default singletonIOLoop
.add_sockets
: advanced multi-process:sockets = tornado.netutil.bind_sockets(8888) tornado.process.fork_processes(0) server = HTTPServer(app) server.add_sockets(sockets) IOLoop.instance().start()
The
add_sockets
interface is more complicated, but it can be used withtornado.process.fork_processes
to give you more flexibility in when the fork happens.add_sockets
can also be used in single-process servers if you want to create your listening sockets in some way other thantornado.netutil.bind_sockets
.
Changed in version 4.0: Added
decompress_request
,chunk_size
,max_header_size
,idle_connection_timeout
,body_timeout
,max_body_size
arguments. Added support forHTTPServerConnectionDelegate
instances asrequest_callback
.Changed in version 4.1:
HTTPServerConnectionDelegate.start_request
is now called with two arguments(server_conn, request_conn)
(in accordance with the documentation) instead of one(request_conn)
.