Struct NEEthernetTunnelNetworkSettings

Source

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

Expand description

The NEEthernetTunnelNetworkSettings class declares the programmatic interface for an object that contains network settings.

NEEthernetTunnelNetworkSettings is used by NEEthernetTunnelProviders to communicate the desired network settings for the packet tunnel to the framework. The framework takes care of applying the contained settings to the system.

Instances of this class are thread safe.

Implementations§

Source §

impl NEEthernetTunnelNetworkSettings

Source

pub unsafe fn initWithTunnelRemoteAddress_ethernetAddress_mtu( this: Allocated<Self>, address: &NSString, ethernet_address: &NSString, mtu: NSInteger, ) -> Retained<Self>

This function initializes a newly-allocated NEEthernetTunnelNetworkSettings object with a given tunnel remote address and MAC address.

Parameter address: The address of the remote endpoint that is providing the tunnel service.

Parameter ethernetAddress: The ethernet address to be assigned to the tunnel interface. This string should be in the format “xx:xx:xx:xx:xx:xx”, where each xx is a hexidecimal number between 0 and ff.

Parameter mtu: The MTU (Maxium Transmission Unit) in bytes to be assigned to the tunnel interface.

Source

pub unsafe fn ethernetAddress(&self) -> Retained<NSString>

An NSString object containing the ethernet address of the tunnel interface.

Source §

impl NEEthernetTunnelNetworkSettings

Methods declared on superclass NETunnelNetworkSettings.

Source

pub unsafe fn initWithTunnelRemoteAddress( this: Allocated<Self>, address: &NSString, ) -> Retained<Self>

This function initializes a newly-allocated NETunnelNetworkSettings object with a given tunnel remote address.

Parameter address: The address of the remote endpoint that is providing the tunnel service.

Source §

impl NEEthernetTunnelNetworkSettings

Methods declared on superclass NSObject.

Source

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

Source

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

Methods from Deref<Target = NEPacketTunnelNetworkSettings>§

Source

pub unsafe fn IPv4Settings(&self) -> Option<Retained<NEIPv4Settings>>

An NEIPv4Settings object that contains the desired tunnel IPv4 settings.

Source

pub unsafe fn setIPv4Settings(&self, i_pv4_settings: Option<&NEIPv4Settings>)

Setter for IPv4Settings.

Source

pub unsafe fn IPv6Settings(&self) -> Option<Retained<NEIPv6Settings>>

An NEIPv6Settings object that contains the desired tunnel IPv6 settings.

Source

pub unsafe fn setIPv6Settings(&self, i_pv6_settings: Option<&NEIPv6Settings>)

Setter for IPv6Settings.

Source

pub unsafe fn tunnelOverheadBytes(&self) -> Option<Retained<NSNumber>>

An NSNumber object containing the number of bytes of overhead appended to each outbound packet through the tunnel. The MTU for the TUN interface is computed by subtracting this value from the MTU of the primary physical interface.

Source

pub unsafe fn setTunnelOverheadBytes( &self, tunnel_overhead_bytes: Option<&NSNumber>, )

Setter for tunnelOverheadBytes.

Source

pub unsafe fn MTU(&self) -> Option<Retained<NSNumber>>

An NSNumber object containing the Maximum Transmission Unit (MTU) size in bytes to assign to the TUN interface. If this property is set, the tunnelOverheadBytes property is ignored.

Source

pub unsafe fn setMTU(&self, mtu: Option<&NSNumber>)

Setter for MTU.

Methods from Deref<Target = NETunnelNetworkSettings>§

Source

pub unsafe fn tunnelRemoteAddress(&self) -> Retained<NSString>

A string containing the IP address of the remote endpoint that is providing the tunnel service.

Source

pub unsafe fn DNSSettings(&self) -> Option<Retained<NEDNSSettings>>

An NEDNSSettings object that contains the desired tunnel DNS settings.

Source

pub unsafe fn setDNSSettings(&self, dns_settings: Option<&NEDNSSettings>)

Setter for DNSSettings.

Source

pub unsafe fn proxySettings(&self) -> Option<Retained<NEProxySettings>>

An NEProxySettings object that contains the desired tunnel proxy settings.

Source

pub unsafe fn setProxySettings(&self, proxy_settings: Option<&NEProxySettings>)

Setter for proxySettings.

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}