twisted.internet.iocpreactor.tcp.Server(Connection) class documentation

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

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 _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:

Instance Variable 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.
Method getHandle Return a system- and reactor-specific handle.
Method dataReceived
Method readFromHandle Read into the given buffers from this handle.
Method writeToHandle Send buff to current file handle using _iocp.send. The buffer sent is limited to a size of self.SEND_LIMIT.
Method readConnectionLost Indicates read connection was lost.
Method connectionLost The connection was lost.
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 startTLS
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 loseConnection Close the underlying handle or, if TLS has been started, first shut it down.
Method registerProducer Register a producer.
Method unregisterProducer Unregister a producer.
Method _closeWriteConnection Undocumented

Inherited from FileHandle (via Connection):

Method startReading Undocumented
Method stopReading Undocumented
Method doRead Undocumented
Method loseWriteConnection Undocumented
Method writeConnectionLost Indicates write connection was lost.
Method startWriting No summary
Method stopWriting Undocumented
Method doWrite Undocumented
Method getFileHandle Undocumented
Method stopConsuming Stop consuming data.
Method resumeProducing Resume producing data.
Method pauseProducing Pause producing data.
Method stopProducing Stop producing data.
Method _resumeReading Undocumented
Method _dispatchData Dispatch previously read data. Return True if self.reading and we don't have any more data
Method _cbRead Undocumented
Method _handleRead Returns False if we should stop reading for now
Method _resumeWriting Undocumented
Method _cbWrite Undocumented
Method _handleWrite Returns false if we should stop writing for now

Inherited from _ConsumerMixin (via Connection, FileHandle):

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

Inherited from _LogOwner (via Connection, FileHandle):

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)
_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.
def __init__(self, sock, protocol, clientAddr, serverAddr, sessionno, reactor): (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): (source)

A string representation of this connection.

def getHost(self): (source)
from twisted.internet.interfaces.ITCPTransport

Returns an IPv4Address.

This indicates the server's address.

def getPeer(self): (source)
from twisted.internet.interfaces.ITCPTransport

Returns an IPv4Address.

This indicates the client's address.

API Documentation for Twisted, generated by pydoctor at 2017-09-23 19:45:03.