Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`internet`.`iocpreactor`.`udp`.`MulticastPort``

class documentation

`class MulticastPort(MulticastMixin, Port): (source)`

Implements interfaces: `twisted.internet.interfaces.IMulticastTransport`

View In Hierarchy

UDP Port that supports multicasting.

Method | `__init__` | Initialize with a numeric port to listen on.
Method | `createSocket` | Undocumented
Instance Variable | `listenMultiple` | Undocumented

Inherited from `MulticastMixin`:

Method | `getLoopbackMode` | Undocumented
Method | `getOutgoingInterface` | Undocumented
Method | `getTTL` | Undocumented
Method | `joinGroup` | Join a multicast group. Returns Deferred of success.
Method | `leaveGroup` | Leave multicast group, return Deferred of success.
Method | `setLoopbackMode` | Undocumented
Method | `setOutgoingInterface` | Returns Deferred of success.
Method | `setTTL` | Undocumented
Method | `_joinAddr1` | Undocumented
Method | `_joinAddr2` | Undocumented
Method | `_setInterface` | Undocumented

Inherited from `Port` (via `MulticastMixin`):

Method | `__repr__` | Undocumented
Method | `cbRead` | Undocumented
Method | `connect` | 'Connect' to remote server.
Method | `connectionLost` | Cleans up my socket.
Method | `doRead` | Undocumented
Method | `getBroadcastAllowed` | Checks if broadcast is currently allowed on this port.
Method | `getHandle` | Return a socket object.
Method | `getHost` | Return the local address of the UDP connection
Method | `handleRead` | Undocumented
Method | `logPrefix` | Returns the name of my class, to prefix log entries with.
Method | `loseConnection` | Close the connection at the next available opportunity.
Method | `setBroadcastAllowed` | Set whether this port may broadcast. This is disabled by default.
Method | `setLogStr` | Initialize the `logstr` attribute to be used by `logPrefix`.
Method | `startListening` | Create and bind my socket, and begin listening on it.
Method | `stopListening` | Stop listening on this port.
Method | `write` | Write a datagram.
Method | `writeSequence` | Write an iterable of byte strings to the physical connection.
Class Variable | `dynamicReadBuffers` | Undocumented
Instance Variable | `addressBuffer` | Undocumented
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.
Instance Variable | `addressLengthBuffer` | Undocumented
Instance Variable | `connected` | Undocumented
Instance Variable | `d` | Undocumented
Instance Variable | `interface` | Undocumented
Instance Variable | `logstr` | Undocumented
Instance Variable | `port` | Undocumented
Instance Variable | `protocol` | Undocumented
Instance Variable | `readBufferSize` | Undocumented
Instance Variable | `socket` | Undocumented
Method | `_bindSocket` | Undocumented
Method | `_connectToProtocol` | Undocumented
Method | `_loseConnection` | Undocumented
Method | `_setAddressFamily` | Resolve address family for the socket.
Instance Variable | `_connectedAddr` | Undocumented
Instance Variable | `_realPortNumber` | Undocumented

Inherited from `FileHandle` (via `MulticastMixin`, `Port`):

Method | `dataReceived` | Undocumented
Method | `doWrite` | Undocumented
Method | `getFileHandle` | Undocumented
Method | `getPeer` | Get the remote address of this connection.
Method | `loseWriteConnection` | Undocumented
Method | `pauseProducing` | Pause producing data.
Method | `readConnectionLost` | Indicates read connection was lost.
Method | `readFromHandle` | Undocumented
Method | `resumeProducing` | Resume producing data.
Method | `startReading` | Undocumented
Method | `startWriting` | Override in a subclass to cause the reactor to monitor this selectable for write events. This will be called once in `unregisterProducer` if `loseConnection` has previously been called, so that the connection can actually close.
Method | `stopConsuming` | Stop consuming data.
Method | `stopProducing` | Stop producing data.
Method | `stopReading` | Undocumented
Method | `stopWriting` | Undocumented
Method | `writeConnectionLost` | Indicates write connection was lost.
Method | `writeToHandle` | Undocumented
Constant | `SEND_LIMIT` | Undocumented
Class Variable | `disconnecting` | Undocumented
Class Variable | `maxReadBuffers` | Undocumented
Class Variable | `writeBufferSize` | Undocumented
Instance Variable | `dataBuffer` | Undocumented
Instance Variable | `disconnected` | Undocumented
Instance Variable | `offset` | Undocumented
Instance Variable | `producer` | Undocumented
Instance Variable | `producerPaused` | Undocumented
Instance Variable | `reactor` | Undocumented
Instance Variable | `reading` | Undocumented
Instance Variable | `writing` | Undocumented
Method | `_cbRead` | Undocumented
Method | `_cbWrite` | Undocumented
Method | `_closeWriteConnection` | Undocumented
Method | `_dispatchData` | Dispatch previously read data. Return True if self.reading and we don't have any more data
Method | `_handleRead` | Returns False if we should stop reading for now
Method | `_handleWrite` | Returns false if we should stop writing for now
Method | `_resumeReading` | Undocumented
Method | `_resumeWriting` | Undocumented
Class Variable | `_writeDisconnected` | Undocumented
Instance Variable | `_readBuffers` | Undocumented
Instance Variable | `_readNextBuffer` | Undocumented
Instance Variable | `_readScheduled` | Undocumented
Instance Variable | `_readScheduledInOS` | Undocumented
Instance Variable | `_readSize` | Undocumented
Instance Variable | `_tempDataBuffer` | Undocumented
Instance Variable | `_tempDataLen` | Undocumented
Instance Variable | `_writeDisconnecting` | Undocumented
Instance Variable | `_writeScheduled` | Undocumented

Inherited from `_ConsumerMixin` (via `MulticastMixin`, `Port`, `FileHandle`):

Method | `registerProducer` | Register to receive data from a producer.
Method | `unregisterProducer` | Stop consuming data from a producer, without disconnecting.
Instance Variable | `streamingProducer` | `bool` or `int`

Inherited from `_LogOwner` (via `MulticastMixin`, `Port`, `FileHandle`, `_ConsumerMixin`):

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, listenMultiple=False): (source)
overrides `twisted.internet.iocpreactor.udp.Port.__init__`

Initialize with a numeric port to listen on.

def createSocket(self): (source)
overrides `twisted.internet.iocpreactor.udp.Port.createSocket`

Undocumented

listenMultiple = (source)

Undocumented