Struct system_configuration::network_reachability::SCNetworkReachability

pub struct SCNetworkReachability(_);

A network address or host for which the connectivity can be determined.

See SCNetworkReachability for details.

Implementations

impl SCNetworkReachability

pub fn from_addr_pair(
    local: SocketAddr,
    remote: SocketAddr
) -> SCNetworkReachability

Construct a SCNetworkReachability struct with a local and a remote socket address.

See SCNetworkReachabilityCreateWithAddressPair for details.

pub fn from_host(host: &CStr) -> Option<Self>

Construct a Reachability from either a hostname or a network node

See SCNetworkReachabilityCreateWithName for details.

pub fn reachability(&self) -> Result<ReachabilityFlags, ReachabilityError>

Return a flag indicating whether the specified network address is reachable.

See SCNetworkReachabilityGetFlags for details.

pub fn schedule_with_runloop(
    &self,
    run_loop: &CFRunLoop,
    run_loop_mode: CFStringRef
) -> Result<(), SchedulingError>

Schedule callback with runloop.

See SCNetworkReachabilityScheduleFromRunLoop for details.

pub fn unschedule_from_runloop(
    &self,
    run_loop: &CFRunLoop,
    run_loop_mode: CFStringRef
) -> Result<(), UnschedulingError>

Unschedule from run loop.

See SCNetworkReachabilityUnscheduleFromRunLoop for details.

pub fn set_callback<F: Fn(ReachabilityFlags) + Sync + Send>(
    &mut self,
    callback: F
) -> Result<(), SetCallbackError>

Sets callback that is run whenever network connectivity changes. For the callback to be invoked, the SCNetworkReachability has to be registered on a run loop. Calling this function multiple times will clear the subsequently set callback.

See SCNetworkReachabilityContext for details.

Trait Implementations

impl Clone for SCNetworkReachability

fn clone(&self) -> SCNetworkReachability

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConcreteCFType for SCNetworkReachability

impl Drop for SCNetworkReachability

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for SCNetworkReachability

impl From<SocketAddr> for SCNetworkReachability

fn from(addr: SocketAddr) -> Self

Performs the conversion.

impl PartialEq<SCNetworkReachability> for SCNetworkReachability

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl TCFType for SCNetworkReachability

type Ref = SCNetworkReachabilityRef

The reference type wrapped inside this type.

fn as_concrete_TypeRef(&self) -> SCNetworkReachabilityRef

Returns the object as its concrete TypeRef.

unsafe fn wrap_under_get_rule(reference: SCNetworkReachabilityRef) -> Self

Returns an instance of the object, wrapping the underlying CFTypeRef subclass. Use this when following Core Foundation's "Get Rule". The reference count is bumped.

fn as_CFTypeRef(&self) -> CFTypeRef

Returns the object as a raw CFTypeRef. The reference count is not adjusted.

unsafe fn wrap_under_create_rule(reference: SCNetworkReachabilityRef) -> Self

Returns an instance of the object, wrapping the underlying CFTypeRef subclass. Use this when following Core Foundation's "Create Rule". The reference count is not bumped.

fn type_id() -> CFTypeID

Returns the type ID for this class.

fn as_CFType(&self) -> CFType

Returns the object as a wrapped CFType. The reference count is incremented by one.

fn into_CFType(self) -> CFType

Returns the object as a wrapped CFType. Consumes self and avoids changing the reference count.

fn retain_count(&self) -> isize

Returns the reference count of the object. It is unwise to do anything other than test whether the return value of this method is greater than zero.

fn type_of(&self) -> usize

Returns the type ID of this object.

fn show(&self)

Writes a debugging version of this object on standard error.

fn instance_of<OtherCFType>(&self) -> bool where
    OtherCFType: TCFType, 

Returns true if this value is an instance of another type.

impl<'a> ToVoid<SCNetworkReachability> for &'a SCNetworkReachability

fn to_void(&self) -> *const c_void

impl ToVoid<SCNetworkReachability> for SCNetworkReachability

fn to_void(&self) -> *const c_void

impl ToVoid<SCNetworkReachability> for SCNetworkReachabilityRef

fn to_void(&self) -> *const c_void