SocketServer.TCPServer

Module SocketServer :: Class TCPServer

[show private | hide private]

Class TCPServer

BaseServer --+
             |
            TCPServer

Known Subclasses:: HTTPServer

Base class for various socket-based server classes.

Defaults to synchronous IP stream (i.e., TCP).

Methods for the caller:

- __init__(server_address, RequestHandlerClass)
- serve_forever()
- handle_request()  # if you don't use serve_forever()
- fileno() -> int   # for select()

Methods that may be overridden:

- server_bind()
- server_activate()
- get_request() -> request, client_address
- verify_request(request, client_address)
- process_request(request, client_address)
- close_request(request)
- handle_error()

Methods for derived classes:

- finish_request(request, client_address)

Class variables that may be overridden by derived classes or
instances:

- address_family
- socket_type
- request_queue_size (only for stream sockets)
- allow_reuse_address

Instance variables:

- server_address
- RequestHandlerClass
- socket

Method Summary
	`__init__(self, server_address, RequestHandlerClass)` Constructor.
	`close_request(self, request)` Called to clean up an individual request.
	`fileno(self)` Return socket file number.
	`get_request(self)` Get the request and client address from the socket.
	`server_activate(self)` Called by constructor to activate the server.
	`server_bind(self)` Called by constructor to bind the socket.
	`server_close(self)` Called to clean-up the server.
Inherited from BaseServer
	`finish_request(self, request, client_address)` Finish one request by instantiating RequestHandlerClass.
	`handle_error(self, request, client_address)` Handle an error gracefully.
	`handle_request(self)` Handle one request, possibly blocking.
	`process_request(self, request, client_address)` Call finish_request.
	`serve_forever(self)` Handle one request at a time until doomsday.
	`verify_request(self, request, client_address)` Verify the request.

Class Variable Summary
`int`	`address_family` = 2
`bool`	`allow_reuse_address` = `False`
`int`	`request_queue_size` = 5
`int`	`socket_type` = 1

Method Details

init(self, server_address, RequestHandlerClass)
(Constructor)

Constructor. May be extended, do not override.

Overrides:: SocketServer.BaseServer.__init__

close_request(self, request)

Called to clean up an individual request.

Overrides:: SocketServer.BaseServer.close_request

fileno(self)

Return socket file number.

Interface required by select().

get_request(self)

Get the request and client address from the socket.

May be overridden.

server_activate(self)

Called by constructor to activate the server.

May be overridden.

Overrides:: SocketServer.BaseServer.server_activate

server_bind(self)

Called by constructor to bind the socket.

May be overridden.

server_close(self)

Called to clean-up the server.

May be overridden.

Overrides:: SocketServer.BaseServer.server_close

Class Variable Details

address_family

Type:: int
Value:: 2

allow_reuse_address

Type:: bool
Value:: False

request_queue_size

Type:: int
Value:: 5

socket_type

Type:: int
Value:: 1

Generated by Epydoc 2.1 on Fri Jul 27 17:40:03 2007

http://epydoc.sf.net

Class TCPServer

__init__(self, server_address, RequestHandlerClass) (Constructor)

close_request(self, request)

fileno(self)

get_request(self)

server_activate(self)

server_bind(self)

server_close(self)

address_family

allow_reuse_address

request_queue_size

socket_type

init(self, server_address, RequestHandlerClass)
(Constructor)