twisted.internet.udp.MulticastPort(MulticastMixin, Port) class documentationtwisted.internet.udp
View Source
(View In Hierarchy)
Implements interfaces: twisted.internet.interfaces.IMulticastTransport
UDP Port that supports multicasting.
| Method | __init__ | |
| Method | createInternetSocket | 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 | maxThroughput | Maximum number of bytes read in one event loop iteration. |
| 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 | doRead | Called when my socket is ready for reading. |
| Method | write | Write a datagram. |
| Method | writeSequence | Write a datagram constructed from an iterable of bytes. |
| 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 | 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. |
| Instance Variable | _realPortNumber | Actual port number being listened on. The value will be None
until this Port
is listening. |
| Instance Variable | _preexistingSocket | If not None,
a socket.socket
instance which was created and initialized outside of the reactor and will
be used to listen for connections (instead of a new socket being created by
this Port). |
| Class Method | _fromListeningDescriptor | Create a new Port based on an
existing listening SOCK_DGRAM socket. |
| Method | _bindSocket | Prepare and assign a socket.socket
instance to self.socket. |
| Method | _connectToProtocol | Undocumented |
| Method | _loseConnection | Undocumented |
| Method | _setAddressFamily | Resolve address family for the socket. |
Inherited from BasePort (via Port):
| Method | doWrite | Raises a RuntimeError |
Inherited from FileDescriptor (via Port, 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 | 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. |
Inherited from _ConsumerMixin (via Port, 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) |
| 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, 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. |