1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftNIO open source project
//
// Copyright (c) 2017-2018 Apple Inc. and the SwiftNIO project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftNIO project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
/// A `MulticastChannel` is a `Channel` that supports IP multicast operations: that is, a channel that can join multicast
/// groups.
///
/// - note: As with `Channel`, all operations on a `MulticastChannel` are thread-safe.
public protocol MulticastChannel: Channel {
/// Request that the `MulticastChannel` join the multicast group given by `group`.
///
/// - parameters:
/// - group: The IP address corresponding to the relevant multicast group.
/// - promise: The `EventLoopPromise` that will be notified once the operation is complete, or
/// `nil` if you are not interested in the result of the operation.
func joinGroup(_ group: SocketAddress, promise: EventLoopPromise<Void>?)
#if !os(Windows)
/// Request that the `MulticastChannel` join the multicast group given by `group` on the interface
/// given by `interface`.
///
/// - parameters:
/// - group: The IP address corresponding to the relevant multicast group.
/// - interface: The interface on which to join the given group, or `nil` to allow the kernel to choose.
/// - promise: The `EventLoopPromise` that will be notified once the operation is complete, or
/// `nil` if you are not interested in the result of the operation.
@available(*, deprecated, renamed: "joinGroup(_:device:promise:)")
func joinGroup(_ group: SocketAddress, interface: NIONetworkInterface?, promise: EventLoopPromise<Void>?)
#endif
/// Request that the `MulticastChannel` join the multicast group given by `group` on the device
/// given by `device`.
///
/// - parameters:
/// - group: The IP address corresponding to the relevant multicast group.
/// - device: The device on which to join the given group, or `nil` to allow the kernel to choose.
/// - promise: The `EventLoopPromise` that will be notified once the operation is complete, or
/// `nil` if you are not interested in the result of the operation.
func joinGroup(_ group: SocketAddress, device: NIONetworkDevice?, promise: EventLoopPromise<Void>?)
/// Request that the `MulticastChannel` leave the multicast group given by `group`.
///
/// - parameters:
/// - group: The IP address corresponding to the relevant multicast group.
/// - promise: The `EventLoopPromise` that will be notified once the operation is complete, or
/// `nil` if you are not interested in the result of the operation.
func leaveGroup(_ group: SocketAddress, promise: EventLoopPromise<Void>?)
#if !os(Windows)
/// Request that the `MulticastChannel` leave the multicast group given by `group` on the interface
/// given by `interface`.
///
/// - parameters:
/// - group: The IP address corresponding to the relevant multicast group.
/// - interface: The interface on which to leave the given group, or `nil` to allow the kernel to choose.
/// - promise: The `EventLoopPromise` that will be notified once the operation is complete, or
/// `nil` if you are not interested in the result of the operation.
@available(*, deprecated, renamed: "leaveGroup(_:device:promise:)")
func leaveGroup(_ group: SocketAddress, interface: NIONetworkInterface?, promise: EventLoopPromise<Void>?)
#endif
/// Request that the `MulticastChannel` leave the multicast group given by `group` on the device
/// given by `device`.
///
/// - parameters:
/// - group: The IP address corresponding to the relevant multicast group.
/// - device: The device on which to leave the given group, or `nil` to allow the kernel to choose.
/// - promise: The `EventLoopPromise` that will be notified once the operation is complete, or
/// `nil` if you are not interested in the result of the operation.
func leaveGroup(_ group: SocketAddress, device: NIONetworkDevice?, promise: EventLoopPromise<Void>?)
}
// MARK:- Default implementations for MulticastChannel
extension MulticastChannel {
public func joinGroup(_ group: SocketAddress, promise: EventLoopPromise<Void>?) {
self.joinGroup(group, device: nil, promise: promise)
}
public func joinGroup(_ group: SocketAddress) -> EventLoopFuture<Void> {
let promise = self.eventLoop.makePromise(of: Void.self)
self.joinGroup(group, promise: promise)
return promise.futureResult
}
#if !os(Windows)
@available(*, deprecated, renamed: "joinGroup(_:device:)")
public func joinGroup(_ group: SocketAddress, interface: NIONetworkInterface?) -> EventLoopFuture<Void> {
let promise = self.eventLoop.makePromise(of: Void.self)
self.joinGroup(group, interface: interface, promise: promise)
return promise.futureResult
}
#endif
public func joinGroup(_ group: SocketAddress, device: NIONetworkDevice?) -> EventLoopFuture<Void> {
let promise = self.eventLoop.makePromise(of: Void.self)
self.joinGroup(group, device: device, promise: promise)
return promise.futureResult
}
public func leaveGroup(_ group: SocketAddress, promise: EventLoopPromise<Void>?) {
self.leaveGroup(group, device: nil, promise: promise)
}
public func leaveGroup(_ group: SocketAddress) -> EventLoopFuture<Void> {
let promise = self.eventLoop.makePromise(of: Void.self)
self.leaveGroup(group, promise: promise)
return promise.futureResult
}
#if !os(Windows)
@available(*, deprecated, renamed: "leaveGroup(_:device:)")
public func leaveGroup(_ group: SocketAddress, interface: NIONetworkInterface?) -> EventLoopFuture<Void> {
let promise = self.eventLoop.makePromise(of: Void.self)
self.leaveGroup(group, interface: interface, promise: promise)
return promise.futureResult
}
#endif
public func leaveGroup(_ group: SocketAddress, device: NIONetworkDevice?) -> EventLoopFuture<Void> {
let promise = self.eventLoop.makePromise(of: Void.self)
self.leaveGroup(group, device: device, promise: promise)
return promise.futureResult
}
}
// MARK:- API Compatibility shims for MulticastChannel
extension MulticastChannel {
/// Request that the `MulticastChannel` join the multicast group given by `group` on the device
/// given by `device`.
///
/// - parameters:
/// - group: The IP address corresponding to the relevant multicast group.
/// - device: The device on which to join the given group, or `nil` to allow the kernel to choose.
/// - promise: The `EventLoopPromise` that will be notified once the operation is complete, or
/// `nil` if you are not interested in the result of the operation.
public func joinGroup(_ group: SocketAddress, device: NIONetworkDevice?, promise: EventLoopPromise<Void>?) {
// We just fail this in the default implementation. Users should override it.
promise?.fail(NIOMulticastNotImplementedError())
}
/// Request that the `MulticastChannel` leave the multicast group given by `group` on the device
/// given by `device`.
///
/// - parameters:
/// - group: The IP address corresponding to the relevant multicast group.
/// - device: The device on which to leave the given group, or `nil` to allow the kernel to choose.
/// - promise: The `EventLoopPromise` that will be notified once the operation is complete, or
/// `nil` if you are not interested in the result of the operation.
public func leaveGroup(_ group: SocketAddress, device: NIONetworkDevice?, promise: EventLoopPromise<Void>?) {
// We just fail this in the default implementation. Users should override it.
promise?.fail(NIOMulticastNotImplementedError())
}
}
|
