class documentation

class 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.
Method __repr__ Undocumented
Method connection​Lost Cleans up my socket.
Method set​Log​Str 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 _bind​Socket Prepare and assign a socket.socket instance to self.socket.

Inherited from _UNIXPort:

Method get​Host Returns a UNIXAddress.

Inherited from Port:

Method connect 'Connect' to remote server.
Method do​Read Called when my socket is ready for reading.
Method get​Broadcast​Allowed Checks if broadcast is currently allowed on this port.
Method get​Handle Return a socket object.
Method get​Host Return the local address of the UDP connection
Method log​Prefix Return the prefix to log with.
Method lose​Connection Close the connection at the next available opportunity.
Method set​Broadcast​Allowed Set whether this port may broadcast. This is disabled by default.
Method start​Listening Create and bind my socket, and begin listening on it.
Method stop​Listening Stop listening on this port.
Method write​Sequence Write a datagram constructed from an iterable of bytes.
Instance Variable address​Family 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 max​Packet​Size Undocumented
Instance Variable max​Throughput Maximum number of bytes read in one event loop iteration.
Instance Variable port Undocumented
Instance Variable protocol Undocumented
Class Method _from​Listening​Descriptor Create a new Port based on an existing listening SOCK_DGRAM socket.
Method _connect​To​Protocol Undocumented
Method _lose​Connection Undocumented
Method _set​Address​Family Resolve address family for the socket.
Instance Variable _connected​Addr Undocumented
Instance Variable _preexisting​Socket 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 _real​Port​Number Actual port number being listened on. The value will be None until this Port is listening.

Inherited from BasePort (via Port):

Method create​Internet​Socket Undocumented
Method do​Write Raises a RuntimeError
Class Variable socket​Type Undocumented

Inherited from FileDescriptor (via Port, BasePort):

Method fileno File Descriptor number for select().
Method get​Peer Get the remote address of this connection.
Method lose​Write​Connection Undocumented
Method pause​Producing Pause producing data.
Method read​Connection​Lost Indicates read connection was lost.
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​Connection​Lost Indicates write connection was lost.
Method write​Some​Data Write as much as possible of the given data, immediately.
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 _close​Write​Connection 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 Port, BasePort, 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 Port, BasePort, 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.
def __init__(self, addr, proto, maxPacketSize=8192, mode=438, reactor=None): (source)
Initialize with address to listen on.
def __repr__(self): (source)

Undocumented

Returns
strUndocumented
def connectionLost(self, reason=None): (source)
def setLogStr(self): (source)
Initialize the logstr attribute to be used by logPrefix.
connected: int = (source)

Undocumented

logstr = (source)

Undocumented

mode = (source)

Undocumented

socket = (source)

Undocumented

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.