t.i.t.Port(base.BasePort, _SocketCloser) : class documentation

Part of twisted.internet.tcp View Source View In Hierarchy

Known subclasses: twisted.internet.ssl.Port, twisted.internet.unix.Port

Implements interfaces: twisted.internet.interfaces.IListeningPort

A TCP server port, listening for connections.

When a connection is accepted, this will call a factory's buildProtocol with the incoming address as an argument, according to the specification described in twisted.internet.interfaces.IProtocolFactory.

If you wish to change the sort of transport that will be used, the transport attribute will be called with the signature expected for Server.__init__, so it can be replaced.
Instance Variablesdeferreda deferred created when stopListening is called, and that will fire when connection is lost. This is not to be used it directly: prefer the deferred returned by stopListening instead. (type: defer.Deferred )
disconnectingflag indicating that the stopListening method has been called and that no connections should be accepted anymore. (type: bool )
connectedflag set once the listen has successfully been called on the socket. (type: bool )
Method __init__ Initialize with a numeric port to listen on.
Method __repr__ Undocumented
Method createInternetSocket Undocumented
Method startListening Create and bind my socket, and begin listening on it.
Method doRead Called when my socket is ready for reading.
Method loseConnection Stop accepting connections on this port.
Method connectionLost Cleans up the socket.
Method logPrefix Returns the name of my class, to prefix log entries with.
Method getHost Returns an IPv4Address.
Method _buildAddr Undocumented
Method _logConnectionLostMsg Log message for closing port

Inherited from BasePort:

Method doWrite Raises a RuntimeError

Inherited from FileDescriptor (via BasePort):

Method writeSomeData Write as much as possible of the given data, immediately.
Method writeConnectionLost Indicates write connection was lost.
Method readConnectionLost Indicates read connection was lost.
Method write Reliably write some data.
Method writeSequence Reliably write a sequence of data.
Method loseWriteConnection Undocumented
Method stopReading Stop waiting for read availability.
Method stopWriting Stop waiting for write availability.
Method startReading Start waiting for read availability.
Method startWriting Start waiting for write availability.
Method stopConsuming Stop consuming data.
Method resumeProducing Undocumented
Method pauseProducing Undocumented
Method stopProducing Stop producing data.
Method fileno File Descriptor number for select().
Method _postLoseConnection Called after a loseConnection(), when all data has been written.
Method _closeWriteConnection Undocumented

Inherited from _ConsumerMixin (via BasePort, FileDescriptor):

Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.

Inherited from _SocketCloser:

Method _closeSocket Undocumented
def __init__(self, port, factory, backlog=50, interface='', reactor=None): (source)
Initialize with a numeric port to listen on.
def __repr__(self): (source)
Undocumented
def createInternetSocket(self): (source)
Undocumented
def startListening(self): (source)

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.
def _buildAddr(self, (host, port)): (source)
Undocumented
def doRead(self): (source)

Called when my socket is ready for reading.

This accepts a connection and calls self.protocol() to handle the wire-level protocol.
def loseConnection(self, connDone=failure.Failure(main.CONNECTION_DONE)): (source)

Stop accepting connections on this port.

This will shut down the socket and call self.connectionLost(). It returns a deferred which will fire successfully when the port is actually closed, or with a failure if an error occurs shutting down.
def _logConnectionLostMsg(self): (source)
Log message for closing port
def connectionLost(self, reason): (source)
Cleans up the socket.
def logPrefix(self): (source)
Returns the name of my class, to prefix log entries with.
def getHost(self): (source)

Returns an IPv4Address.

This indicates the server's address.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:27:37.