106 lines
4.5 KiB
Swift
106 lines
4.5 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the SwiftNIO open source project
|
|
//
|
|
// Copyright (c) 2017-2021 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#if canImport(Network)
|
|
import Network
|
|
import NIOCore
|
|
|
|
/// A tag protocol that can be used to cover all network events emitted by `NIOTS`.
|
|
///
|
|
/// Users are strongly encouraged not to conform their own types to this protocol.
|
|
@available(OSX 10.14, iOS 12.0, tvOS 12.0, watchOS 6.0, *)
|
|
public protocol NIOTSNetworkEvent: Equatable { }
|
|
|
|
@available(OSX 10.14, iOS 12.0, tvOS 12.0, watchOS 6.0, *)
|
|
public enum NIOTSNetworkEvents {
|
|
/// This event is fired whenever the OS has informed NIO that there is a better
|
|
/// path available to the endpoint that this `Channel` is currently connected to,
|
|
/// e.g. the current connection is using an expensive cellular connection and
|
|
/// a cheaper WiFi connection has become available.
|
|
///
|
|
/// If you can handle this event, you should make a new connection attempt, and then
|
|
/// transfer your work to that connection before closing this one.
|
|
public struct BetterPathAvailable: NIOTSNetworkEvent {
|
|
/// Create a new `BetterPathAvailable` event.
|
|
public init(){ }
|
|
}
|
|
|
|
/// This event is fired when the OS has informed NIO that no better path to the
|
|
/// to the remote endpoint than the one currently being used by this `Channel` is
|
|
/// currently available.
|
|
public struct BetterPathUnavailable: NIOTSNetworkEvent {
|
|
/// Create a new `BetterPathUnavailable` event.
|
|
public init(){ }
|
|
}
|
|
|
|
/// This event is fired whenever the OS has informed NIO that a new path is in use
|
|
/// for this `Channel`.
|
|
public struct PathChanged: NIOTSNetworkEvent {
|
|
/// The new path for this `Channel`.
|
|
public let newPath: NWPath
|
|
|
|
/// Create a new `PathChanged` event.
|
|
public init(newPath: NWPath) {
|
|
self.newPath = newPath
|
|
}
|
|
}
|
|
|
|
/// This event is fired as an outbound event when NIO would like to ask Network.framework
|
|
/// to handle the connection logic (e.g. its own DNS resolution and happy eyeballs racing).
|
|
/// This is temporary workaround until NIO 2.0 which should allow us to use the regular
|
|
/// `Channel.connect` method instead.
|
|
public struct ConnectToNWEndpoint: NIOTSNetworkEvent {
|
|
/// The endpoint to which we want to connect.
|
|
public let endpoint: NWEndpoint
|
|
|
|
/// Create a new `ConnectToNWEndpoint` event.
|
|
public init(endpoint: NWEndpoint) {
|
|
self.endpoint = endpoint
|
|
}
|
|
}
|
|
|
|
/// This event is fired as an outbound event when NIO would like to ask Network.framework
|
|
/// to handle the binding logic (e.g. its own support for bonjour and interface selection).
|
|
/// This is temporary workaround until NIO 2.0 which should allow us to use the regular
|
|
/// `Channel.bind` method instead.
|
|
public struct BindToNWEndpoint: NIOTSNetworkEvent {
|
|
/// The endpoint to which we want to bind.
|
|
public let endpoint: NWEndpoint
|
|
|
|
/// Create a new `BindToNWEndpoint` event.
|
|
public init(endpoint: NWEndpoint) {
|
|
self.endpoint = endpoint
|
|
}
|
|
}
|
|
|
|
/// This event is fired when when the OS has informed NIO that it cannot immediately connect
|
|
/// to the remote endpoint, but that it is possible that changes in network conditions may
|
|
/// allow connection in future. This can occur in cases where the route is not currently
|
|
/// satisfiable (e.g. because airplane mode is on, or because the app is forbidden from using cellular)
|
|
/// but where a change in network state may allow the connection.
|
|
public struct WaitingForConnectivity: NIOTSNetworkEvent {
|
|
/// The reason the connection couldn't be established at this time.
|
|
///
|
|
/// Note that these reasons are _not fatal_: applications are strongly advised not to treat them
|
|
/// as fatal, and instead to use them as information to inform UI decisions.
|
|
public var transientError: NWError
|
|
|
|
/// Create a new `WaitingForConnectivity` event.
|
|
public init(transientError: NWError) {
|
|
self.transientError = transientError
|
|
}
|
|
}
|
|
}
|
|
#endif
|