class documentation

class Server(_SendmsgMixin, tcp.Server): (source)

Implements interfaces: twisted.internet.interfaces.IUNIXTransport

View In Hierarchy

Undocumented

Method __init__ Server(sock, protocol, client, server, sessionno)
Method get​Host Returns an IPv4Address or IPv6Address.
Method get​Peer Returns an IPv4Address or IPv6Address.
Instance Variable logstr Undocumented
Instance Variable repstr Undocumented
Class Method _from​Connected​Socket Create a new Server based on an existing connected SOCK_STREAM socket.

Inherited from _SendmsgMixin:

Method do​Read Calls {IProtocol.dataReceived} with all available data and IFileDescriptorReceiver.fileDescriptorReceived once for each received file descriptor in ancillary data.
Method send​File​Descriptor Queue the given file descriptor to be sent and start trying to send it.
Method write​Some​Data Send as much of data as possible. Also send any pending file descriptors.
Method _ancillary​Level​SOLSOCKETType​SCMRIGHTS Processes ancillary data with level SOL_SOCKET and type SCM_RIGHTS, indicating that the ancillary data payload holds file descriptors.
Method _is​Send​Buffer​Full Determine whether the user-space send buffer for this transport is full or not.
Instance Variable _file​Descriptor​Buffer​Size An int giving the maximum number of file descriptors to accept and queue for sending before pausing the registered producer, if there is one.
Instance Variable _sendmsg​Queue A list of int holding file descriptors which are currently buffered before being sent.
Instance Variable _write​Some​Data​Base The class which provides the basic implementation of writeSomeData. Ultimately this should be a subclass of twisted.internet.abstract.FileDescriptor. Subclasses which mix in _SendmsgMixin must define this.

Inherited from Server:

Method __repr__ A string representation of this connection.
Instance Variable client Undocumented
Instance Variable connected Undocumented
Instance Variable hostname Undocumented
Instance Variable server Undocumented
Instance Variable sessionno Undocumented
Instance Variable _address​Type 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 Server will go through another layer of TLS if it has been enabled).

Inherited from Connection (via Server):

Method connection​Lost See abstract.FileDescriptor.connectionLost().
Method do​Read Calls self.protocol.dataReceived with all available data.
Method get​Handle Return the socket for this connection.
Method get​Tcp​Keep​Alive Return if SO_KEEPALIVE is enabled.
Method get​Tcp​No​Delay Return if TCP_NODELAY is enabled.
Method log​Prefix Return the prefix to log with when I own the logging thread.
Method read​Connection​Lost Indicates read connection was lost.
Method set​Tcp​Keep​Alive Enable/disable SO_KEEPALIVE.
Method set​Tcp​No​Delay Enable/disable TCP_NODELAY.
Method write​Some​Data Write as much as possible of the given data to this TCP connection.
Instance Variable protocol Undocumented
Instance Variable socket Undocumented
Method _close​Write​Connection Undocumented
Method _data​Received Undocumented

Inherited from _TLSConnectionMixin (via Server, Connection):

Constant TLS Undocumented

Inherited from FileDescriptor (via Server, Connection):

Method do​Write Called when data can be written.
Method fileno File Descriptor number for select().
Method lose​Connection Close the connection at the next available opportunity.
Method lose​Write​Connection Undocumented
Method pause​Producing Pause producing data.
Method resume​Producing Resume producing data.
Method start​Reading Start waiting for read availability.
Method start​Writing Start waiting for write availability.
Method stop​Consuming Stop consuming data.
Method stop​Producing Stop producing data.
Method stop​Reading Stop waiting for read availability.
Method stop​Writing Stop waiting for write availability.
Method write Reliably write some data.
Method write​Connection​Lost Indicates write connection was lost.
Method write​Sequence Reliably write a sequence of data.
Constant SEND​_LIMIT Undocumented
Class Variable buffer​Size Undocumented
Class Variable disconnecting Undocumented
Instance Variable data​Buffer Undocumented
Instance Variable disconnected Undocumented
Instance Variable offset Undocumented
Instance Variable producer Undocumented
Instance Variable producer​Paused Undocumented
Instance Variable reactor Undocumented
Method _is​Send​Buffer​Full Determine whether the user-space send buffer for this transport is full or not.
Method _maybe​Pause​Producer Possibly pause a producer, if there is one and the send buffer is full.
Method _post​Lose​Connection Called after a loseConnection(), when all data has been written.
Class Variable _write​Disconnected Undocumented
Instance Variable _temp​Data​Buffer Undocumented
Instance Variable _temp​Data​Len Undocumented
Instance Variable _write​Disconnecting Undocumented

Inherited from _ConsumerMixin (via Server, Connection, FileDescriptor):

Method register​Producer Register to receive data from a producer.
Method unregister​Producer Stop consuming data from a producer, without disconnecting.
Instance Variable streaming​Producer bool or int

Inherited from _LogOwner (via Server, Connection, FileDescriptor):

Method _get​Log​Prefix 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 Server, Connection):

Method _close​Socket Undocumented
Instance Variable _should​Shutdown Set to True if shutdown should be called before calling close on the underlying socket.

Inherited from _AbortingMixin (via Server, Connection):

Method abort​Connection Aborts the connection immediately, dropping any buffered data.
Instance Variable do​Write Undocumented
Instance Variable _aborting Set to True when abortConnection is called.
def __init__(self, sock, protocol, client, server, sessionno, reactor): (source)

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 getHost(self): (source)

Returns an IPv4Address or IPv6Address.

This indicates the server's address.

def getPeer(self): (source)

Returns an IPv4Address or IPv6Address.

This indicates the client's address.

logstr = (source)

Undocumented

repstr = (source)

Undocumented

@classmethod
def _fromConnectedSocket(cls, fileDescriptor, factory, reactor): (source)

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

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

Parameters
file​DescriptorAn 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.
factoryUndocumented
reactorUndocumented
Returns
A new instance of cls wrapping the socket given by fileDescriptor.