Expand description
§Bindings to the NetworkExtension framework
See Apple’s docs and the general docs on framework crates for more information.
Structs§
- NEApp
Proxy Flow - The NEAppProxyFlow class is an abstract base class that declares the programmatic interface for a flow of network data.
- NEApp
Proxy Flow Error - Flow error codes
- NEApp
Proxy Provider - The NEAppProxyProvider class declares the programmatic interface for an object that implements the client side of a custom network proxy solution.
- NEApp
Proxy Provider Manager - The NEAppProxyProviderManager class declares the programmatic interface for an object that is used to configure and control network tunnels provided by NEAppProxyProviders.
- NEApp
ProxyTCP Flow - The NEAppProxyTCPFlow class declares the programmatic interface of an object that is used by NEAppProxyProvider implementations to proxy the payload of TCP connections.
- NEApp
ProxyUDP Flow - The NEAppProxyUDPFlow class declares the programmatic interface of an object that is used by NEAppProxyProvider implementations to proxy the payload of UDP datagrams.
- NEApp
Push Manager - The NEAppPushManager class declares a programmatic interface to configure NEAppPushProvider.
- NEApp
Push Manager Error - App Push Manager error codes
- NEApp
Push Provider - The NEAppPushProvider class declares a programmatic interface to manage a life cycle of app push provider. It also allows the provider to handle outgoing communication message from the containing app, and pass incoming call message to the containing app. NEAppPushProvider is part of NetworkExtension.framework
- NEApp
Rule - The NEAppRule class declares the programmatic interface for an object that contains the match conditions for a rule that is used to match network traffic originated by applications.
- NEDNS
OverHTTPS Settings - Apple’s documentation
- NEDNS
OverTLS Settings - Apple’s documentation
- NEDNS
Protocol - DNS protocol variants
- NEDNS
Proxy Manager - The NEDNSProxyManager class declares the programmatic interface for an object that manages DNS proxy configurations.
- NEDNS
Proxy Manager Error - DNS proxy error codes
- NEDNS
Proxy Provider - The NEDNSProxyProvider class declares the programmatic interface for an object that implements the client side of a custom DNS proxy solution.
- NEDNS
Proxy Provider Protocol - The NEDNSProxyProviderProtocol class declares the programmatic interface for an object that contains NEDNSProxyProvider-specific configuration settings.
- NEDNS
Settings - The NEDNSSettings class declares the programmatic interface for an object that contains DNS settings.
- NEDNS
Settings Manager - The NEDNSSettingsManager class declares the programmatic interface for an object that manages DNS settings configurations.
- NEDNS
Settings Manager Error - DNS Settings Manager error codes
- NEEthernet
Tunnel Network Settings - The NEEthernetTunnelNetworkSettings class declares the programmatic interface for an object that contains network settings.
- NEEthernet
Tunnel Provider - The NEEthernetTunnelProvider class declares the programmatic interface of an object that implements the client side of a custom link-layer packet tunneling protocol.
- NEEvaluate
Connection Rule - The NEEvaluateConnectionRule class declares the programmatic interface for an object that associates properties of network connections with an action.
- NEEvaluate
Connection Rule Action - Evaluate Connection rule actions
- NEFilter
Action - A NEFilterAction represents the possible actions taken upon a NEFilterFlow that can be reported by the data provider extension to the control provider extension.
- NEFilter
Browser Flow - The NEFilterBrowserFlow class declares the programmatic interface of an object that represents a flow of network data to be filtered, which is originated from NEFilterSource.
- NEFilter
Control Provider - The NEFilterControlProvider class declares the programmatic interface for an object that is responsible for installing filtering rules on the device.
- NEFilter
Control Verdict - The NEFilterControlVerdict declares the programmatic interface of an object that is the verdict for a new flow of network data by the control provider.
- NEFilter
Data Attribute - Attribute flags describing data
- NEFilter
Data Provider - The NEFilterDataProvider class declares the programmatic interface for an object that evaluates network data flows based on a set of locally-available rules and makes decisions about whether to block or allow the flows.
- NEFilter
Data Verdict - The NEFilterDataVerdict class declares the programmatic interface of an object that is the verdict for a flow of network data after some of the data has been seen by the filter.
- NEFilter
Flow - The NEFilterFlow class declares the programmatic interface of an object that represents a flow of network data to be filtered.
- NEFilter
Manager - The NEFilterManager class declares the programmatic interface for an object that manages content filtering configurations.
- NEFilter
Manager Error - Filter error codes
- NEFilter
Manager Grade - Filter grade
- NEFilter
NewFlow Verdict - The NEFilterNewFlowVerdict declares the programmatic interface of an object that is the verdict for a new flow of network data before any of the flow’s data has been seen by the filter.
- NEFilter
Packet Context - The NEFilterPacketContext class identifies the current filtering context.
- NEFilter
Packet Provider - The NEFilterPacketProvider class declares the programmatic interface for an object that evaluates network packets decisions about whether to block, allow, or delay the packets.
- NEFilter
Packet Provider Verdict - Verdict for a packet
- NEFilter
Provider - The NEFilterProvider class is an abstract base class that declares the programmatic interface of an object that implements a socket filter.
- NEFilter
Provider Configuration - The NEFilterProviderConfiguration class declares the programmatic interface of an object that configures a plugin-based content filter.
- NEFilter
Remediation Verdict - The NEFilterRemediationVerdict class declares the programmatic interface of an object that is the verdict for a flow which has been blocked by the filter, but the user has made a request for remediation.
- NEFilter
Report - The NEFilterReport declares the programmatic interface of an object that is a report of actions taken by the data provider.
- NEFilter
Report Event - A NEFilterReportEvent represents the event that is being reported by the NEFilterReport.
- NEFilter
Report Frequency - A NEFilterReportFrequency controls the frequency of periodic reports.
- NEFilter
Rule - The NEFilterRule class declares the programmatic interface of an object that defines a rule for matching network traffic and the action to take when the rule matches.
- NEFilter
Settings - The NEFilterSettings class declares the programmatic interface for an object that contains filter settings.
- NEFilter
Socket Flow - The NEFilterSocketFlow class declares the programmatic interface of an object that represents a flow of network data to be filtered, which is originated from the socket.
- NEFilter
Verdict - The NEFilterVerdict class declares the programmatic interface for an object that is the verdict for a flow of network data.
- NEFlow
Meta Data - The NEFlowMetaData class declares the programmatic interface for an object that contains extra information about a flow.
- NEHotspot
Configuration - The NEHotspotConfiguration class represents set of properties that are required to configure a Wi-Fi Network.
- NEHotspot
ConfigurationEAPTLS Version - TLS version to use during TLS handshke.
- NEHotspot
ConfigurationEAP Type - EAP Type.
- NEHotspot
Configuration Error - Hotspot Configuration error codes
- NEHotspot
Configuration Manager - The NEHotspotConfigurationManager class allows an application to Add/Update/Remove Wi-Fi Network Configuraton.
- NEHotspot
ConfigurationTTLS Inner Authentication Type - TTLS Inner Authentication Type.
- NEHotspotEAP
Settings - NEHotspotEAPSettings class provides a set of properties that are required to configure a WPA/WPA2 Enterprise or Hotspot 2.0 Wi-Fi networks.
- NEHotspotH
S20Settings - NEHotspotHS20Settings class provides a set of properties that are required to discover and negotiate Hotspot 2.0 Wi-Fi networks.
- NEHotspot
Helper - The NEHotspotHelper class allows an application to register itself as a HotspotHelper.
- NEHotspot
Helper Command - An NEHotspotHelperCommand object is provided to the helper’s command handler block. The HotspotHelper processes the command instantiates an NEHotspotHelperResponse object, sets the annotated network or networkList (Evaluate/FilterScanList only), then delivers it.
- NEHotspot
Helper Command Type - The type of the NEHotspotHelperCommand object.
- NEHotspot
Helper Confidence - The HotspotHelper’s confidence in its ability to handle the network.
- NEHotspot
Helper Response - The HotspotHelper creates an NEHotspotHelperResponse object to provide the results of running the corresponding NEHotspotHelperCommand.
- NEHotspot
Helper Result - The result of processing the NEHotspotHelperCommand.
- NEHotspot
Network - The NEHotspotNetwork class provides a class method to get the SSID and BSSID of the current Wi-Fi network.
- NEHotspot
Network Security Type - Wi-Fi network security type
- NEIPv4
Route - The NEIPv4Route class declares the programmatic interface for an object that contains settings for an IPv4 route.
- NEIPv4
Settings - The NEIPv4Settings class declares the programmatic interface for an object that contains IPv4 settings.
- NEIPv6
Route - The NEIPv6Route class declares the programmatic interface for an object that contains settings for an IPv6 route.
- NEIPv6
Settings - The NEIPv6Settings class declares the programmatic interface for an object that contains IPv6 settings.
- NENetwork
Rule - The NENetworkRule class declares the programmatic interface of an object that contains a specification of a rule that matches the attributes of network traffic.
- NENetwork
Rule Protocol - IP protocols
- NEOn
Demand Rule - The NEOnDemandRule class declares the programmatic interface for an object that defines an On Demand rule.
- NEOn
Demand Rule Action - On Demand rule actions
- NEOn
Demand Rule Connect - The NEOnDemandRuleConnect class declares the programmatic interface for an object that defines an On Demand rule with the “Connect” action.
- NEOn
Demand Rule Disconnect - The NEOnDemandRuleDisconnect class declares the programmatic interface for an object that defines an On Demand rule with the “Disconnect” action.
- NEOn
Demand Rule Evaluate Connection - The NEOnDemandRuleEvaluateConnection class declares the programmatic interface for an object that defines an On Demand rule with the “Evaluate Connection” action.
- NEOn
Demand Rule Ignore - The NEOnDemandRuleIgnore class declares the programmatic interface for an object that defines an On Demand rule with the “Ignore” action.
- NEOn
Demand Rule Interface Type - On Demand rule network interface types
- NEPacket
- An NEPacket object represents the data, protocol family, and metadata associated with an IP packet. These packets are used to read and write on an NEPacketTunnelFlow.
- NEPacket
Tunnel Flow - The NEPacketTunnelFlow class declares the programmatic interface of an object that is used by NEPacketTunnelProvider implementations to tunnel IP packets.
- NEPacket
Tunnel Network Settings - The NEPacketTunnelNetworkSettings class declares the programmatic interface for an object that contains IP network settings.
- NEPacket
Tunnel Provider - The NEPacketTunnelProvider class declares the programmatic interface of an object that implements the client side of a custom IP packet tunneling protocol.
- NEPrivateLTE
Network - The NEPrivateLTENetwork class declares an object that contains the parameters of a private LTE network.
- NEProvider
- The NEProvider class declares the programmatic interface that is common for all Network Extension providers.
- NEProvider
Stop Reason - Provider stop reasons
- NEProxy
Server - The NEProxyServer class declares the programmatic interface for an object that contains settings for a proxy server.
- NEProxy
Settings - The NEProxySettings class declares the programmatic interface for an object that contains proxy settings.
- NERelay
- The NERelay class declares the programmatic interface of an object that manages the details of a relay’s configuration, such as authentication and URL details.
- NERelay
Manager - The NERelayManager class declares the programmatic interface for an object that manages relay configurations.
- NERelay
Manager Client Error - NERelay Manager error codes detected by the client while trying to use this relay
- NERelay
Manager Error - NERelay Manager error codes
- NETraffic
Direction - The direction of network traffic
- NETransparent
Proxy Manager - The NETransparentProxyManager class declares the programmatic interface for an object that is used to configure and control transparent proxies provided by NEAppProxyProviders.
- NETransparent
Proxy Network Settings - The NETransparentProxyNetworkSettings class declares the programmatic interface for an object that contains network settings.
- NETransparent
Proxy Provider - The NETransparentProxyProvider class declares the programmatic interface for an object that implements the client side of a custom transparent network proxy solution. The NETransparentProxyProvider class has the following behavior differences from its super class NEAppProxyProvider:
- NETunnel
Network Settings - The NETunnelNetworkSettings class declares the programmatic interface for an object that contains network settings.
- NETunnel
Provider - The NETunnelProvider class declares the programmatic interface for an object that provides a network tunnel service.
- NETunnel
Provider Error - Tunnel Provider error codes
- NETunnel
Provider Manager - The NETunnelProviderManager class declares the programmatic interface for an object that is used to configure and control network tunnels provided by NETunnelProviders.
- NETunnel
Provider Protocol - The NETunnelProviderProtocol class declares the programmatic interface for an object that contains NETunnelProvider-specific configuration settings.
- NETunnel
Provider Routing Method - Network traffic routing methods.
- NETunnel
Provider Session - This file declares the NETunnelProviderSession API. The NETunnelProviderSession API is used to control network tunnel services provided by NETunnelProvider implementations.
- NEVPN
Connection - The NEVPNConnection class declares the programmatic interface for an object that manages VPN connections.
- NEVPN
Connection Error - VPN error codes
- NEVPN
Error - VPN error codes
- NEVPNIKE
Authentication Method - Internet Key Exchange (IKE) authentication methods used to authenticate with the IPSec server.
- NEVPNIK
Ev2Certificate Type - IKEv2 Certificate types
- NEVPNIK
Ev2Dead Peer Detection Rate - IKEv2 Dead Peer Detection Rates
- NEVPNIK
Ev2Diffie Hellman Group - IKEv2 Diffie Hellman groups
- NEVPNIK
Ev2Encryption Algorithm - IKEv2 Encryption Algorithms
- NEVPNIK
Ev2Integrity Algorithm - IKEv2 Integrity Algorithms
- NEVPNIK
Ev2PPK Configuration - The NEVPNIKEv2PPKConfiguration class declares the programmatic interface of an object that manages parameters for a Post-quantum Pre-shared Key (PPK)
- NEVPNIK
Ev2Security Association Parameters - The NEVPNIKEv2SecurityAssociationParameters class declares the programmatic interface of an object that manages parameters for an IPSec Security Association
- NEVPNIK
Ev2TLS Version - TLS Versions for use in EAP-TLS
- NEVPN
Manager - The NEVPNManager class declares the programmatic interface for an object that manages Virtual Private Network (VPN) configurations.
- NEVPN
Protocol - The NEVPNProtocol class declares the programmatic interface of an object that manages the protocol-specific portion of a VPN configuration.
- NEVPN
ProtocolIK Ev2 - The NEVPNProtocolIKEv2 class declares the programmatic interface of an object that manages the IKEv2-specific portion of a VPN configuration.
- NEVPN
ProtocolIP Sec - The NEVPNProtocolIPSec class declares the programmatic interface of an object that manages the IPSec-specific portion of a VPN configuration.
- NEVPN
Status - VPN status codes
- NWBonjour
Service Endpoint Deprecated - NWBonjourServiceEndpoint is a subclass of NWEndpoint. It represents an endpoint backed by a Bonjour service, specified with a name, type, and domain. For example, the Bonjour service MyMusicStudio._music._tcp.local. has the name “MyMusicStudio”, the type “_music._tcp”, and the domain “local”.
- NWEndpoint
Deprecated - NWEndpoint is a generic class to represent network endpoints, such as a port on a remote server.
- NWHost
Endpoint Deprecated - NWHostEndpoint is a subclass of NWEndpoint. It represents an endpoint backed by a hostname and port. Note that a hostname string may be an IP or IPv6 address.
- NWPath
Deprecated - A network path, represented with NWPath, expresses the viability status and properties of the path that a networking connection will take on the device. For example, if the path status is NWPathStatusSatisfied, then a connection could use that path.
- NWPath
Status Deprecated - Path status values
- NWTCP
Connection Deprecated - Establish TCP connections to an endpoint, and send and receive data on the TCP connection.
- NWTCP
Connection State Deprecated - Defined connection states. New types may be defined in the future.
- NWTLS
Parameters Deprecated - DEPRECATION NOTICE
- NWUDP
Session Deprecated - Open UDP datagram sessions to an endpoint, and send and receive datagrams.
- NWUDP
Session State Deprecated - UDP session state values
Statics§
- NEApp
Proxy ⚠Error Domain - Apple’s documentation
- NEApp
Push ⚠Error Domain - Apple’s documentation
- NEDNS
Proxy ⚠Configuration DidChange Notification - Apple’s documentation
- NEDNS
Proxy ⚠Error Domain - Apple’s documentation
- NEDNS
Settings ⚠Configuration DidChange Notification - Apple’s documentation
- NEDNS
Settings ⚠Error Domain - Apple’s documentation
- NEFilter
Configuration ⚠DidChange Notification - Apple’s documentation
- NEFilter
Error ⚠Domain - Apple’s documentation
- NEHotspot
Configuration ⚠Error Domain - Apple’s documentation
- NERelay
Client ⚠Error Domain - Apple’s documentation
- NERelay
Configuration ⚠DidChange Notification - Apple’s documentation
- NERelay
Error ⚠Domain - Apple’s documentation
- NETunnel
Provider ⚠Error Domain - Apple’s documentation
- NEVPN
Configuration ⚠Change Notification - Apple’s documentation
- NEVPN
Connection ⚠Error Domain - Apple’s documentation
- NEVPN
Connection ⚠Start Option Password - Apple’s documentation
- NEVPN
Connection ⚠Start Option Username - Apple’s documentation
- NEVPN
Error ⚠Domain - Apple’s documentation
- NEVPN
Status ⚠DidChange Notification - Apple’s documentation
Traits§
- NEApp
Push Delegate - Delegate for NEAppPushManager.
- NSMutableURL
RequestNE Hotspot Helper - Category “NEHotspotHelper” on
NSMutableURLRequest. Extend NSMutableURLRequest to include a method to bind the request to the network interface associated with the specified NEHotspotHelperCommand object. - NWTCP
Connection Authentication Delegate Deprecated - Allows the caller to take custom actions on some connection events.
Type Aliases§
- NEHotspot
Helper Handler block2 - The type definition for the HotspotHelper’s command handler block.