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

Part of twisted.internet.udp View Source View In Hierarchy

Known subclasses: twisted.internet.udp.MulticastPort, twisted.internet.unix.DatagramPort

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

UDP port, listening for packets.
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

Inherited from BasePort:

Method createInternetSocket Undocumented
Method doWrite Raises a RuntimeError

Inherited from FileDescriptor (via BasePort):

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 Undocumented
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.

Inherited from _ConsumerMixin (via BasePort, FileDescriptor):

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.

Inherited from _LogOwner (via BasePort, FileDescriptor):

Method _getLogPrefix 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)
Initialize with a numeric port to listen on.
def __repr__(self): (source)
Undocumented
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 _bindSocket(self): (source)
Undocumented
def _connectToProtocol(self): (source)
Undocumented
def doRead(self): (source)
Called when my socket is ready for reading.
def write(self, datagram, addr=None): (source)
Write a datagram.
ParametersdatagramThe datagram to be sent. (type: str)
addrA 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)
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)
'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.

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)
Cleans up my socket.
def setLogStr(self): (source)
Initialize the logstr attribute to be used by logPrefix.
def logPrefix(self): (source)
Return the prefix to log with.
def getHost(self): (source)
Returns an IPv4Address.

This indicates the address from which I am connecting.

API Documentation for Twisted, generated by pydoctor at 2012-09-01 11:44:56.