class documentation

class twisted.internet.unix.DatagramPort(_UNIXPort, udp.Port): (source)

Known subclasses: twisted.internet.unix.ConnectedDatagramPort

Implements interfaces: twisted.internet.interfaces.IUNIXDatagramTransport

View In Hierarchy

Datagram UNIX port, listening for packets.

Method __init__ Initialize with address to listen on.
Instance Variable mode Undocumented
Method __repr__ Undocumented
Instance Variable connected Undocumented
Instance Variable socket Undocumented
Method write Write a datagram.
Method connectionLost Cleans up my socket.
Method setLogStr Initialize the logstr attribute to be used by logPrefix.
Instance Variable logstr Undocumented
Method _bindSocket Prepare and assign a socket.socket instance to self.socket.

Inherited from _UNIXPort:

Method getHost Returns a UNIXAddress.

Inherited from Port:

Instance Variable maxThroughput Maximum number of bytes read in one event loop iteration.
Instance Variable addressFamily socket.AF_INET or socket.AF_INET6, depending on whether this port is listening on an IPv4 address or an IPv6 address.
Instance Variable port Undocumented
Instance Variable protocol Undocumented
Instance Variable maxPacketSize Undocumented
Instance Variable interface Undocumented
Method getHandle Return a socket object.
Method startListening Create and bind my socket, and begin listening on it.
Method doRead Called when my socket is ready for reading.
Method writeSequence Write a datagram constructed from an iterable of bytes.
Method connect 'Connect' to remote server.
Method stopListening Stop listening on this port.
Instance Variable d Undocumented
Method loseConnection Close the connection at the next available opportunity.
Method logPrefix Return the prefix to log with.
Method getHost Return the local address of the UDP connection
Method setBroadcastAllowed Set whether this port may broadcast. This is disabled by default.
Method getBroadcastAllowed Checks if broadcast is currently allowed on this port.
Instance Variable _realPortNumber Actual port number being listened on. The value will be None until this Port is listening.
Instance Variable _preexistingSocket If not None, a socket.socket instance which was created and initialized outside of the reactor and will be used to listen for connections (instead of a new socket being created by this Port).
Instance Variable _connectedAddr Undocumented
Class Method _fromListeningDescriptor Create a new Port based on an existing listening SOCK_DGRAM socket.
Method _connectToProtocol Undocumented
Method _loseConnection Undocumented
Method _setAddressFamily Resolve address family for the socket.

Inherited from BasePort (via Port):

Class Variable socketType Undocumented
Method createInternetSocket Undocumented
Method doWrite Raises a RuntimeError

Inherited from FileDescriptor (via Port, BasePort):

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 writeSomeData Write as much as possible of the given data, immediately.
Instance Variable producerPaused Undocumented
Method writeConnectionLost Undocumented
Method readConnectionLost Undocumented
Method getPeer Undocumented
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 Undocumented
Method pauseProducing Undocumented
Method stopProducing Undocumented
Method fileno File Descriptor number for select().
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 _closeWriteConnection Undocumented
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 Port, BasePort, 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 Port, BasePort, FileDescriptor):

Method _getLogPrefix Determine the log prefix to use for messages related to applicationObject, which may or may not be an interfaces.ILoggingContext provider.
def __init__(self, addr, proto, maxPacketSize=8192, mode=438, reactor=None): (source)

Initialize with address to listen on.

mode = (source)


def __repr__(self): (source)


ReturnsUndocumented (type: str)
def _bindSocket(self): (source)

Prepare and assign a socket.socket instance to self.socket.

Either creates a new SOCK_DGRAM socket.socket bound to self.interface and self.port or takes an existing socket.socket provided via the interfaces.IReactorSocket.adoptDatagramPort interface.

connected = (source)


(type: int)
socket = (source)


def connectionLost(self, reason=None): (source)

Cleans up my socket.

def setLogStr(self): (source)

Initialize the logstr attribute to be used by logPrefix.

logstr = (source)


API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.