Struct NEPacketTunnelProvider

#[repr(C)]
pub struct NEPacketTunnelProvider { /* private fields */ }

The NEPacketTunnelProvider class declares the programmatic interface of an object that implements the client side of a custom IP packet tunneling protocol.

NEPacketTunnelProvider is part of NetworkExtension.framework.

See also Apple’s documentation

Implementations

impl NEPacketTunnelProvider

pub unsafe fn startTunnelWithOptions_completionHandler( &self, options: Option<&NSDictionary<NSString, NSObject>>, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

This function is called by the framework when a new tunnel is being created. Subclasses must override this method to perform whatever steps are necessary to establish the tunnel.

Parameter options: A dictionary containing keys and values passed by the provider’s containing app. If the containing app did not start the tunnel then this parameter will be nil.

Parameter completionHandler: A block that must be called when the process of starting the tunnel is complete. If the tunnel cannot be established then the subclass’ implementation of this method must pass a non-nil NSError object to this block. A value of nil passed to the completion handler indicates that the tunnel was successfully established.

pub unsafe fn stopTunnelWithReason_completionHandler( &self, reason: NEProviderStopReason, completion_handler: &DynBlock<dyn Fn()>, )

Available on crate feature block2 only.

This function is called by the framework when the tunnel is being destroyed. Subclasses must override this method to perform whatever steps are necessary to tear down the tunnel.

Parameter reason: An NEProviderStopReason indicating why the tunnel is being stopped.

Parameter completionHandler: A block that must be called when the tunnel is completely torn down.

pub unsafe fn cancelTunnelWithError(&self, error: Option<&NSError>)

This function is called by tunnel provider implementations to initiate tunnel destruction when a network error is encountered that renders the tunnel no longer viable. Subclasses should not override this method.

Parameter error: An NSError object containing details about the error that the tunnel provider implementation encountered.

pub unsafe fn packetFlow(&self) -> Retained<NEPacketTunnelFlow>

An NEPacketFlow object that the tunnel provider implementation should use to receive packets from the network stack and inject packets into the network stack. Every time the tunnel is started the packet flow object is in an initialized state and must be explicitly opened before any packets can be received or injected.

pub unsafe fn createTCPConnectionThroughTunnelToEndpoint_enableTLS_TLSParameters_delegate( &self, remote_endpoint: &NWEndpoint, enable_tls: bool, tls_parameters: Option<&NWTLSParameters>, delegate: Option<&AnyObject>, ) -> Retained<NWTCPConnection>

👎Deprecated: Use the virtualInterface property with nw_parameters_require_interface

This function can be called by subclass implementations to create a TCP connection to a given network endpoint, through the tunnel established by the provider. This function should not be overridden by subclasses.

Parameter remoteEndpoint: An NWEndpoint object that specifies the remote network endpoint to connect to.

Parameter enableTLS: A flag indicating if a TLS session should be negotiated on the connection.

Parameter TLSParameters: A set of optional TLS parameters. Only valid if enableTLS is YES. If TLSParameters is nil, the default system parameters will be used for TLS negotiation.

Parameter delegate: An object to use as the connection delegate. This object should conform to the NWTCPConnectionAuthenticationDelegate protocol.

Returns: An NWTCPConnection object.

pub unsafe fn createUDPSessionThroughTunnelToEndpoint_fromEndpoint( &self, remote_endpoint: &NWEndpoint, local_endpoint: Option<&NWHostEndpoint>, ) -> Retained<NWUDPSession>

👎Deprecated: Use the virtualInterface property with nw_parameters_require_interface

This function can be called by subclass implementations to create a UDP session between a local network endpoint and a remote network endpoint, through the tunnel established by the provider. This function should not be overridden by subclasses.

Parameter remoteEndpoint: An NWEndpoint object that specifies the remote endpoint to which UDP datagrams will be sent by the UDP session.

Parameter localEndpoint: An NWHostEndpoint object that specifies the local IP address endpoint to use as the source endpoint of the UDP session.

Returns: An NWUDPSession object.

impl NEPacketTunnelProvider

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NETunnelProvider>

pub unsafe fn handleAppMessage_completionHandler( &self, message_data: &NSData, completion_handler: Option<&DynBlock<dyn Fn(*mut NSData)>>, )

Available on crate feature block2 only.

This function is called by the framework when the container app sends a message to the provider. Subclasses should override this method to handle the message and optionally send a response.

Parameter messageData: An NSData object containing the message sent by the container app.

Parameter completionHandler: A block that the method can execute to send a response to the container app. If this parameter is non-nil then the method implementation should always execute the block. If this parameter is nil then the method implementation should treat this as an indication that the container app is not expecting a response.

pub unsafe fn setTunnelNetworkSettings_completionHandler( &self, tunnel_network_settings: Option<&NETunnelNetworkSettings>, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

This function is called by tunnel provider implementations to set the network settings of the tunnel, including IP routes, DNS servers, and virtual interface addresses depending on the tunnel type. Subclasses should not override this method. This method can be called multiple times during the lifetime of a particular tunnel. It is not necessary to call this function with nil to clear out the existing settings before calling this function with a non-nil configuration.

Parameter tunnelNetworkSettings: An NETunnelNetworkSettings object containing all of the desired network settings for the tunnel. Pass nil to clear out the current network settings.

Parameter completionHandler: A block that will be called by the framework when the process of setting or clearing the network settings is complete. If an error occurred during the process of setting or clearing the IP network settings then a non-nill NSError object will be passed to this block containing error details.

pub unsafe fn protocolConfiguration(&self) -> Retained<NEVPNProtocol>

An NEVPNProtocol object containing the provider’s current configuration. The value of this property may change during the lifetime of the tunnel provided by this NETunnelProvider, KVO can be used to detect when changes occur. For different protocol types, this property will contain the corresponding subclass. For NEVPNProtocolTypePlugin protocol type, this property will contain the NETunnelProviderProtocol subclass. For NEVPNProtocolTypeIKEv2 protocol type, this property will contain the NEVPNProtocolIKEv2 subclass.

pub unsafe fn appRules(&self) -> Option<Retained<NSArray<NEAppRule>>>

An array of NEAppRule objects specifying which applications are currently being routed through the tunnel provided by this NETunnelProvider. If application-based routing is not enabled for the tunnel, then this property is set to nil.

pub unsafe fn routingMethod(&self) -> NETunnelProviderRoutingMethod

The method by which network traffic is routed to the tunnel. The default is NETunnelProviderRoutingMethodDestinationIP.

pub unsafe fn reasserting(&self) -> bool

A flag that indicates to the framework if this NETunnelProvider is currently re-establishing the tunnel. Setting this flag will cause the session status visible to the user to change to “Reasserting”. Clearing this flag will change the user-visible status of the session back to “Connected”. Setting and clearing this flag only has an effect if the session is in the “Connected” state.

pub unsafe fn setReasserting(&self, reasserting: bool)

Setter for reasserting.

Methods from Deref<Target = NEProvider>

pub unsafe fn sleepWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn()>, )

Available on crate feature block2 only.

This function is called by the framework when the system is about to go to sleep. Subclass developers can override this method to implement custom behavior such as closing connections or pausing some network activity.

Parameter completionHandler: When the method is finished handling the sleep event it must execute this completion handler.

pub unsafe fn wake(&self)

This function is called by the framework immediately after the system wakes up from sleep. Subclass developers can override this method to implement custom behavior such as re-establishing connections or resuming some network activity.

pub unsafe fn createTCPConnectionToEndpoint_enableTLS_TLSParameters_delegate( &self, remote_endpoint: &NWEndpoint, enable_tls: bool, tls_parameters: Option<&NWTLSParameters>, delegate: Option<&AnyObject>, ) -> Retained<NWTCPConnection>

👎Deprecated: Use nw_connection_t in Network framework instead

This function can be called by subclass implementations to create a TCP connection to a given network endpoint. This function should not be overridden by subclasses.

Parameter remoteEndpoint: An NWEndpoint object that specifies the remote network endpoint to connect to.

Parameter enableTLS: A flag indicating if a TLS session should be negotiated on the connection.

Parameter TLSParameters: A set of optional TLS parameters. Only valid if enableTLS is YES. If TLSParameters is nil, the default system parameters will be used for TLS negotiation.

Parameter delegate: An object to use as the connections delegate. This object should conform to the NWTCPConnectionAuthenticationDelegate protocol.

Returns: An NWTCPConnection object.

pub unsafe fn createUDPSessionToEndpoint_fromEndpoint( &self, remote_endpoint: &NWEndpoint, local_endpoint: Option<&NWHostEndpoint>, ) -> Retained<NWUDPSession>

👎Deprecated: Use nw_connection_t in Network framework instead

This function can be called by subclass implementations to create a UDP session between a local network endpoint and a remote network endpoint. This function should not be overridden by subclasses.

Parameter remoteEndpoint: An NWEndpoint object that specifies the remote endpoint to which UDP datagrams will be sent by the UDP session.

Parameter localEndpoint: An NWHostEndpoint object that specifies the local IP address endpoint to use as the source endpoint of the UDP session.

Returns: An NWUDPSession object.

pub unsafe fn displayMessage_completionHandler( &self, message: &NSString, completion_handler: &DynBlock<dyn Fn(Bool)>, )

👎Deprecated

Available on crate feature block2 only.

This method can be called by subclass implementations to display a message to the user.

Parameter message: The message to be displayed.

Parameter completionHandler: A block that is executed when the user acknowledges the message. If this method is called on a NEFilterDataProvider instance or the message cannot be displayed, then the completion handler block will be executed immediately with success parameter set to NO. If the message was successfully displayed to the user, then the completion handler block is executed with the success parameter set to YES when the user dismisses the message.

pub unsafe fn defaultPath(&self) -> Option<Retained<NWPath>>

👎Deprecated: Use nw_path_monitor_t in Network framework instead

The current default path for connections created by the provider. Use KVO to watch for network changes.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for NEPacketTunnelProvider

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NEPacketTunnelProvider> for NEEthernetTunnelProvider

fn as_ref(&self) -> &NEPacketTunnelProvider

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NEPacketTunnelProvider> for NEPacketTunnelProvider

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NEProvider> for NEPacketTunnelProvider

fn as_ref(&self) -> &NEProvider

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NETunnelProvider> for NEPacketTunnelProvider

fn as_ref(&self) -> &NETunnelProvider

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for NEPacketTunnelProvider

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for NEPacketTunnelProvider

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NEPacketTunnelProvider> for NEEthernetTunnelProvider

fn borrow(&self) -> &NEPacketTunnelProvider

Immutably borrows from an owned value.

impl Borrow<NEProvider> for NEPacketTunnelProvider

fn borrow(&self) -> &NEProvider

Immutably borrows from an owned value.

impl Borrow<NETunnelProvider> for NEPacketTunnelProvider

fn borrow(&self) -> &NETunnelProvider

Immutably borrows from an owned value.

impl Borrow<NSObject> for NEPacketTunnelProvider

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NEPacketTunnelProvider

const NAME: &'static str = "NEPacketTunnelProvider"

The name of the Objective-C class that this type represents.

type Super = NETunnelProvider

The superclass of this class.

type ThreadKind = <<NEPacketTunnelProvider as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for NEPacketTunnelProvider

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for NEPacketTunnelProvider

type Target = NETunnelProvider

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for NEPacketTunnelProvider

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for NEPacketTunnelProvider

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NEPacketTunnelProvider

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for NEPacketTunnelProvider

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for NEPacketTunnelProvider

const ENCODING_REF: Encoding = <NETunnelProvider as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for NEPacketTunnelProvider

impl Eq for NEPacketTunnelProvider