One Logo Pool Ball
Network · IOS API REFERENCE

NWMulticastGroup

class · iOS 14.0+ · SDK 27.1

class NWMulticastGroup

A `NWMulticastGroup` is a specific type of `NWGroupDescriptor` that can be used to create an `NWConnectionGroup` that joins multicast groups.

Members (4)

get · iOS 14.0+

sourceFilter

TypeScript
get sourceFilter(): (NWEndpoint) | null
Swift declaration
final let sourceFilter: NWEndpoint?

A source filter to use for Source-Specific Multicast.

get · iOS 14.0+

isUnicastDisabled

TypeScript
get isUnicastDisabled(): boolean
Swift declaration
final let isUnicastDisabled: Bool

A boolean to indicate whether or not unicast traffic sent to the local port should be allowed.

init · iOS 14.0+

init

TypeScript
static init(groupAddresses: Array<NWEndpoint>, from?: (NWEndpoint) | null, disableUnicast?: boolean): NWMulticastGroup
Swift declaration
init(for groupAddresses: [NWEndpoint], from: NWEndpoint? = nil, disableUnicast: Bool = false) throws

Create a `NWMulticastGroup` with an array of IP address endpoints containing multicast groups to join. The port specified in the endpoints will be used as the local port to join. Optionally specify a source address to filter communication from, and whether or not to allow unicast traffic. `disableUnicast` defaults to false.

get · iOS 14.0+

members

TypeScript
get members(): Array<NWEndpoint>
Swift declaration
var members: [NWEndpoint] { get }

An array of IP address endpoints containing the multicast group addresses that will be joined.

Skipped declarations

No declarations were skipped in this snapshot.

All Network types →