Package twisted :: Package internet :: Module udp :: Class Port
[show private | hide private]
[frames | no frames]

Class Port

    Logger --+    
             |    
FileDescriptor --+
                 |
                Port

Known Subclasses:
ConnectedPort, MulticastPort

UDP port, listening for packets.
Method Summary
  __init__(self, reactor, port, protocol, interface, maxPacketSize)
Initialize with a numeric port to listen on.
  __getstate__(self)
(internal) get my state for persistence
  __repr__(self)
  connectionLost(self, reason)
Cleans up my socket.
  createInternetSocket(self)
(internal) create an AF_INET/SOCK_DGRAM socket.
  doRead(self)
Called when my socket is ready for reading.
  doWrite(self)
Raises an AssertionError.
  fileno(self)
File Descriptor number for select(). (inherited from FileDescriptor)
  getHost(self)
Returns a tuple of ('INET_UDP', hostname, port), indicating the servers address
  log(self, bytes)
(inherited from Logger)
  logPrefix(self)
Returns the name of my class, to prefix log entries with.
  loseConnection(self)
Stop accepting connections on this port.
  pauseProducing(self)
(inherited from FileDescriptor)
  registerProducer(self, producer, streaming)
Register to receive data from a producer. (inherited from FileDescriptor)
  resumeProducing(self)
(inherited from FileDescriptor)
  setLogStr(self)
  startListening(self)
Create and bind my socket, and begin listening on it.
  startReading(self)
Start waiting for read availability. (inherited from FileDescriptor)
  startWriting(self)
Start waiting for write availability. (inherited from FileDescriptor)
  stopConsuming(self)
Stop consuming data. (inherited from FileDescriptor)
  stopListening(self)
Stop accepting connections on this port.
  stopProducing(self)
(inherited from FileDescriptor)
  stopReading(self)
Stop waiting for read availability. (inherited from FileDescriptor)
  stopWriting(self)
Stop waiting for write availability. (inherited from FileDescriptor)
  unregisterProducer(self)
Stop consuming data from a producer, without disconnecting. (inherited from FileDescriptor)
  write(self, datagram, (host,
Write a datagram.
  writeSequence(self, seq, addr)
  writeSomeData(self, data)
Write as much as possible of the given data, immediately. (inherited from FileDescriptor)

Class Variable Summary
tuple __implements__

Method Details

__init__(self, reactor, port, protocol, interface='', maxPacketSize=8192)
(Constructor)

Initialize with a numeric port to listen on.
Overrides:
twisted.internet.abstract.FileDescriptor.__init__

__getstate__(self)

(internal) get my state for persistence

connectionLost(self, reason=None)

Cleans up my socket.
Overrides:
twisted.internet.abstract.FileDescriptor.connectionLost

createInternetSocket(self)

(internal) create an AF_INET/SOCK_DGRAM socket.

doRead(self)

Called when my socket is ready for reading.

doWrite(self)

Raises an AssertionError.
Overrides:
twisted.internet.abstract.FileDescriptor.doWrite

getHost(self)

Returns a tuple of ('INET_UDP', hostname, port), indicating the servers address

logPrefix(self)

Returns the name of my class, to prefix log entries with.
Overrides:
twisted.python.log.Logger.logPrefix

loseConnection(self)

Stop accepting connections on this port.

This will shut down my socket and call self.connectionLost().
Overrides:
twisted.internet.abstract.FileDescriptor.loseConnection

startListening(self)

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.

stopListening(self)

Stop accepting connections on this port.

This will shut down my socket and call self.connectionLost().
Overrides:
twisted.internet.abstract.FileDescriptor.loseConnection

write(self, datagram, (host,

Write a datagram.
Overrides:
twisted.internet.abstract.FileDescriptor.write

Class Variable Details

__implements__

Type:
tuple
Value:
((<class twisted.internet.interfaces.IProducer at 0x10260b40>,
  <class twisted.internet.interfaces.IReadWriteDescriptor at 0x1028f0d\
8>,
  <class twisted.internet.interfaces.IConsumer at 0x101ad5b0>,
  <class twisted.internet.interfaces.ITransport at 0x1027ddc8>),
 <class twisted.internet.interfaces.IUDPTransport at 0x1022ec40>)      

Generated by Epydoc 1.2 prerelease on Wed Jan 29 06:25:42 2003 http://epydoc.sf.net