twisted.internet.tcp.Server

class documentation

class Server(_TLSServerMixin, Connection): (source)

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

Constructor: Server(sock, protocol, client, server, ...)

View In Hierarchy

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 client Undocumented
Instance Variable connected Undocumented
Instance Variable hostname Undocumented
Instance Variable logstr Undocumented
Instance Variable repstr Undocumented
Instance Variable server Undocumented
Instance Variable sessionno Undocumented
Class Method _fromConnectedSocket Create a new Server based on an existing connected SOCK_STREAM socket.
Instance Variable _addressType Undocumented
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 ...

Inherited from ServerMixin:

Instance Variable _tlsClientDefault Always False, indicating that this is a server connection, and by default when TLS is negotiated this class will act as a TLS server.

Inherited from Connection (via ServerMixin):

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

Inherited from ConnectionMixin (via ServerMixin, Connection):

Method loseConnection Close this connection after writing all pending data.
Method registerProducer Register a producer.
Method startTLS No summary
Method unregisterProducer Unregister a producer.
Method write Write some bytes to this connection, passing them through a TLS layer if necessary, or discarding them if the connection has already been lost.
Method writeSequence Write some bytes to this connection, scatter/gather-style, passing them through a TLS layer if necessary, or discarding them if the connection has already been lost.
Constant TLS A flag indicating whether TLS is currently in use on this transport. This is not a good way for applications to check for TLS, instead use twisted.internet.interfaces.ISSLTransport.

Inherited from FileDescriptor (via ServerMixin, Connection, ConnectionMixin):

Method doWrite Called when data can be written.
Method fileno File Descriptor number for select().
Method loseWriteConnection Undocumented
Method pauseProducing Pause producing data.
Method resumeProducing Resume producing data.
Method startReading Start waiting for read availability.
Method startWriting Start waiting for write availability.
Method stopConsuming Stop consuming data.
Method stopProducing Stop producing data.
Method stopReading Stop waiting for read availability.
Method stopWriting Stop waiting for write availability.
Method writeConnectionLost Indicates write connection was lost.
Constant SEND_LIMIT Undocumented
Class Variable bufferSize Undocumented
Class Variable disconnecting Undocumented
Instance Variable dataBuffer Undocumented
Instance Variable disconnected Undocumented
Instance Variable offset Undocumented
Instance Variable producer Undocumented
Instance Variable producerPaused Undocumented
Instance Variable reactor 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.
Method _postLoseConnection Called after a loseConnection(), when all data has been written.
Class Variable _writeDisconnected Undocumented
Instance Variable _tempDataBuffer Undocumented
Instance Variable _tempDataLen Undocumented
Instance Variable _writeDisconnecting Undocumented

Inherited from _ConsumerMixin (via ServerMixin, Connection, ConnectionMixin, FileDescriptor):

Instance Variable streamingProducer bool or int

Inherited from _LogOwner (via ServerMixin, Connection, ConnectionMixin, FileDescriptor, _ConsumerMixin):

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 ServerMixin, Connection, ConnectionMixin, FileDescriptor, _ConsumerMixin, _LogOwner):

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

Inherited from _AbortingMixin (via ServerMixin, Connection, ConnectionMixin, FileDescriptor, _ConsumerMixin, _LogOwner, _SocketCloser):

Method abortConnection Aborts the connection immediately, dropping any buffered data.
Instance Variable _aborting Set to True when abortConnection is called.
def __init__(self, sock: socket.socket, protocol: IProtocol, client: tuple[object, ...], server: Port, sessionno: int, reactor: IReactorTCP): (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) -> str: (source)

A string representation of this connection.

def getHost(self): (source)
from twisted.internet.interfaces.ITCPTransport
overrides twisted.internet.abstract.FileDescriptor.getHost
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
overrides twisted.internet.abstract.FileDescriptor.getPeer
overridden in twisted.internet.unix.Server

Returns an IPv4Address or IPv6Address.

This indicates the client's address.

client = (source)

Undocumented

connected: int = (source)
overrides twisted.internet.abstract.FileDescriptor.connected

Undocumented

hostname = (source)

Undocumented

logstr = (source)
overrides twisted.internet.tcp.Connection.logstr
overridden in twisted.internet.unix.Server

Undocumented

repstr: str = (source)
overridden in twisted.internet.unix.Server

Undocumented

server = (source)
overridden in twisted.internet.ssl.Server

Undocumented

sessionno = (source)

Undocumented

@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.

Parameters
fileDescriptorAn 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.
factoryUndocumented
reactorUndocumented
Returns
A new instance of cls wrapping the socket given by fileDescriptor.
_addressType = (source)

Undocumented

_base = (source)

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).