twisted.internet.iocpreactor.udp.MulticastPort(MulticastMixin, Port) class documentationtwisted.internet.iocpreactor.udp
View Source
(View In Hierarchy)
Implements interfaces: twisted.internet.interfaces.IMulticastTransport
UDP Port that supports multicasting.
| Method | __init__ | Initialize with a numeric port to listen on. |
| Method | createSocket | Undocumented |
Inherited from MulticastMixin:
| Method | getOutgoingInterface | Undocumented |
| Method | setOutgoingInterface | Returns Deferred of success. |
| Method | getLoopbackMode | Undocumented |
| Method | setLoopbackMode | Undocumented |
| Method | getTTL | Undocumented |
| Method | setTTL | Undocumented |
| Method | joinGroup | Join a multicast group. Returns Deferred of success. |
| Method | leaveGroup | Leave multicast group, return Deferred of success. |
| Method | _setInterface | Undocumented |
| Method | _joinAddr1 | Undocumented |
| Method | _joinAddr2 | Undocumented |
Inherited from Port:
| 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 | __repr__ | Undocumented |
| Method | getHandle | Return a socket object. |
| Method | startListening | Create and bind my socket, and begin listening on it. |
| 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. |
| 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 (via Port):
| 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 | Stop producing data. |
| 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 Port, 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 Port, FileHandle):
| Method | _getLogPrefix | Determine the log prefix to use for messages related to
applicationObject, which may or may not be an interfaces.ILoggingContext
provider. |
Initialize with a numeric port to listen on.