Struct CFSocket 

pub struct CFSocket { /* private fields */ }

Available on crate feature CFSocket only.

Apple’s documentation

Implementations

impl CFSocket

pub unsafe fn new( allocator: Option<&CFAllocator>, protocol_family: i32, socket_type: i32, protocol: i32, call_back_types: CFOptionFlags, callout: CFSocketCallBack, context: *const CFSocketContext, ) -> Option<CFRetained<CFSocket>>

Available on crate feature CFData only.

Safety

• allocator might not allow None.
• callout must be implemented correctly.
• context must be a valid pointer.

pub unsafe fn with_native( allocator: Option<&CFAllocator>, sock: CFSocketNativeHandle, call_back_types: CFOptionFlags, callout: CFSocketCallBack, context: *const CFSocketContext, ) -> Option<CFRetained<CFSocket>>

Available on crate feature CFData only.

Safety

• allocator might not allow None.
• callout must be implemented correctly.
• context must be a valid pointer.

pub unsafe fn with_socket_signature( allocator: Option<&CFAllocator>, signature: *const CFSocketSignature, call_back_types: CFOptionFlags, callout: CFSocketCallBack, context: *const CFSocketContext, ) -> Option<CFRetained<CFSocket>>

Available on crate feature CFData only.

Safety

• allocator might not allow None.
• signature must be a valid pointer.
• callout must be implemented correctly.
• context must be a valid pointer.

pub unsafe fn new_connected_to_socket_signature( allocator: Option<&CFAllocator>, signature: *const CFSocketSignature, call_back_types: CFOptionFlags, callout: CFSocketCallBack, context: *const CFSocketContext, timeout: CFTimeInterval, ) -> Option<CFRetained<CFSocket>>

Available on crate features CFData and CFDate only.

Safety

• allocator might not allow None.
• signature must be a valid pointer.
• callout must be implemented correctly.
• context must be a valid pointer.

pub fn set_address(&self, address: Option<&CFData>) -> CFSocketError

Available on crate feature CFData only.

pub fn connect_to_address( &self, address: Option<&CFData>, timeout: CFTimeInterval, ) -> CFSocketError

Available on crate features CFData and CFDate only.

pub fn invalidate(&self)

pub fn is_valid(&self) -> bool

pub fn address(&self) -> Option<CFRetained<CFData>>

Available on crate feature CFData only.

pub fn peer_address(&self) -> Option<CFRetained<CFData>>

Available on crate feature CFData only.

pub unsafe fn context(&self, context: *mut CFSocketContext)

Safety

context must be a valid pointer.

pub fn native(&self) -> CFSocketNativeHandle

pub fn new_run_loop_source( allocator: Option<&CFAllocator>, s: Option<&CFSocket>, order: CFIndex, ) -> Option<CFRetained<CFRunLoopSource>>

Available on crate feature CFRunLoop only.

pub fn socket_flags(&self) -> CFOptionFlags

pub fn set_socket_flags(&self, flags: CFOptionFlags)

pub fn disable_call_backs(&self, call_back_types: CFOptionFlags)

pub fn enable_call_backs(&self, call_back_types: CFOptionFlags)

pub fn send_data( &self, address: Option<&CFData>, data: Option<&CFData>, timeout: CFTimeInterval, ) -> CFSocketError

Available on crate features CFData and CFDate only.

pub unsafe fn register_value( name_server_signature: *const CFSocketSignature, timeout: CFTimeInterval, name: Option<&CFString>, value: Option<&CFPropertyList>, ) -> CFSocketError

Available on crate features CFData and CFDate only.

Safety

• name_server_signature must be a valid pointer.
• name might not allow None.
• value should be of the correct type.
• value might not allow None.

pub unsafe fn copy_registered_value( name_server_signature: *const CFSocketSignature, timeout: CFTimeInterval, name: Option<&CFString>, value: *mut *const CFPropertyList, name_server_address: *mut *const CFData, ) -> CFSocketError

Available on crate features CFData and CFDate only.

Safety

• name_server_signature must be a valid pointer.
• name might not allow None.
• value must be a valid pointer.
• name_server_address must be a valid pointer.

pub unsafe fn register_socket_signature( name_server_signature: *const CFSocketSignature, timeout: CFTimeInterval, name: Option<&CFString>, signature: *const CFSocketSignature, ) -> CFSocketError

Available on crate features CFData and CFDate only.

Safety

• name_server_signature must be a valid pointer.
• name might not allow None.
• signature must be a valid pointer.

pub unsafe fn copy_registered_socket_signature( name_server_signature: *const CFSocketSignature, timeout: CFTimeInterval, name: Option<&CFString>, signature: *mut CFSocketSignature, name_server_address: *mut *const CFData, ) -> CFSocketError

Available on crate features CFData and CFDate only.

Safety

• name_server_signature must be a valid pointer.
• name might not allow None.
• signature must be a valid pointer.
• name_server_address must be a valid pointer.

pub unsafe fn unregister( name_server_signature: *const CFSocketSignature, timeout: CFTimeInterval, name: Option<&CFString>, ) -> CFSocketError

Available on crate features CFData and CFDate only.

Safety

• name_server_signature must be a valid pointer.
• name might not allow None.

pub fn set_default_name_registry_port_number(port: u16)

pub fn default_name_registry_port_number() -> u16

Methods from Deref<Target = CFType>

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

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 CFSocket

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFSocket> for CFSocket

fn as_ref(&self) -> &Self

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

impl AsRef<CFType> for CFSocket

fn as_ref(&self) -> &CFType

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

impl Borrow<AnyObject> for CFSocket

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for CFSocket

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for CFSocket

fn type_id() -> CFTypeID

Get the unique CFTypeID identifier for the type.

impl Debug for CFSocket

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

Formats the value using the given formatter.

impl Deref for CFSocket

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CFSocket

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 CFSocket

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for CFSocket

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 CFSocket

const ENCODING_REF: Encoding

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

impl Type for CFSocket

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 CFSocket