Vega strike Python Modules doc  0.5.1
Documentation of the " Modules " folder of Vega strike
 All Data Structures Namespaces Files Functions Variables
TCPServer Class Reference
Inheritance diagram for TCPServer:
BaseServer HTTPServer SimpleXMLRPCServer ForkingTCPServer ThreadingTCPServer UDPServer UnixStreamServer ForkingUDPServer ThreadingUDPServer UnixDatagramServer ThreadingUnixStreamServer ThreadingUnixDatagramServer

Public Member Functions

def __init__
 
def server_bind
 
def server_activate
 
def server_close
 
def fileno
 
def get_request
 
def close_request
 
- Public Member Functions inherited from BaseServer
def __init__
 
def server_activate
 
def serve_forever
 
def handle_request
 
def verify_request
 
def process_request
 
def server_close
 
def finish_request
 
def close_request
 
def handle_error
 

Data Fields

 socket
 
- Data Fields inherited from BaseServer
 server_address
 
 RequestHandlerClass
 

Static Public Attributes

 address_family = socket.AF_INET
 
 socket_type = socket.SOCK_STREAM
 
int request_queue_size = 5
 
int allow_reuse_address = 0
 

Detailed Description

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)
- reuse_address

Instance variables:

- server_address
- RequestHandlerClass
- socket

Definition at line 273 of file SocketServer.py.

Constructor & Destructor Documentation

def __init__ (   self,
  server_address,
  RequestHandlerClass 
)
Constructor.  May be extended, do not override.

Definition at line 324 of file SocketServer.py.

325  def __init__(self, server_address, RequestHandlerClass):
326  """Constructor. May be extended, do not override."""
327  BaseServer.__init__(self, server_address, RequestHandlerClass)
328  self.socket = socket.socket(self.address_family,
329  self.socket_type)
330  self.server_bind()
331  self.server_activate()

Member Function Documentation

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

Definition at line 374 of file SocketServer.py.

375  def close_request(self, request):
376  """Called to clean up an individual request."""
377  request.close()
378 
def fileno (   self)
Return socket file number.

Interface required by select().

Definition at line 358 of file SocketServer.py.

359  def fileno(self):
360  """Return socket file number.
361 
362  Interface required by select().
363 
364  """
365  return self.socket.fileno()
def get_request (   self)
Get the request and client address from the socket.

May be overridden.

Definition at line 366 of file SocketServer.py.

367  def get_request(self):
368  """Get the request and client address from the socket.
369 
370  May be overridden.
371 
372  """
373  return self.socket.accept()
def server_activate (   self)
Called by constructor to activate the server.

May be overridden.

Definition at line 342 of file SocketServer.py.

References TCPServer.request_queue_size.

343  def server_activate(self):
344  """Called by constructor to activate the server.
345 
346  May be overridden.
347 
348  """
349  self.socket.listen(self.request_queue_size)
def server_bind (   self)
Called by constructor to bind the socket.

May be overridden.

Definition at line 332 of file SocketServer.py.

References HTTPServer.allow_reuse_address, TCPServer.allow_reuse_address, and BaseServer.server_address.

333  def server_bind(self):
334  """Called by constructor to bind the socket.
335 
336  May be overridden.
337 
338  """
339  if self.allow_reuse_address:
340  self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
341  self.socket.bind(self.server_address)
def server_close (   self)
Called to clean-up the server.

May be overridden.

Definition at line 350 of file SocketServer.py.

351  def server_close(self):
352  """Called to clean-up the server.
353 
354  May be overridden.
355 
356  """
357  self.socket.close()

Field Documentation

address_family = socket.AF_INET
static

Definition at line 316 of file SocketServer.py.

int allow_reuse_address = 0
static

Definition at line 322 of file SocketServer.py.

int request_queue_size = 5
static

Definition at line 320 of file SocketServer.py.

socket

Definition at line 327 of file SocketServer.py.

socket_type = socket.SOCK_STREAM
static

Definition at line 318 of file SocketServer.py.


The documentation for this class was generated from the following file: