struct · iOS 12.0+ · SDK 27.1
struct NWPathAn NWPath object represents a snapshot of network path state. This state represents the known information about the local interface and routes that may be used to send and receive data. If the network path for a connection changes due to interface characteristics, addresses, or other attributes, a new NWPath object will be generated. Note that the differences in the path attributes may not be visible through public accessors, and these changes should be treated merely as an indication that something about the network has changed.
get isExpensive(): booleanlet isExpensive: BoolChecks if the path uses an NWInterface that is considered to be expensive Cellular interfaces are considered expensive. WiFi hotspots from an iOS device are considered expensive. Other interfaces may appear as expensive in the future.
get linkQuality(): NWPath_LinkQualityvar linkQuality: NWPath.LinkQuality { get }Represents the link quality measurement of the link layer network attachment Use this value to tune initial values for algorithms that can scale with the capabilities of the network. Do not use this value to gate connection attempts or to override adjustments that would be made based on actual network performance.
get supportsDNS(): booleanlet supportsDNS: Boolget supportsIPv4(): booleanlet supportsIPv4: Boolget supportsIPv6(): booleanlet supportsIPv6: Boolget isConstrained(): booleanvar isConstrained: Bool { get }Checks if the path uses an NWInterface that is considered to be constrained by user preference
get localEndpoint(): (NWEndpoint) | nulllet localEndpoint: NWEndpoint?Check the local endpoint set on a path. This will be nil for paths from an NWPathMonitor. For paths from an NWConnection, this will be set to the local address and port in use by the connection.
get remoteEndpoint(): (NWEndpoint) | nulllet remoteEndpoint: NWEndpoint?Check the remote endpoint set on a path. This will be nil for paths from an NWPathMonitor. For paths from an NWConnection, this will be set to the remote address and port in use by the connection.
get debugDescription(): stringvar debugDescription: String { get }A textual representation of this instance, suitable for debugging. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(reflecting:)` initializer. This initializer works with any type, and uses the custom `debugDescription` property for types that conform to `CustomDebugStringConvertible`: struct Point: CustomDebugStringConvertible { let x: Int, y: Int var debugDescription: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(reflecting: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `debugDescription` property.
get unsatisfiedReason(): NWPath_UnsatisfiedReasonvar unsatisfiedReason: NWPath.UnsatisfiedReason { get }usesInterfaceType(type: NWInterface_InterfaceType): booleanfunc usesInterfaceType(_ type: NWInterface.InterfaceType) -> BoolChecks if the path uses an NWInterface with the specified type
get isUltraConstrained(): booleanvar isUltraConstrained: Bool { get }Checks if the path uses an NWInterface that is considered to be constrained by user preference
get availableInterfaces(): Array<NWInterface>let availableInterfaces: [NWInterface]A list of all interfaces currently available to this path
get status(): NWPath_Statuslet status: NWPath.Statusget gateways(): Array<NWEndpoint>var gateways: [NWEndpoint] { get }A list of IP addresses of routers acting as gateways for the path.
No declarations were skipped in this snapshot.