Package twisted :: Package internet :: Module tcp :: Class Port
[show private | hide private]
[frames | no frames]

Class Port

    Logger --+    
             |    
FileDescriptor --+
                 |
                Port

Known Subclasses:
Port

I am a TCP server port, listening for connections.

When a connection is accepted, I will call my factory's buildProtocol with the incoming connection as an argument, according to the specification described in twisted.protocols.protocol.Factory.

If you wish to change the sort of transport that will be used, my `transport' attribute will be called with the signature expected for Server.__init__, so it can be replaced.
Method Summary
  __init__(self, port, factory, backlog, interface, reactor)
Initialize with a numeric port to listen on.
  __getstate__(self)
(internal) get my state for persistence
  __repr__(self)
  connectionLost(self, reason)
Cleans up my socket.
  createInternetSocket(self)
(internal) create an AF_INET socket.
  doRead(self)
Called when my socket is ready for reading.
  doWrite(self)
Raises an AssertionError.
  fileno(self)
File Descriptor number for select(). (inherited from FileDescriptor)
  getHost(self)
Returns a tuple of ('INET', hostname, port).
  log(self, bytes)
(inherited from Logger)
  logPrefix(self)
Returns the name of my class, to prefix log entries with.
  loseConnection(self)
Stop accepting connections on this port.
  pauseProducing(self)
(inherited from FileDescriptor)
  registerProducer(self, producer, streaming)
Register to receive data from a producer. (inherited from FileDescriptor)
  resumeProducing(self)
(inherited from FileDescriptor)
  startListening(self)
Create and bind my socket, and begin listening on it.
  startReading(self)
Start waiting for read availability. (inherited from FileDescriptor)
  startWriting(self)
Start waiting for write availability. (inherited from FileDescriptor)
  stopConsuming(self)
Stop consuming data. (inherited from FileDescriptor)
  stopListening(self)
Stop accepting connections on this port.
  stopProducing(self)
(inherited from FileDescriptor)
  stopReading(self)
Stop waiting for read availability. (inherited from FileDescriptor)
  stopWriting(self)
Stop waiting for write availability. (inherited from FileDescriptor)
  unregisterProducer(self)
Stop consuming data from a producer, without disconnecting. (inherited from FileDescriptor)
  write(self, data)
Reliably write some data. (inherited from FileDescriptor)
  writeSequence(self, iovec)
(inherited from FileDescriptor)
  writeSomeData(self, data)
Write as much as possible of the given data, immediately. (inherited from FileDescriptor)
  _Logger__prefix(self)
(inherited from Logger)
  _postLoseConnection(self)
Called after a loseConnection(), when all data has been written. (inherited from FileDescriptor)

Class Variable Summary
int backlog
str interface
class Server
int sessionno
NoneType unixsocket

Method Details

__init__(self, port, factory, backlog=5, interface='', reactor=None)
(Constructor)

Initialize with a numeric port to listen on.
Overrides:
twisted.internet.abstract.FileDescriptor.__init__

__getstate__(self)

(internal) get my state for persistence

connectionLost(self, reason)

Cleans up my socket.
Overrides:
twisted.internet.abstract.FileDescriptor.connectionLost

createInternetSocket(self)

(internal) create an AF_INET socket.

doRead(self)

Called when my socket is ready for reading.

This accepts a connection and calls self.protocol() to handle the wire-level protocol.

doWrite(self)

Raises an AssertionError.
Overrides:
twisted.internet.abstract.FileDescriptor.doWrite

getHost(self)

Returns a tuple of ('INET', hostname, port).

This indicates the servers address.

logPrefix(self)

Returns the name of my class, to prefix log entries with.
Overrides:
twisted.python.log.Logger.logPrefix

loseConnection(self)

Stop accepting connections on this port.

This will shut down my socket and call self.connectionLost().
Overrides:
twisted.internet.abstract.FileDescriptor.loseConnection

startListening(self)

Create and bind my socket, and begin listening on it.

This is called on unserialization, and must be called after creating a server to begin listening on the specified port.

stopListening(self)

Stop accepting connections on this port.

This will shut down my socket and call self.connectionLost().
Overrides:
twisted.internet.abstract.FileDescriptor.loseConnection

Class Variable Details

backlog

Type:
int
Value:
5                                                                      

interface

Type:
str
Value:
''                                                                     

Server

Server = twisted.internet.tcp.Server

sessionno

Type:
int
Value:
0                                                                      

unixsocket

Type:
NoneType
Value:
None                                                                   

Generated by Epydoc 1.2 prerelease on Wed Jan 29 06:28:15 2003 http://epydoc.sf.net