class Server(_SendmsgMixin, tcp.Server): (source)
Constructor: Server(sock, protocol, client, server, ...)
Implements interfaces: twisted.internet.interfaces.IUNIXTransport
Undocumented
Method | __init__ |
Server(sock, protocol, client, server, sessionno) |
Method | get |
Returns an IPv4Address or IPv6Address . |
Method | get |
Returns an IPv4Address or IPv6Address . |
Method | get |
FIXME:https://github.com/twisted/twisted/issues/12369 |
Method | set |
Enable/disable TCP_NODELAY. |
Instance Variable | logstr |
Undocumented |
Instance Variable | repstr |
Undocumented |
Class Method | _from |
Create a new Server based on an existing connected SOCK_STREAM socket. |
Inherited from _SendmsgMixin
:
Method | do |
Calls {IProtocol.dataReceived} with all available data and IFileDescriptorReceiver.fileDescriptorReceived once for each received file descriptor in ancillary data. |
Method | send |
Queue the given file descriptor to be sent and start trying to send it. |
Method | write |
Send as much of data as possible. Also send any pending file descriptors. |
Method | _ancillary |
Processes ancillary data with level SOL_SOCKET and type SCM_RIGHTS, indicating that the ancillary data payload holds file descriptors. |
Method | _is |
Determine whether the user-space send buffer for this transport is full or not. |
Instance Variable | _file |
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 |
A list of int holding file descriptors which are currently buffered before being sent. |
Instance Variable | _write |
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
(via _SendmsgMixin
):
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 |
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
(via _SendmsgMixin
, Server
):
Instance Variable | _tls |
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 _SendmsgMixin
, Server
, ServerMixin
):
Method | connection |
See abstract.FileDescriptor.connectionLost(). |
Method | get |
Return the socket for this connection. |
Method | get |
Return if SO_KEEPALIVE is enabled. |
Method | log |
Return the prefix to log with when I own the logging thread. |
Method | read |
Indicates read connection was lost. |
Method | set |
Enable/disable SO_KEEPALIVE. |
Instance Variable | protocol |
Undocumented |
Instance Variable | socket |
Undocumented |
Method | _close |
Undocumented |
Method | _data |
Undocumented |
Inherited from ConnectionMixin
(via _SendmsgMixin
, Server
, ServerMixin
, Connection
):
Method | lose |
Close this connection after writing all pending data. |
Method | register |
Register a producer. |
Method | start |
No summary |
Method | unregister |
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 | write |
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 _SendmsgMixin
, Server
, ServerMixin
, Connection
, ConnectionMixin
):
Method | do |
Called when data can be written. |
Method | fileno |
File Descriptor number for select(). |
Method | lose |
Undocumented |
Method | pause |
Pause producing data. |
Method | resume |
Resume producing data. |
Method | start |
Start waiting for read availability. |
Method | start |
Start waiting for write availability. |
Method | stop |
Stop consuming data. |
Method | stop |
Stop producing data. |
Method | stop |
Stop waiting for read availability. |
Method | stop |
Stop waiting for write availability. |
Method | write |
Indicates write connection was lost. |
Constant | SEND |
Undocumented |
Class Variable | buffer |
Undocumented |
Class Variable | disconnecting |
Undocumented |
Instance Variable | data |
Undocumented |
Instance Variable | disconnected |
Undocumented |
Instance Variable | offset |
Undocumented |
Instance Variable | producer |
Undocumented |
Instance Variable | producer |
Undocumented |
Instance Variable | reactor |
Undocumented |
Method | _maybe |
Possibly pause a producer, if there is one and the send buffer is full. |
Method | _post |
Called after a loseConnection(), when all data has been written. |
Class Variable | _write |
Undocumented |
Instance Variable | _temp |
Undocumented |
Instance Variable | _temp |
Undocumented |
Instance Variable | _write |
Undocumented |
Inherited from _ConsumerMixin
(via _SendmsgMixin
, Server
, ServerMixin
, Connection
, ConnectionMixin
, FileDescriptor
):
Instance Variable | streaming |
bool or int |
Inherited from _LogOwner
(via _SendmsgMixin
, Server
, ServerMixin
, Connection
, ConnectionMixin
, FileDescriptor
, _ConsumerMixin
):
Method | _get |
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 _SendmsgMixin
, Server
, ServerMixin
, Connection
, ConnectionMixin
, FileDescriptor
, _ConsumerMixin
, _LogOwner
):
Method | _close |
Undocumented |
Instance Variable | _should |
Set to True if shutdown should be called before calling close on the underlying socket. |
Inherited from _AbortingMixin
(via _SendmsgMixin
, Server
, ServerMixin
, Connection
, ConnectionMixin
, FileDescriptor
, _ConsumerMixin
, _LogOwner
, _SocketCloser
):
Method | abort |
Aborts the connection immediately, dropping any buffered data. |
Instance Variable | _aborting |
Set to True when abortConnection is called. |
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.
twisted.internet.tcp.Server.getHost
Returns an IPv4Address
or IPv6Address
.
This indicates the server's address.
twisted.internet.tcp.Server.getPeer
Returns an IPv4Address
or IPv6Address
.
This indicates the client's address.
FIXME:https://github.com/twisted/twisted/issues/12369
twisted.internet.unix.Server
inherits from twisted.internet.tcp.Server
which has this method implemented for TCP. For Unix socket, this is just a NOOP to avoid errors for the code that calls TCP specicific methods thinking that the Unix transport is a TCP transport.
Enable/disable TCP_NODELAY.
Enabling TCP_NODELAY turns off Nagle's algorithm. Small packets are sent sooner, possibly at the expense of overall throughput.
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 | An 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. |
factory | Undocumented |
reactor | Undocumented |
Returns | |
A new instance of cls wrapping the socket given by fileDescriptor. |