twisted.internet.iocpreactor.udp.Port : API documentation

t.i.i.u.Port(abstract.FileHandle) : class documentation

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.
Method	__init__	Initialize with a numeric port to listen on.
Method	__repr__	Undocumented
Method	getHandle	Return a socket object.
Method	startListening	Create and bind my socket, and begin listening on it.
Method	createSocket	Undocumented
Method	cbRead	Undocumented
Method	handleRead	Undocumented
Method	doRead	Undocumented
Method	write	Write a datagram.
Method	writeSequence	Write a list of strings to the physical connection.
Method	connect	'Connect' to remote server.
Method	stopListening	Stop listening on this port.
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`.
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.
Method	_setAddressFamily	Resolve address family for the socket.
Method	_bindSocket	Undocumented
Method	_connectToProtocol	Undocumented
Method	_loseConnection	Undocumented

Inherited from FileHandle:

Method	startReading	Undocumented
Method	stopReading	Undocumented
Method	readFromHandle	Undocumented
Method	dataReceived	Undocumented
Method	readConnectionLost	Indicates read connection was lost.
Method	loseWriteConnection	Undocumented
Method	writeConnectionLost	Indicates write connection was lost.
Method	startWriting	No summary
Method	stopWriting	Undocumented
Method	doWrite	Undocumented
Method	writeToHandle	Undocumented
Method	getFileHandle	Undocumented
Method	stopConsuming	Stop consuming data.
Method	resumeProducing	Resume producing data.
Method	pauseProducing	Pause producing data.
Method	stopProducing	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
Method	_closeWriteConnection	Undocumented
Method	_resumeWriting	Undocumented
Method	_cbWrite	Undocumented
Method	_handleWrite	Returns false if we should stop writing for now

Inherited from _ConsumerMixin (via FileHandle):

Instance Variable	producer	`None` if no producer is registered, otherwise the registered producer.
Instance Variable	producerPaused	A flag indicating whether the producer is currently paused. (type: `bool`)
Instance Variable	streamingProducer 0	A flag indicating whether the producer was registered as a streaming (ie push) producer or not (ie a pull producer). This will determine whether the consumer may ever need to pause and resume it, or if it can merely call `resumeProducing` on it when buffer space is available.
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 =

socket.AF_INET or socket.AF_INET6, depending on whether this port is listening on an IPv4 address or an IPv6 address.

def _setAddressFamily(self): (source)

Resolve address family for the socket.

def __repr__(self): (source)

Undocumented

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

Undocumented

def _connectToProtocol(self): (source)

Undocumented

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

Undocumented

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

Undocumented

def writeSequence(self, seq, addr): (source)

from twisted.internet.interfaces.ITransport

overrides twisted.internet.iocpreactor.abstract.FileHandle.writeSequence

Write a list of 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 string.

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)

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

Initialize the logstr attribute to be used by logPrefix.

def logPrefix(self): (source)

overrides twisted.internet.abstract._LogOwner.logPrefix

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

Returns the 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.

Parameters enabled Whether the port may broadcast. (type: bool)

def getBroadcastAllowed(self): (source)

from twisted.internet.interfaces.IUDPTransport

Checks if broadcast is currently allowed on this port.

Returns Whether this port may broadcast. (type: bool)