Struct SCNetworkService

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

Available on crate feature SCNetworkConfiguration only.

This is the type of a reference to an object that represents a network service.

See also Apple’s documentation

Implementations

impl SCNetworkService

pub fn add_protocol_type( self: &SCNetworkService, protocol_type: &CFString, ) -> bool

Adds a network protocol of the specified type to the service. The protocol configuration is set to default values that are appropriate for the interface associated with the service.

Parameter service: The network service.

Parameter protocolType: The type of SCNetworkProtocol to be added to the service.

Returns: TRUE if the protocol was added to the service; FALSE if the protocol was already present or an error was encountered.

pub fn all(prefs: &SCPreferences) -> Option<CFRetained<CFArray>>

Available on crate feature SCPreferences only.

Returns all available network services for the specified preferences.

Parameter prefs: The “preferences” session.

Returns: The list of SCNetworkService services associated with the preferences. You must release the returned value.

pub fn protocols(self: &SCNetworkService) -> Option<CFRetained<CFArray>>

Returns all network protocols associated with the service.

Parameter service: The network service.

Returns: The list of SCNetworkProtocol protocols associated with the service. You must release the returned value.

pub fn new( prefs: &SCPreferences, interface: &SCNetworkInterface, ) -> Option<CFRetained<SCNetworkService>>

Available on crate feature SCPreferences only.

Create a new network service for the specified interface in the configuration.

Parameter prefs: The “preferences” session.

Returns: A reference to the new SCNetworkService. You must release the returned value.

pub fn copy( prefs: &SCPreferences, service_id: &CFString, ) -> Option<CFRetained<SCNetworkService>>

Available on crate feature SCPreferences only.

Returns the network service with the specified identifier.

Parameter prefs: The “preferences” session.

Parameter serviceID: The unique identifier for the service.

Returns: A reference to the SCNetworkService from the associated preferences; NULL if the serviceID does not exist in the preferences or if an error was encountered. You must release the returned value.

pub fn establish_default_configuration(self: &SCNetworkService) -> bool

Establishes the “default” configuration for a network service. This configuration includes the addition of network protocols for the service (with “default” configuration options).

Parameter service: The network service.

Returns: TRUE if the configuration was updated; FALSE if an error was encountered.

pub fn enabled(self: &SCNetworkService) -> bool

Returns whether this service has been enabled.

Parameter service: The network service.

Returns: TRUE if the service is enabled.

pub fn interface( self: &SCNetworkService, ) -> Option<CFRetained<SCNetworkInterface>>

Returns the network interface associated with the service.

Parameter service: The network service.

Returns: A reference to the SCNetworkInterface associated with the service; NULL if an error was encountered.

pub fn name(self: &SCNetworkService) -> Option<CFRetained<CFString>>

Returns the [user specified] name associated with the service.

Parameter service: The network service.

Returns: The [user specified] name.

pub fn protocol( self: &SCNetworkService, protocol_type: &CFString, ) -> Option<CFRetained<SCNetworkProtocol>>

Returns the network protocol of the specified type for the service.

Parameter service: The network service.

Returns: A reference to the SCNetworkProtocol associated with the service; NULL if this protocol has not been added or if an error was encountered. You must release the returned value.

pub fn service_id(self: &SCNetworkService) -> Option<CFRetained<CFString>>

Returns the identifier for the service.

Parameter service: The network service.

Returns: The service identifier.

pub fn remove(self: &SCNetworkService) -> bool

Removes the network service from the configuration.

Parameter service: The network service.

Returns: TRUE if the service was removed; FALSE if an error was encountered.

pub fn remove_protocol_type( self: &SCNetworkService, protocol_type: &CFString, ) -> bool

Removes the network protocol of the specified type from the service.

Parameter service: The network service.

Parameter protocolType: The type of SCNetworkProtocol to be removed from the service.

Returns: TRUE if the protocol was removed to the service; FALSE if the protocol was not configured or an error was encountered.

pub fn set_enabled(self: &SCNetworkService, enabled: bool) -> bool

Enables or disables the service.

Parameter service: The network service.

Parameter enabled: TRUE if the service should be enabled.

Returns: TRUE if the enabled status was saved; FALSE if an error was encountered.

pub fn set_name(self: &SCNetworkService, name: Option<&CFString>) -> bool

Stores the [user specified] name for the service.

Parameter service: The network service.

Parameter name: The [user defined] name to associate with the service.

Returns: TRUE if the name was saved; FALSE if an error was encountered.

Note: although not technically required, the [user specified] names for all services within any given set should be unique. As such, an error will be returned if you attemp to name two services with the same string.

Methods from Deref<Target = CFType>

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

where T: ConcreteType,

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

pub fn retain_count(&self) -> usize

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations

impl AsRef<AnyObject> for SCNetworkService

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for SCNetworkService

fn as_ref(&self) -> &CFType

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

impl AsRef<SCNetworkService> for SCNetworkService

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SCNetworkService

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for SCNetworkService

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for SCNetworkService

fn type_id() -> CFTypeID

Returns the type identifier of all SCNetworkService instances.

impl Debug for SCNetworkService

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

Formats the value using the given formatter.

impl Deref for SCNetworkService

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SCNetworkService

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 SCNetworkService

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for SCNetworkService

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 SCNetworkService

const ENCODING_REF: Encoding

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

impl Type for SCNetworkService

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

where Self: Sized,

Increment the reference count of the receiver.

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated: this is redundant

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::retain

Helper for easier transition from the core-foundation crate.

fn as_CFTypeRef(&self) -> &CFType

where Self: AsRef<CFType>,

👎Deprecated: this is redundant (CF types deref to CFType)

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::from_raw

Helper for easier transition from the core-foundation crate.

impl Eq for SCNetworkService