twisted.internet.unix.DatagramPort

class documentation

class DatagramPort(_UNIXPort, udp.Port): (source)

Known subclasses: twisted.internet.unix.ConnectedDatagramPort

Constructor: DatagramPort(addr, proto, maxPacketSize, mode, reactor)

Implements interfaces: twisted.internet.interfaces.IUNIXDatagramTransport

View In Hierarchy

Datagram UNIX port, listening for packets.

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

Inherited from _UNIXPort:

Method getHost Returns a UNIXAddress.

Inherited from Port (via _UNIXPort):

Method connect 'Connect' to remote server.
Method doRead Called when my socket is ready for reading.
Method getBroadcastAllowed Checks if broadcast is currently allowed on this port.
Method getHandle Return a socket object.
Method logPrefix Return the prefix to log with.
Method loseConnection Close the connection at the next available opportunity.
Method setBroadcastAllowed Set whether this port may broadcast. This is disabled by default.
Method startListening Create and bind my socket, and begin listening on it.
Method stopListening Stop listening on this port.
Method writeSequence Write a datagram constructed from an iterable of bytes.
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 d Undocumented
Instance Variable interface Undocumented
Instance Variable maxPacketSize Undocumented
Instance Variable maxThroughput Maximum number of bytes read in one event loop iteration.
Instance Variable port Undocumented
Instance Variable protocol 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.
Instance Variable _connectedAddr Undocumented
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 _realPortNumber Actual port number being listened on. The value will be None until this Port is listening.

Inherited from BasePort (via _UNIXPort, Port):

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

Inherited from FileDescriptor (via _UNIXPort, Port, BasePort):

Method fileno File Descriptor number for select().
Method getPeer Get the remote address of this connection.
Method loseWriteConnection Undocumented
Method pauseProducing Pause producing data.
Method readConnectionLost Indicates read connection was lost.
Method resumeProducing Resume producing data.
Method startReading Start waiting for read availability.
Method startWriting Start waiting for write availability.
Method stopConsuming Stop consuming data.
Method stopProducing Stop producing data.
Method stopReading Stop waiting for read availability.
Method stopWriting Stop waiting for write availability.
Method writeConnectionLost Indicates write connection was lost.
Method writeSomeData Write as much as possible of the given data, immediately.
Constant SEND_LIMIT Undocumented
Class Variable bufferSize Undocumented
Class Variable disconnecting Undocumented
Instance Variable dataBuffer Undocumented
Instance Variable disconnected Undocumented
Instance Variable offset Undocumented
Instance Variable producer Undocumented
Instance Variable producerPaused Undocumented
Instance Variable reactor Undocumented
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.
Method _postLoseConnection Called after a loseConnection(), when all data has been written.
Class Variable _writeDisconnected Undocumented
Instance Variable _tempDataBuffer Undocumented
Instance Variable _tempDataLen Undocumented
Instance Variable _writeDisconnecting Undocumented

Inherited from _ConsumerMixin (via _UNIXPort, Port, BasePort, FileDescriptor):

Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.
Instance Variable streamingProducer bool or int

Inherited from _LogOwner (via _UNIXPort, Port, BasePort, FileDescriptor, _ConsumerMixin):

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)
overrides twisted.internet.udp.Port.__init__
overridden in twisted.internet.unix.ConnectedDatagramPort

Initialize with address to listen on.

def __repr__(self) -> str: (source)
overrides twisted.internet.udp.Port.__repr__

Undocumented

def connectionLost(self, reason=None): (source)
from twisted.internet.interfaces.IFileDescriptor
overrides twisted.internet.udp.Port.connectionLost

Cleans up my socket.

def setLogStr(self): (source)
overrides twisted.internet.udp.Port.setLogStr

Initialize the logstr attribute to be used by logPrefix.

def write(self, datagram, address): (source)
from twisted.internet.interfaces.IUNIXDatagramTransport
overrides twisted.internet.udp.Port.write
overridden in twisted.internet.unix.ConnectedDatagramPort

Write a datagram.

connected: int = (source)
overrides twisted.internet.udp.Port.connected

Undocumented

logstr = (source)
overrides twisted.internet.udp.Port.logstr

Undocumented

mode = (source)

Undocumented

socket = (source)
overrides twisted.internet.udp.Port.socket

Undocumented

def _bindSocket(self): (source)
overrides twisted.internet.udp.Port._bindSocket

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.