twisted.internet.tcp.Port(base.BasePort, _SocketCloser)class documentation
twisted.internet.tcpView Source (View In Hierarchy)
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
If you wish to change the sort of transport that will be used, the
transport attribute will be called with the signature expected
Server.__init__, so it can be replaced.
|Instance Variable||deferred||a deferred created when
|Instance Variable||disconnecting||flag indicating that the
|Instance Variable||connected||flag set once the listen has successfully been called on the socket. (type:
|Method||__init__||Initialize with a numeric port to listen on.|
|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.|
|Instance Variable||_type||A string describing the connections which will be created by this port.
Normally this is
|Instance Variable||_preexistingSocket||If not
|Class Method||_fromListeningDescriptor||Create a new
|Method||_logConnectionLostMsg||Log message for closing port|
Inherited from BasePort:
|Method||doWrite||Raises a RuntimeError|
|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||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||_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.|
|Instance Variable||producerPaused||A flag indicating whether the producer is currently paused. (type:
|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
|Method||registerProducer||Register to receive data from a producer.|
|Method||unregisterProducer||Stop consuming data from a producer, without disconnecting.|
|Method||_getLogPrefix||Determine the log prefix to use for messages related to
Inherited from _SocketCloser:
|Instance Variable||_shouldShutdown||Set to
stopListeningmethod has been called and that no connections should be accepted anymore. (type:
"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.
Create a new
Port based on an
existing listening SOCK_STREAM socket.
Arguments are the same as to
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.|
|addressFamily||The address family (sometimes called domain) of the existing socket.
For example, |
|Returns||A new instance of |
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.
Log message for closing port
Cleans up the socket.