Module SocketServer :: Class TCPServer

[frames] | no frames]

Class TCPServer

BaseServer --+
             |
            TCPServer

Known Subclasses:

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

Instance Methods

__init__(self, server_address, RequestHandlerClass)
Constructor.

server_bind(self)
Called by constructor to bind the socket.

server_activate(self)
Called by constructor to activate the server.

server_close(self)
Called to clean-up the server.

fileno(self)
Return socket file number.

get_request(self)
Get the request and client address from the socket.

close_request(self, request)
Called to clean up an individual request.

Inherited from BaseServer: finish_request, handle_error, handle_request, process_request, serve_forever, verify_request

Class Variables

address_family = 2

socket_type = 1

request_queue_size = 5

allow_reuse_address = False

Method Details

init(self, server_address, RequestHandlerClass)
(Constructor)

Constructor. May be extended, do not override.

Overrides: BaseServer.__init__

server_bind(self)

Called by constructor to bind the socket.

May be overridden.

server_activate(self)

Called by constructor to activate the server.

May be overridden.

Overrides: BaseServer.server_activate

server_close(self)

Called to clean-up the server.

May be overridden.

Overrides: BaseServer.server_close

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.

close_request(self, request)

Called to clean up an individual request.

Overrides: BaseServer.close_request