twisted.internet.unix.Server(_SendmsgMixin, tcp.Server) class documentationtwisted.internet.unix
          View Source
          (View In Hierarchy)
        
      | Method | __init__ | Server(sock, protocol, client, server, sessionno) | 
| Instance Variable | repstr | Undocumented | 
| Instance Variable | logstr | Undocumented | 
| Method | getHost | Returns an IPv4Address or IPv6Address. | 
  
| Method | getPeer | Returns an IPv4Address or IPv6Address. | 
  
| Class Method | _fromConnectedSocket | Create a new Server based on an existing connected SOCK_STREAM socket. | 
  
Inherited from _SendmsgMixin:
| Method | sendFileDescriptor | Queue the given file descriptor to be sent and start trying to send it. | 
| Method | writeSomeData | Send as much of data as possible.  Also send any pending file descriptors. | 
  
| Method | doRead | Calls {IProtocol.dataReceived} with all available data and IFileDescriptorReceiver.fileDescriptorReceived once for each received file descriptor in ancillary data. | 
  
| Instance Variable | _writeSomeDataBase | 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. | 
  
| Instance Variable | _sendmsgQueue | A list of int holding file descriptors which are currently buffered before being sent. | 
  
| Instance Variable | _fileDescriptorBufferSize | An int giving the maximum number of file descriptors to accept and queue for sending before pausing the registered producer, if there is one. | 
  
| Method | _isSendBufferFull | Determine whether the user-space send buffer for this transport is full or not. | 
| Method | _ancillaryLevelSOLSOCKETTypeSCMRIGHTS | Processes ancillary data with level SOL_SOCKET and type SCM_RIGHTS, indicating that the ancillary data payload holds file descriptors. | 
Inherited from Server:
| Instance Variable | server | Undocumented | 
| Instance Variable | client | Undocumented | 
| Instance Variable | sessionno | Undocumented | 
| Instance Variable | hostname | Undocumented | 
| Instance Variable | connected | Undocumented | 
| Method | __repr__ | A string representation of this connection. | 
| 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). | 
  
| Instance Variable | _addressType | Undocumented | 
Inherited from Connection (via Server):
| Instance Variable | socket | Undocumented | 
| Instance Variable | fileno | Undocumented | 
| Instance Variable | protocol | Undocumented | 
| Method | getHandle | Return the socket for this connection. | 
| Method | doRead | Calls self.protocol.dataReceived with all available data. | 
| Method | writeSomeData | Write as much as possible of the given data to this TCP connection. | 
| Method | readConnectionLost | Indicates read connection was lost. | 
| Method | connectionLost | See abstract.FileDescriptor.connectionLost(). | 
| 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 | _dataReceived | Undocumented | 
| Method | _closeWriteConnection | Undocumented | 
Inherited from _TLSConnectionMixin (via Server, Connection):
| Class Variable | TLS | Undocumented | 
Inherited from FileDescriptor (via Server, Connection):
| Instance Variable | disconnected | Undocumented | 
| Instance Variable | disconnecting | Undocumented | 
| Instance Variable | dataBuffer | Undocumented | 
| Instance Variable | offset | Undocumented | 
| Class Variable | SEND_LIMIT | Undocumented | 
| Instance Variable | reactor | Undocumented | 
| Instance Variable | producer | Undocumented | 
| Method | doWrite | Called when data can be written. | 
| Instance Variable | producerPaused | Undocumented | 
| Method | writeConnectionLost | Indicates write connection was lost. | 
| Method | write | Reliably write some data. | 
| Method | writeSequence | Reliably write a sequence of data. | 
| Method | loseConnection | Close the connection at the next available opportunity. | 
| Method | loseWriteConnection | Undocumented | 
| Method | stopReading | Stop waiting for read availability. | 
| Method | stopWriting | Stop waiting for write availability. | 
| Method | startReading | Start waiting for read availability. | 
| Method | startWriting | Start waiting for write availability. | 
| Class Variable | bufferSize | Undocumented | 
| Method | stopConsuming | Stop consuming data. | 
| Method | resumeProducing | Resume producing data. | 
| Method | pauseProducing | Pause producing data. | 
| Method | stopProducing | Stop producing data. | 
| Instance Variable | _writeDisconnecting | Undocumented | 
| Instance Variable | _writeDisconnected | Undocumented | 
| Instance Variable | _tempDataBuffer | Undocumented | 
| Instance Variable | _tempDataLen | Undocumented | 
| Method | _postLoseConnection | Called after a loseConnection(), when all data has been written. | 
| Method | _isSendBufferFull | Determine whether the user-space send buffer for this transport is full or not. | 
| Method | _maybePauseProducer | Possibly pause a producer, if there is one and the send buffer is full. | 
Inherited from _ConsumerMixin (via Server, Connection, FileDescriptor):
| Instance Variable | streamingProducer | bool or int | 
  
| Method | registerProducer | Register to receive data from a producer. | 
| Method | unregisterProducer | Stop consuming data from a producer, without disconnecting. | 
Inherited from _LogOwner (via Server, Connection, FileDescriptor):
| 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 Server, 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 Server, Connection):
| Method | abortConnection | Aborts the connection immediately, dropping any buffered data. | 
| Instance Variable | doWrite | Undocumented | 
| 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.
Create a new Server based on an existing connected SOCK_STREAM socket.
Arguments are the same as to Server.__init__, except where noted.
| Parameters | fileDescriptor | 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. | 
| Returns | A new instance of cls wrapping the socket given by fileDescriptor. | |
Returns an IPv4Address or IPv6Address.
This indicates the server's address.
Returns an IPv4Address or IPv6Address.
This indicates the client's address.