twisted.internet.unix.Port : API documentation

Method	__init__	Initialize with a numeric port to listen on.
Method	__repr__	Undocumented
Method	startListening	Create and bind my socket, and begin listening on it.
Method	connectionLost	Cleans up the socket.
Class Method	_fromListeningDescriptor	Create a new `Port` based on an existing listening SOCK_STREAM socket.
Method	_buildAddr	Undocumented
Method	_logConnectionLostMsg	Log message for closing socket

Inherited from _UNIXPort:

Method

getHost

Returns a UNIXAddress.

Inherited from Port:

Instance Variable	deferred	a 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`)
Instance Variable	disconnecting	flag indicating that the `stopListening` method has been called and that no connections should be accepted anymore. (type: `bool`)
Instance Variable	connected	flag set once the listen has successfully been called on the socket. (type: `bool`)
Method	createInternetSocket	Undocumented
Method	doRead	Called when my socket is ready for reading.
Method	loseConnection	Stop accepting connections on this port.
Method	logPrefix	Returns the name of my class, to prefix log entries with.
Method	getHost	Return an `IPv4Address` or `IPv6Address` indicating the listening address of this port.
Instance Variable	_type	A string describing the connections which will be created by this port. Normally this is `"TCP"`, since this is a TCP port, but when the TLS implementation re-uses this class it overrides the value with `"TLS"`. Only used for logging.
Instance Variable	_preexistingSocket	If not `None`, a `socket.socket` instance which was created and initialized outside of the reactor and will be used to listen for connections (instead of a new socket being created by this `Port`).

Inherited from BasePort (via Port):

Method

doWrite

Raises a RuntimeError

Inherited from FileDescriptor (via Port, 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	Resume producing data.
Method	pauseProducing	Pause producing data.
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
Method	_isSendBufferFull	Determine whether the user-space send buffer for this transport is full or not.
Method	_maybePauseProducer	Possibly pause a producer, if there is one and the send buffer is full.

Inherited from _ConsumerMixin (via Port, BasePort, FileDescriptor):

Instance Variable	producer	`None` if no producer is registered, otherwise the registered producer.
Instance Variable	producerPaused	A flag indicating whether the producer is currently paused. (type: `bool`)
Instance Variable	streamingProducer 0	A flag indicating whether the producer was registered as a streaming (ie push) producer or not (ie a pull producer). This will determine whether the consumer may ever need to pause and resume it, or if it can merely call `resumeProducing` on it when buffer space is available.
Instance Variable	streamingProducer	`bool` or `int`
Method	registerProducer	Register to receive data from a producer.
Method	unregisterProducer	Stop consuming data from a producer, without disconnecting.

Inherited from _LogOwner (via Port, BasePort, FileDescriptor):

Method _getLogPrefix Determine the log prefix to use for messages related to applicationObject, which may or may not be an interfaces.ILoggingContext provider.

Inherited from _SocketCloser (via Port):

Instance Variable	_shouldShutdown	Set to `True` if `shutdown` should be called before calling `close` on the underlying socket. (type: `bool`)
Method	_closeSocket	Undocumented

def __init__(self, fileName, factory, backlog=50, mode=438, reactor=None, wantPID=0): (source)

overrides twisted.internet.tcp.Port.__init__

Initialize with a numeric port to listen on.

@classmethod
def _fromListeningDescriptor(cls, reactor, fd, factory): (source)

overrides twisted.internet.tcp.Port._fromListeningDescriptor

Create a new Port based on an existing listening SOCK_STREAM socket.

Arguments are the same as to Port.__init__, except where noted.

Parameters	fd	An integer file descriptor associated with a listening socket. The socket must be in non-blocking mode. Any additional attributes desired, such as FD_CLOEXEC, must also be set already.
Returns	A new instance of `cls` wrapping the socket given by `fd`.

def __repr__(self): (source)

overrides twisted.internet.tcp.Port.__repr__

Undocumented

def _buildAddr(self, name): (source)

overrides twisted.internet.tcp.Port._buildAddr

Undocumented

def startListening(self): (source)

from twisted.internet.interfaces.IListeningPort

overrides twisted.internet.tcp.Port.startListening

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 _logConnectionLostMsg(self): (source)