twisted.internet.udp.Port : API documentation

Parameters	datagram	The datagram to be sent. (type: `str`)
	addr	A tuple of (stringified dotted-quad IP address, integer port number); can be `None` in connected mode. (type: `tuple` containing `str` as first element and `int` as second element, or `None`)

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

from twisted.internet.interfaces.ITransport

overrides twisted.internet.abstract.FileDescriptor.writeSequence

Reliably write a sequence of data.

Currently, this is a convenience method roughly equivalent to:

   for chunk in iovec:
       fd.write(chunk)

It may have a more efficient implementation at a later time or in a different reactor.

As with the write() method, if a buffer size limit is reached and a streaming producer is registered, it will be paused until the buffered data is written to the underlying file descriptor.

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)

from twisted.internet.interfaces.ITransport

overrides twisted.internet.abstract.FileDescriptor.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 connectionLost(self, reason=None): (source)

from twisted.internet.interfaces.IFileDescriptor

overrides twisted.internet.abstract.FileDescriptor.connectionLost

overridden in twisted.internet.unix.DatagramPort

Cleans up my socket.

def setLogStr(self): (source)

overridden in twisted.internet.unix.DatagramPort

Initialize the logstr attribute to be used by logPrefix.

def logPrefix(self): (source)

from twisted.internet.interfaces.ILoggingContext

overrides twisted.internet.abstract._LogOwner.logPrefix

Return the prefix to log with.

def getHost(self): (source)

from twisted.internet.interfaces.IListeningPort

Returns an IPv4Address.

This indicates the address from which I am connecting.

Method	createInternetSocket	Undocumented
Method	doWrite	Raises a RuntimeError

Method	writeSomeData	Write as much as possible of the given data, immediately.
Method	writeConnectionLost	Indicates write connection was lost.
Method	readConnectionLost	Indicates read connection was lost.
Method	loseWriteConnection	Undocumented
Method	stopReading	Stop waiting for read availability.
Method	stopWriting	Stop waiting for write availability.
Method	startReading	Start waiting for read availability.
Method	startWriting	Start waiting for write availability.
Method	stopConsuming	Stop consuming data.
Method	resumeProducing	Resume producing data.
Method	pauseProducing	Pause producing data.
Method	stopProducing	Stop producing data.
Method	fileno	File Descriptor number for select().
Method	_postLoseConnection	Called after a loseConnection(), when all data has been written.
Method	_closeWriteConnection	Undocumented
Method	_isSendBufferFull	Determine whether the user-space send buffer for this transport is full or not.
Method	_maybePauseProducer	Possibly pause a producer, if there is one and the send buffer is full.

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` or `int`)
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.

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	doRead	Called when my socket is ready for reading.
Method	write	Write a datagram.
Method	writeSequence	Reliably write a sequence of data.
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	Return the prefix to log with.
Method	getHost	Returns an IPv4Address.
Method	_bindSocket	Undocumented
Method	_connectToProtocol	Undocumented
Method	_loseConnection	Undocumented

t.i.u.Port(base.BasePort) : class documentation