twisted.internet.iocpreactor.tcp.Server

class documentation

class Server(Connection): (source)

Constructor: Server(sock, protocol, clientAddr, serverAddr, ...)

Serverside socket-stream connection class.

I am 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.
Method	`getPeer`	Returns an IPv4Address.
Instance Variable	`clientAddr`	Undocumented
Instance Variable	`connected`	Undocumented
Instance Variable	`logstr`	Undocumented
Instance Variable	`repstr`	Undocumented
Instance Variable	`serverAddr`	Undocumented
Instance Variable	`sessionno`	Undocumented
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:

Method	`connectionLost`	The connection was lost.
Method	`dataReceived`	No summary
Method	`getHandle`	Return a system- and reactor-specific handle.
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	`loseConnection`	Close the underlying handle or, if TLS has been started, first shut it down.
Method	`readConnectionLost`	Indicates read connection was lost.
Method	`readFromHandle`	Read into the given buffers from this handle.
Method	`registerProducer`	Register a producer.
Method	`setTcpKeepAlive`	Enable/disable `SO_KEEPALIVE`.
Method	`setTcpNoDelay`	Enable/disable `TCP_NODELAY`.
Method	`startTLS`	No summary
Method	`unregisterProducer`	Unregister a producer.
Method	`write`	Write some data, either directly to the underlying handle or, if TLS has been started, to the `TLSMemoryBIOProtocol` for it to encrypt and send.
Method	`writeSequence`	Write some data, either directly to the underlying handle or, if TLS has been started, to the `TLSMemoryBIOProtocol` for it to encrypt and send.
Method	`writeToHandle`	Send `buff` to current file handle using `_iocp.send`. The buffer sent is limited to a size of `self.SEND_LIMIT`.
Constant	`TLS`	`False` to indicate the connection is in normal TCP mode, `True` to indicate that TLS has been started and that operations must be routed through the `TLSMemoryBIOProtocol` instance.
Instance Variable	`protocol`	Undocumented
Instance Variable	`socket`	Undocumented
Method	`_closeWriteConnection`	Undocumented

Inherited from FileHandle (via Connection):

Method	`doRead`	Undocumented
Method	`doWrite`	Undocumented
Method	`getFileHandle`	Undocumented
Method	`loseWriteConnection`	Undocumented
Method	`pauseProducing`	Pause producing data.
Method	`resumeProducing`	Resume producing data.
Method	`startReading`	Undocumented
Method	`startWriting`	Override in a subclass to cause the reactor to monitor this selectable for write events. This will be called once in `unregisterProducer` if `loseConnection` has previously been called, so that the connection can actually close.
Method	`stopConsuming`	Stop consuming data.
Method	`stopProducing`	Stop producing data.
Method	`stopReading`	Undocumented
Method	`stopWriting`	Undocumented
Method	`writeConnectionLost`	Indicates write connection was lost.
Constant	`SEND_LIMIT`	Undocumented
Class Variable	`disconnecting`	Undocumented
Class Variable	`dynamicReadBuffers`	Undocumented
Class Variable	`maxReadBuffers`	Undocumented
Class Variable	`readBufferSize`	Undocumented
Class Variable	`writeBufferSize`	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
Instance Variable	`reading`	Undocumented
Instance Variable	`writing`	Undocumented
Method	`_cbRead`	Undocumented
Method	`_cbWrite`	Undocumented
Method	`_dispatchData`	Dispatch previously read data. Return True if self.reading and we don't have any more data
Method	`_handleRead`	Returns False if we should stop reading for now
Method	`_handleWrite`	Returns false if we should stop writing for now
Method	`_resumeReading`	Undocumented
Method	`_resumeWriting`	Undocumented
Class Variable	`_writeDisconnected`	Undocumented
Instance Variable	`_readBuffers`	Undocumented
Instance Variable	`_readNextBuffer`	Undocumented
Instance Variable	`_readScheduled`	Undocumented
Instance Variable	`_readScheduledInOS`	Undocumented
Instance Variable	`_readSize`	Undocumented
Instance Variable	`_tempDataBuffer`	Undocumented
Instance Variable	`_tempDataLen`	Undocumented
Instance Variable	`_writeDisconnecting`	Undocumented
Instance Variable	`_writeScheduled`	Undocumented

Inherited from _ConsumerMixin (via Connection, FileHandle):

Instance Variable streamingProducer bool or int

Inherited from _LogOwner (via Connection, FileHandle, _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 Connection, FileHandle, _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 Connection, FileHandle, _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, clientAddr: Union[IPv4Address, IPv6Address], serverAddr: Union[IPv4Address, IPv6Address], sessionno: int, reactor: IOCPReactor): (source) ¶

overrides twisted.internet.iocpreactor.tcp.Connection.__init__

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

Initialize me 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.iocpreactor.tcp.Connection.getHost

Returns an IPv4Address.

This indicates the server's address.

def getPeer(self): (source) ¶

from twisted.internet.interfaces.ITCPTransport

overrides twisted.internet.iocpreactor.tcp.Connection.getPeer

Returns an IPv4Address.

This indicates the client's address.