Struct NETunnelProviderSession

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

This file declares the NETunnelProviderSession API. The NETunnelProviderSession API is used to control network tunnel services provided by NETunnelProvider implementations.

This API is part of NetworkExtension.framework.

See also Apple’s documentation

Implementations

impl NETunnelProviderSession

pub unsafe fn startTunnelWithOptions_andReturnError( &self, options: Option<&NSDictionary<NSString, AnyObject>>, ) -> Result<(), Retained<NSError>>

This function is used to start the tunnel using the configuration associated with this connection object. The tunnel connection process is started and this function returns immediately.

Parameter options: A dictionary that will be passed as-is to the tunnel provider during the process of starting the tunnel.

Parameter error: If the tunnel was started successfully, this parameter is set to nil. Otherwise this parameter is set to the error that occurred. Possible errors include:

1. NEVPNErrorConfigurationInvalid
2. NEVPNErrorConfigurationDisabled

Returns: YES if the tunnel was started successfully, NO if an error occurred.

pub unsafe fn stopTunnel(&self)

This function is used to stop the tunnel. The tunnel disconnect process is started and this function returns immediately.

pub unsafe fn sendProviderMessage_returnError_responseHandler( &self, message_data: &NSData, error: Option<&mut Option<Retained<NSError>>>, response_handler: Option<&DynBlock<dyn Fn(*mut NSData)>>, ) -> bool

Available on crate feature block2 only.

This function sends a message to the NETunnelProvider and provides a way to receive a response.

Parameter messageData: An NSData object containing the message to be sent.

Parameter error: If the message was sent successfully, this parameter is set to nil. Otherwise this parameter is set to the error that occurred. Possible errors include:

1. NEVPNErrorConfigurationInvalid
2. NEVPNErrorConfigurationDisabled

Parameter responseHandler: A block that handles the response. Can be set to nil if no response is expected.

Returns: YES if the message was sent successfully, NO if an error occurred.

impl NETunnelProviderSession

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = NEVPNConnection>

pub unsafe fn startVPNTunnelAndReturnError( &self, ) -> Result<(), Retained<NSError>>

This function is used to start the VPN tunnel using the current VPN configuration. The VPN tunnel connection process is started and this function returns immediately.

Parameter error: If the VPN tunnel was started successfully, this parameter is set to nil. Otherwise this parameter is set to the error that occurred. Possible errors include:

1. NEVPNErrorConfigurationInvalid
2. NEVPNErrorConfigurationDisabled

Returns: YES if the VPN tunnel was started successfully, NO if an error occurred.

pub unsafe fn startVPNTunnelWithOptions_andReturnError( &self, options: Option<&NSDictionary<NSString, NSObject>>, ) -> Result<(), Retained<NSError>>

This function is used to start the VPN tunnel using the current VPN configuration. The VPN tunnel connection process is started and this function returns immediately.

Parameter options: A dictionary that will be passed to the tunnel provider during the process of starting the tunnel. If not nil, ‘options’ is an NSDictionary may contain the following keys NEVPNConnectionStartOptionUsername NEVPNConnectionStartOptionPassword

Parameter error: If the VPN tunnel was started successfully, this parameter is set to nil. Otherwise this parameter is set to the error that occurred. Possible errors include:

1. NEVPNErrorConfigurationInvalid
2. NEVPNErrorConfigurationDisabled

Returns: YES if the VPN tunnel was started successfully, NO if an error occurred.

pub unsafe fn stopVPNTunnel(&self)

This function is used to stop the VPN tunnel. The VPN tunnel disconnect process is started and this function returns immediately.

pub unsafe fn fetchLastDisconnectErrorWithCompletionHandler( &self, handler: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

Retrive the most recent error that caused the VPN to disconnect. If the error was generated by the VPN system (including the IPsec client) then the error will be in the NEVPNConnectionErrorDomain error domain. If the error was generated by a tunnel provider app extension then the error will be the NSError that the provider passed when disconnecting the tunnel.

Parameter handler: A block which takes an optional NSError that will be called when the error is obtained.

pub unsafe fn status(&self) -> NEVPNStatus

The current status of the VPN.

pub unsafe fn connectedDate(&self) -> Option<Retained<NSDate>>

The date and time when the connection status changed to NEVPNStatusConnected. This property is nil if the connection is not fully established.

pub unsafe fn manager(&self) -> Retained<NEVPNManager>

The NEVPNManager associated with this NEVPNConnection.

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 NETunnelProviderSession

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NETunnelProviderSession> for NETunnelProviderSession

fn as_ref(&self) -> &Self

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

impl AsRef<NEVPNConnection> for NETunnelProviderSession

fn as_ref(&self) -> &NEVPNConnection

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

impl AsRef<NSObject> for NETunnelProviderSession

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NETunnelProviderSession

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NEVPNConnection> for NETunnelProviderSession

fn borrow(&self) -> &NEVPNConnection

Immutably borrows from an owned value.

impl Borrow<NSObject> for NETunnelProviderSession

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NETunnelProviderSession

const NAME: &'static str = "NETunnelProviderSession"

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

type Super = NEVPNConnection

The superclass of this class.

type ThreadKind = <<NETunnelProviderSession 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 NETunnelProviderSession

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

Formats the value using the given formatter.

impl Deref for NETunnelProviderSession

type Target = NEVPNConnection

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NETunnelProviderSession

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 NETunnelProviderSession

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NETunnelProviderSession

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 NETunnelProviderSession

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 NETunnelProviderSession

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

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

impl DowncastTarget for NETunnelProviderSession

impl Eq for NETunnelProviderSession