twisted.internet.tcp.Server(_TLSServerMixin, Connection) class documentation

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

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

Serverside socket-stream connection class.

This is a serverside network connection transport; a socket which came from an accept() on a server.

Method __init__ Server(sock, protocol, client, server, sessionno)
Method __repr__ A string representation of this connection.
Method getHost Returns an IPv4Address or IPv6Address.
Method getPeer Returns an IPv4Address or IPv6Address.
Instance Variable _base Connection, which is the base class of this class which has all of the useful file descriptor methods. This is used by _TLSServerMixin to call the right methods to directly manipulate the transport, as is necessary for writing TLS-encrypted bytes (whereas those methods on Server will go through another layer of TLS if it has been enabled).
Class Method _fromConnectedSocket Create a new Server based on an existing connected SOCK_STREAM socket.

Inherited from Connection:

Instance Variable logstr prefix used when logging events related to this connection. (type: str)
Method getHandle Return the socket for this connection.
Method doRead Calls self.protocol.dataReceived with all available data.
Method writeSomeData Write as much as possible of the given data to this TCP connection.
Method readConnectionLost Indicates read connection was lost.
Method connectionLost See abstract.FileDescriptor.connectionLost().
Method logPrefix Return the prefix to log with when I own the logging thread.
Method getTcpNoDelay Return if TCP_NODELAY is enabled.
Method setTcpNoDelay Enable/disable TCP_NODELAY.
Method getTcpKeepAlive Return if SO_KEEPALIVE is enabled.
Method setTcpKeepAlive Enable/disable SO_KEEPALIVE.
Method _dataReceived Undocumented
Method _closeWriteConnection Undocumented

Inherited from FileDescriptor (via Connection):

Method doWrite Called when data can be written.
Method writeConnectionLost Indicates write connection was lost.
Method write Reliably write some data.
Method writeSequence Reliably write a sequence of data.
Method loseConnection Close the connection at the next available opportunity.
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 _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 Connection, 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 Connection, 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 Connection):

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

Inherited from _AbortingMixin (via Connection):

Method abortConnection Aborts the connection immediately, dropping any buffered data.
Instance Variable _aborting Set to True when abortConnection is called. (type: bool)
_base =
Connection, which is the base class of this class which has all of the useful file descriptor methods. This is used by _TLSServerMixin to call the right methods to directly manipulate the transport, as is necessary for writing TLS-encrypted bytes (whereas those methods on Server will go through another layer of TLS if it has been enabled).
def __init__(self, sock, protocol, client, server, sessionno, reactor): (source)
overrides twisted.internet.tcp.Connection.__init__
overridden in twisted.internet.ssl.Server, twisted.internet.unix.Server

Server(sock, protocol, client, server, sessionno)

Initialize it with a socket, a protocol, a descriptor for my peer (a tuple of host, port describing the other end of the connection), an instance of Port, and a session number.

def __repr__(self): (source)

A string representation of this connection.

@classmethod
def _fromConnectedSocket(cls, fileDescriptor, addressFamily, factory, reactor): (source)
overridden in twisted.internet.unix.Server

Create a new Server based on an existing connected SOCK_STREAM socket.

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

ParametersfileDescriptorAn integer file descriptor associated with a connected socket. The socket must be in non-blocking mode. Any additional attributes desired, such as FD_CLOEXEC, must also be set already.
addressFamilyThe address family (sometimes called domain) of the existing socket. For example, socket.AF_INET.
ReturnsA new instance of cls wrapping the socket given by fileDescriptor.
def getHost(self): (source)
from twisted.internet.interfaces.ITCPTransport
overridden in twisted.internet.unix.Server

Returns an IPv4Address or IPv6Address.

This indicates the server's address.

def getPeer(self): (source)
from twisted.internet.interfaces.ITCPTransport
overridden in twisted.internet.unix.Server

Returns an IPv4Address or IPv6Address.

This indicates the client's address.

API Documentation for Twisted, generated by pydoctor at 2018-07-14 04:53:34.