twisted.internet.iocpreactor.udp.Port(abstract.FileHandle) class documentation

Part of twisted.internet.iocpreactor.udp View Source (View In Hierarchy)

Known subclasses: twisted.internet.iocpreactor.udp.MulticastPort

Implements interfaces: twisted.internet.interfaces.IListeningPort, twisted.internet.interfaces.ISystemHandle, twisted.internet.interfaces.IUDPTransport, twisted.internet.iocpreactor.interfaces.IReadWriteHandle

UDP port, listening for packets.

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.
Class Variable dynamicReadBuffers Undocumented
Method __init__ Initialize with a numeric port to listen on.
Instance Variable port Undocumented
Instance Variable protocol Undocumented
Instance Variable readBufferSize Undocumented
Instance Variable interface Undocumented
Instance Variable addressBuffer Undocumented
Instance Variable addressLengthBuffer Undocumented
Method __repr__ Undocumented
Method getHandle Return a socket object.
Method startListening Create and bind my socket, and begin listening on it.
Method createSocket Undocumented
Instance Variable connected Undocumented
Instance Variable socket Undocumented
Instance Variable getFileHandle Undocumented
Method cbRead Undocumented
Method handleRead Undocumented
Method doRead Undocumented
Method write Write a datagram.
Method writeSequence Undocumented
Method connect 'Connect' to remote server.
Method stopListening Stop listening on this port.
Method loseConnection Undocumented
Method connectionLost Cleans up my socket.
Method setLogStr Initialize the logstr attribute to be used by logPrefix.
Instance Variable logstr Undocumented
Method logPrefix Returns the name of my class, to prefix log entries 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 Undocumented
Instance Variable _connectedAddr Undocumented
Method _setAddressFamily Resolve address family for the socket.
Method _bindSocket Undocumented
Method _connectToProtocol Undocumented
Method _loseConnection Undocumented
addressFamily =
socket.AF_INET or socket.AF_INET6, depending on whether this port is listening on an IPv4 address or an IPv6 address.
dynamicReadBuffers =
Undocumented
(type: bool)
_realPortNumber =
Undocumented
def __init__(self, port, proto, interface="""""", maxPacketSize=8192, reactor=None): (source)
overridden in twisted.internet.iocpreactor.udp.MulticastPort

Initialize with a numeric port to listen on.

port =
Undocumented
protocol =
Undocumented
readBufferSize =
Undocumented
interface =
Undocumented
_connectedAddr =
Undocumented
addressBuffer =
Undocumented
addressLengthBuffer =
Undocumented
def _setAddressFamily(self): (source)

Resolve address family for the socket.

def __repr__(self): (source)
Undocumented
def getHandle(self): (source)
from twisted.internet.interfaces.ISystemHandle

Return a socket object.

def startListening(self): (source)
from twisted.internet.interfaces.IListeningPort

Create and bind my socket, and begin listening on it.

This is called on unserialization, and must be called after creating a server to begin listening on the specified port.

def createSocket(self): (source)
overridden in twisted.internet.iocpreactor.udp.MulticastPort
Undocumented
def _bindSocket(self): (source)
Undocumented
connected =
Undocumented
(type: bool)
socket =
Undocumented
getFileHandle =
Undocumented
def _connectToProtocol(self): (source)
Undocumented
def cbRead(self, rc, data, evt): (source)
Undocumented
def handleRead(self, rc, data, evt): (source)
Undocumented
def doRead(self): (source)
Undocumented
def write(self, datagram, addr=None): (source)
from twisted.internet.interfaces.IUDPTransport

Write a datagram.

Parametersaddrshould be a tuple (ip, port), can be None in connected mode.
def writeSequence(self, seq, addr): (source)
Undocumented
def connect(self, host, port): (source)
from twisted.internet.interfaces.IUDPTransport

'Connect' to remote server.

def _loseConnection(self): (source)
Undocumented
def stopListening(self): (source)
from twisted.internet.interfaces.IListeningPort

Stop listening on this port.

If it does not complete immediately, will return Deferred that fires upon completion.

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

Cleans up my socket.

def setLogStr(self): (source)

Initialize the logstr attribute to be used by logPrefix.

logstr =
Undocumented
def logPrefix(self): (source)

Returns the name of my class, to prefix log entries with.

def getHost(self): (source)
from twisted.internet.interfaces.IListeningPort

Return the local address of the UDP connection

Returnsthe local address of the UDP connection (type: IPv4Address or IPv6Address)
def setBroadcastAllowed(self, enabled): (source)
from twisted.internet.interfaces.IUDPTransport

Set whether this port may broadcast. This is disabled by default.

ParametersenabledWhether the port may broadcast. (type: bool)
def getBroadcastAllowed(self): (source)
from twisted.internet.interfaces.IUDPTransport

Checks if broadcast is currently allowed on this port.

ReturnsWhether this port may broadcast. (type: bool)
API Documentation for Twisted, generated by pydoctor at 2020-03-20 23:54:06.