Skip to content

Commit 5d3eb19

Browse files
committed
Update comments
1 parent d9d0a73 commit 5d3eb19

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

Sources/OSCKit/UDP/Server/OSCUDPServer.swift

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ public final class OSCUDPServer {
4141
/// multiple processes to simultaneously bind to the same address & port, you need to enable
4242
/// this functionality in the socket. All processes that wish to use the address & port
4343
/// simultaneously must all enable reuse port on the socket bound to that port.
44+
///
45+
/// Due to limitations of `SO_REUSEPORT` on Apple platforms, enabling this only permits receipt of broadcast
46+
/// or multicast messages for any additional sockets which bind to the same address and port. Unicast
47+
/// messages are only received by the first socket to bind.
4448
public var isPortReuseEnabled: Bool = false
4549

4650
/// Returns a boolean indicating whether the OSC server has been started.
@@ -59,7 +63,7 @@ public final class OSCUDPServer {
5963
/// - port: Local port to listen on for inbound OSC packets.
6064
/// If `nil` or `0`, a random available port in the system will be chosen.
6165
/// - interface: Optionally specify a network interface for which to constrain communication.
62-
/// - isPortReuseEnabled: Enable local UDP port reuse by other processes.
66+
/// - isPortReuseEnabled: Enable local UDP port reuse by other processes to receive broadcast packets.
6367
/// - timeTagMode: OSC TimeTag mode. (Default is recommended.)
6468
/// - queue: Optionally supply a custom dispatch queue for receiving OSC packets and dispatching the
6569
/// handler callback closure. If `nil`, a dedicated internal background queue will be used.

0 commit comments

Comments
 (0)