twisted.internet.iocpreactor.tcp.Server : API documentation

class documentation

class twisted.internet.iocpreactor.tcp.Server(Connection): (source)

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)
Instance Variable	serverAddr	Undocumented
Instance Variable	clientAddr	Undocumented
Instance Variable	sessionno	Undocumented
Instance Variable	logstr	Undocumented
Instance Variable	repstr	Undocumented
Instance Variable	connected	Undocumented
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.
Instance Variable	socket	Undocumented
Instance Variable	protocol	Undocumented
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):

Class Variable	maxReadBuffers	Undocumented
Class Variable	readBufferSize	Undocumented
Instance Variable	reading	Undocumented
Class Variable	dynamicReadBuffers	Undocumented
Method	startReading	Undocumented
Method	stopReading	Undocumented
Method	doRead	Undocumented
Instance Variable	dataBuffer	Undocumented
Instance Variable	offset	Undocumented
Instance Variable	writing	Undocumented
Class Variable	writeBufferSize	Undocumented
Method	loseWriteConnection	Undocumented
Method	writeConnectionLost	Indicates write connection was lost.
Method	startWriting	No summary
Method	stopWriting	Undocumented
Instance Variable	producerPaused	Undocumented
Method	doWrite	Undocumented
Instance Variable	disconnected	Undocumented
Instance Variable	disconnecting	Undocumented
Class Variable	SEND_LIMIT	Undocumented
Instance Variable	reactor	Undocumented
Instance Variable	producer	Undocumented
Method	getFileHandle	Undocumented
Method	stopConsuming	Stop consuming data.
Method	resumeProducing	Resume producing data.
Method	pauseProducing	Pause producing data.
Method	stopProducing	Stop producing data.
Instance Variable	_readNextBuffer	Undocumented
Instance Variable	_readSize	Undocumented
Instance Variable	_readScheduled	Undocumented
Instance Variable	_readScheduledInOS	Undocumented
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
Instance Variable	_writeScheduled	Undocumented
Instance Variable	_writeDisconnecting	Undocumented
Instance Variable	_writeDisconnected	Undocumented
Method	_resumeWriting	Undocumented
Method	_cbWrite	Undocumented
Method	_handleWrite	Returns false if we should stop writing for now
Instance Variable	_tempDataBuffer	Undocumented
Instance Variable	_tempDataLen	Undocumented
Instance Variable	_readBuffers	Undocumented

Inherited from _ConsumerMixin (via Connection, FileHandle):

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.
Method	_closeSocket	Undocumented

Inherited from _AbortingMixin (via Connection):

Method	abortConnection	Aborts the connection immediately, dropping any buffered data.
Instance Variable	doRead	Undocumented
Instance Variable	doWrite	Undocumented
Instance Variable	_aborting	Set to `True` when `abortConnection` is called.

_tlsClientDefault = (source)

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

(type: bool)

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.

serverAddr = (source)

Undocumented

clientAddr = (source)

Undocumented

sessionno = (source)

Undocumented

logstr = (source)

overrides twisted.internet.iocpreactor.abstract.FileHandle.logstr

Undocumented

repstr = (source)

Undocumented

connected = (source)