class documentation

class twisted.internet.iocpreactor.udp.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.

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
Method cbRead Undocumented
Method handleRead Undocumented
Method doRead Undocumented
Method write Write a datagram.
Method writeSequence Write an iterable of byte strings to the physical connection.
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 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

Inherited from FileHandle:

Class Variable maxReadBuffers Undocumented
Instance Variable reading Undocumented
Method startReading Undocumented
Method stopReading Undocumented
Method readFromHandle Undocumented
Method dataReceived Undocumented
Method readConnectionLost Indicates read connection was lost.
Instance Variable dataBuffer Undocumented
Instance Variable offset Undocumented
Instance Variable writing Undocumented
Class Variable writeBufferSize Undocumented
Method loseWriteConnection Undocumented
Method writeConnectionLost Indicates write connection was lost.
Method startWriting No summary
Method stopWriting Undocumented
Instance Variable producerPaused Undocumented
Method doWrite Undocumented
Method writeToHandle Undocumented
Instance Variable disconnected Undocumented
Instance Variable disconnecting Undocumented
Class Variable SEND_LIMIT Undocumented
Instance Variable reactor Undocumented
Instance Variable producer Undocumented
Method getFileHandle Undocumented
Method stopConsuming Stop consuming data.
Method resumeProducing Resume producing data.
Method pauseProducing Pause producing data.
Method stopProducing Stop producing data.
Method getPeer Get the remote address of this connection.
Instance Variable _readNextBuffer Undocumented
Instance Variable _readSize Undocumented
Instance Variable _readScheduled Undocumented
Instance Variable _readScheduledInOS Undocumented
Method _resumeReading Undocumented
Method _dispatchData Dispatch previously read data. Return True if self.reading and we don't have any more data
Method _cbRead Undocumented
Method _handleRead Returns False if we should stop reading for now
Instance Variable _writeScheduled Undocumented
Instance Variable _writeDisconnecting Undocumented
Instance Variable _writeDisconnected Undocumented
Method _closeWriteConnection Undocumented
Method _resumeWriting Undocumented
Method _cbWrite Undocumented
Method _handleWrite Returns false if we should stop writing for now
Instance Variable _tempDataBuffer Undocumented
Instance Variable _tempDataLen Undocumented
Instance Variable _readBuffers Undocumented

Inherited from _ConsumerMixin (via FileHandle):

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

Method _getLogPrefix Determine the log prefix to use for messages related to applicationObject, which may or may not be an interfaces.ILoggingContext provider.
addressFamily = (source)
socket.AF_INET or socket.AF_INET6, depending on whether this port is listening on an IPv4 address or an IPv6 address.
_realPortNumber = (source)

Undocumented

def __init__(self, port, proto, interface='', maxPacketSize=8192, reactor=None): (source)

Initialize with a numeric port to listen on.

port = (source)

Undocumented

protocol = (source)

Undocumented

interface = (source)

Undocumented

_connectedAddr = (source)

Undocumented

addressBuffer = (source)

Undocumented

addressLengthBuffer = (source)

Undocumented

def _setAddressFamily(self): (source)

Resolve address family for the socket.

def __repr__(self): (source)

Undocumented

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

Return a socket object.

def startListening(self): (source)

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)
def _bindSocket(self): (source)

Undocumented

socket = (source)

Undocumented

def _connectToProtocol(self): (source)

Undocumented

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

Undocumented

def handleRead(self, rc, data, evt): (source)

Undocumented

def write(self, datagram, addr=None): (source)

Write a datagram.

ParametersdatagramUndocumented
addrshould be a tuple (ip, port), can be None in connected mode.
def writeSequence(self, seq, addr): (source)

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.

ParametersseqUndocumented
addrUndocumented
dataThe data to write.
def connect(self, host, port): (source)

'Connect' to remote server.

def _loseConnection(self): (source)

Undocumented

def stopListening(self): (source)

Stop listening on this port.

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

Undocumented

def loseConnection(self): (source)

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 connectionLost(self, reason=None): (source)
def setLogStr(self): (source)

Initialize the logstr attribute to be used by logPrefix.

def logPrefix(self): (source)

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

def getHost(self): (source)

Return the local address of the UDP connection

Returnsthe local address of the UDP connection (type: IPv4Address or IPv6Address)
def setBroadcastAllowed(self, enabled): (source)

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

ParametersenabledWhether the port may broadcast. (type: bool)
def getBroadcastAllowed(self): (source)

Checks if broadcast is currently allowed on this port.

ReturnsWhether this port may broadcast. (type: bool)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.