twisted.internet.iocpreactor.udp.Port

class documentation

class Port(abstract.FileHandle): (source)

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

View In Hierarchy

UDP port, listening for packets.
Method __init__ Initialize with a numeric port to listen on.
Method __repr__ Undocumented
Method cb​Read Undocumented
Method connect 'Connect' to remote server.
Method connection​Lost Cleans up my socket.
Method create​Socket Undocumented
Method do​Read Undocumented
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 handle​Read Undocumented
Method log​Prefix Returns the name of my class, to prefix log entries 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 set​Log​Str Initialize the logstr attribute to be used by logPrefix.
Method start​Listening Create and bind my socket, and begin listening on it.
Method stop​Listening Stop listening on this port.
Method write Write a datagram.
Method write​Sequence Write an iterable of byte strings to the physical connection.
Class Variable dynamic​Read​Buffers Undocumented
Instance Variable address​Buffer Undocumented
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 address​Length​Buffer Undocumented
Instance Variable connected Undocumented
Instance Variable d Undocumented
Instance Variable interface Undocumented
Instance Variable logstr Undocumented
Instance Variable port Undocumented
Instance Variable protocol Undocumented
Instance Variable read​Buffer​Size Undocumented
Instance Variable socket Undocumented
Method _bind​Socket Undocumented
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 _real​Port​Number Undocumented

Inherited from FileHandle:

Method data​Received Undocumented
Method do​Write Undocumented
Method get​File​Handle Undocumented
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 read​From​Handle Undocumented
Method resume​Producing Resume producing data.
Method start​Reading Undocumented
Method start​Writing No summary
Method stop​Consuming Stop consuming data.
Method stop​Producing Stop producing data.
Method stop​Reading Undocumented
Method stop​Writing Undocumented
Method write​Connection​Lost Indicates write connection was lost.
Method write​To​Handle Undocumented
Constant SEND​_LIMIT Undocumented
Class Variable disconnecting Undocumented
Class Variable max​Read​Buffers Undocumented
Class Variable write​Buffer​Size 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
Instance Variable reading Undocumented
Instance Variable writing Undocumented
Method _cb​Read Undocumented
Method _cb​Write Undocumented
Method _close​Write​Connection Undocumented
Method _dispatch​Data Dispatch previously read data. Return True if self.reading and we don't have any more data
Method _handle​Read Returns False if we should stop reading for now
Method _handle​Write Returns false if we should stop writing for now
Method _resume​Reading Undocumented
Method _resume​Writing Undocumented
Class Variable _write​Disconnected Undocumented
Instance Variable _read​Buffers Undocumented
Instance Variable _read​Next​Buffer Undocumented
Instance Variable _read​Scheduled Undocumented
Instance Variable _read​Scheduled​In​OS Undocumented
Instance Variable _read​Size Undocumented
Instance Variable _temp​Data​Buffer Undocumented
Instance Variable _temp​Data​Len Undocumented
Instance Variable _write​Disconnecting Undocumented
Instance Variable _write​Scheduled Undocumented

Inherited from _ConsumerMixin (via FileHandle):

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 FileHandle):

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, port, proto, interface='', maxPacketSize=8192, reactor=None): (source)
overrides twisted.internet.iocpreactor.abstract.FileHandle.__init__
overridden in twisted.internet.iocpreactor.udp.MulticastPort
Initialize with a numeric port to listen on.
def __repr__(self): (source)

Undocumented

Returns
strUndocumented
def cbRead(self, rc, data, evt): (source)

Undocumented

def connect(self, host, port): (source)
from twisted.internet.interfaces.IUDPTransport
'Connect' to remote server.
def connectionLost(self, reason=None): (source)
overrides twisted.internet.iocpreactor.abstract.FileHandle.connectionLost
Cleans up my socket.
def createSocket(self): (source)
overridden in twisted.internet.iocpreactor.udp.MulticastPort

Undocumented

def doRead(self): (source)
overrides twisted.internet.iocpreactor.abstract.FileHandle.doRead

Undocumented

def getBroadcastAllowed(self): (source)
from twisted.internet.interfaces.IUDPTransport
Checks if broadcast is currently allowed on this port.
Returns
boolWhether this port may broadcast.
def getHandle(self): (source)
from twisted.internet.interfaces.ISystemHandle
Return a socket object.
def getHost(self): (source)
from twisted.internet.interfaces.IListeningPort
overrides twisted.internet.iocpreactor.abstract.FileHandle.getHost
Return the local address of the UDP connection
Returns
IPv4Address or IPv6Addressthe local address of the UDP connection
def handleRead(self, rc, data, evt): (source)

Undocumented

def logPrefix(self): (source)
from twisted.internet.interfaces.ILoggingContext
overrides twisted.internet.abstract._LogOwner.logPrefix
Returns the name of my class, to prefix log entries with.
def loseConnection(self): (source)
from twisted.internet.interfaces.ITransport
overrides twisted.internet.iocpreactor.abstract.FileHandle.loseConnection

Close the connection at the next available opportunity.

Call this to cause this FileDescriptor to lose its connection. It will first write any data that it has buffered.

If there is data buffered yet to be written, this method will cause the transport to lose its connection as soon as it's done flushing its write buffer. If you have a producer registered, the connection won't be closed until the producer is finished. Therefore, make sure you unregister your producer when it's finished, or the connection will never close.

def setBroadcastAllowed(self, enabled): (source)
from twisted.internet.interfaces.IUDPTransport
Set whether this port may broadcast. This is disabled by default.
Parameters
enabled:boolWhether the port may broadcast.
def setLogStr(self): (source)
Initialize the logstr attribute to be used by logPrefix.
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 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 write(self, datagram, addr=None): (source)
from twisted.internet.interfaces.IUDPTransport
overrides twisted.internet.iocpreactor.abstract.FileHandle.write
Write a datagram.
Parameters
datagramUndocumented
addrshould be a tuple (ip, port), can be None in connected mode.
def writeSequence(self, seq, addr): (source)
from twisted.internet.interfaces.ITransport
overrides twisted.internet.iocpreactor.abstract.FileHandle.writeSequence

Write an iterable of byte strings to the physical connection.

If possible, make sure that all of the data is written to the socket at once, without first copying it all into a single byte string.

Parameters
seqUndocumented
addrUndocumented
dataThe data to write.
dynamicReadBuffers: bool = (source)
overrides twisted.internet.iocpreactor.abstract.FileHandle.dynamicReadBuffers

Undocumented

addressBuffer = (source)

Undocumented

addressFamily = (source)
socket.AF_INET or socket.AF_INET6, depending on whether this port is listening on an IPv4 address or an IPv6 address.
addressLengthBuffer = (source)

Undocumented

connected: bool = (source)
overrides twisted.internet.iocpreactor.abstract.FileHandle.connected

Undocumented

d = (source)

Undocumented

interface = (source)

Undocumented

logstr = (source)
overrides twisted.internet.iocpreactor.abstract.FileHandle.logstr

Undocumented

port = (source)

Undocumented

protocol = (source)

Undocumented

readBufferSize = (source)
overrides twisted.internet.iocpreactor.abstract.FileHandle.readBufferSize

Undocumented

socket = (source)

Undocumented

def _bindSocket(self): (source)

Undocumented

def _connectToProtocol(self): (source)

Undocumented

def _loseConnection(self): (source)

Undocumented

def _setAddressFamily(self): (source)
Resolve address family for the socket.
_connectedAddr = (source)

Undocumented

_realPortNumber = (source)

Undocumented