Platforms to show: All Mac Windows Linux Cross-Platform
NWPathMBS class
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| class | Network | MBS MacOSX Plugin | 24.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
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 path 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.
This is an abstract class. You can't create an instance, but you can get one from various plugin functions.
- 10 properties
- property EffectiveLocalEndPoint as NWEndPointMBS
- property EffectiveRemoteEndPoint as NWEndPointMBS
- property Handle as Integer
- property HasDNS as Boolean
- property HasIPv4 as Boolean
- property HasIPv6 as Boolean
- property IsConstrained as Boolean
- property IsExpensive as Boolean
- property Status as Integer
- property UnsatisfiedReason as Integer
- 5 methods
- method Constructor Private
- method Gateways as NWEndPointMBS()
- method Interfaces as NWInterfaceMBS()
- method IsEqual(other as NWPathMBS) as Boolean
- method UsesInterfaceType(InterfaceType as Integer) as Boolean
- 9 constants
Status
| Constant | Value | Description |
|---|---|---|
| kStatusInvalid | 0 |
The path is not valid |
| kStatusSatisfiable | 3 |
The path does not currently have a usable route, but a connection attempt will trigger network attachment. |
| kStatusSatisfied | 1 |
The path has a usable route upon which to send and receive data. |
| kStatusUnsatisfied | 2 |
The path does not have a usable route. This may be due to a network interface being down, or due to system policy. |
Unsatisfied Reason
| Constant | Value | Description |
|---|---|---|
| kUnsatisfiedReasonCellularDenied | 1 |
The user has disabled cellular |
| kUnsatisfiedReasonLocalNetworkDenied | 3 |
The user has disabled local network access |
| kUnsatisfiedReasonNotAvailable | 0 |
No reason is given |
| kUnsatisfiedReasonVPNInactive | 4 |
A required VPN is not active |
| kUnsatisfiedReasonWifiDenied | 2 |
The user has disabled Wi-Fi |
This class has no sub classes.
Blog Entries
Release notes
- Version 24.1
- Added NWPathMBS, NWEndPointMBS and NWInterfaceMBS classes.
Some properties using for this class:
- NWPathMonitorMBS.Current as NWPathMBS
Some events using this class:
- NWPathMonitorMBS.Update(path as NWPathMBS)
Some examples using this class:
Some related classes:
The items on this page are in the following plugins: MBS MacOSX Plugin.
NWInterfaceMBS - NWPathMonitorMBS
