Struct CBPeripheralManager

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

Available on crate features CBManager and CBPeripheralManager only.

The CBPeripheralManager class is an abstraction of the Peripheral and Broadcaster GAP roles, and the GATT Server role. Its primary function is to allow you to manage published services within the GATT database, and to advertise these services to other devices. Each application has sandboxed access to the shared GATT database. You can add services to the database by calling {

 addService:};
              they can be removed via {@link removeService:} and {@link removeAllServices}, as appropriate. While a service is in the database,
              it is visible to and can be accessed by any connected GATT Client. However, applications that have not specified the "bluetooth-peripheral"
              background mode will have the contents of their service(s) "disabled" when in the background. Any remote device trying to access
              characteristic values or descriptors during this time will receive an error response.
              Once you've published services that you want to share, you can ask to advertise their availability and allow other devices to connect
              to you by calling {@link startAdvertising:}. Like the GATT database, advertisement is managed at the system level and shared by all
              applications. This means that even if you aren't advertising at the moment, someone else might be!

  

See also Apple’s documentation

Implementations

impl CBPeripheralManager

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn CBPeripheralManagerDelegate>>>

The delegate object that will receive peripheral events.

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn CBPeripheralManagerDelegate>>, )

This is a weak property. Setter for delegate.

pub unsafe fn isAdvertising(&self) -> bool

Whether or not the peripheral is currently advertising data.

pub unsafe fn authorizationStatus() -> CBPeripheralManagerAuthorizationStatus

👎Deprecated: Use CBManagerAuthorization instead

This method does not prompt the user for access. You can use it to detect restricted access and simply hide UI instead of prompting for access.

Returns: The current authorization status for sharing data while backgrounded. For the constants returned, see {

 CBPeripheralManagerAuthorizationStatus}.

  @see        CBPeripheralManagerAuthorizationStatus
  

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

pub unsafe fn initWithDelegate_queue( this: Allocated<Self>, delegate: Option<&ProtocolObject<dyn CBPeripheralManagerDelegate>>, queue: Option<&DispatchQueue>, ) -> Retained<Self>

Available on crate feature dispatch2 only.

Parameter delegate: The delegate that will receive peripheral role events.

Parameter queue: The dispatch queue on which the events will be dispatched.

The initialization call. The events of the peripheral role will be dispatched on the provided queue. If nil , the main queue will be used.

pub unsafe fn initWithDelegate_queue_options( this: Allocated<Self>, delegate: Option<&ProtocolObject<dyn CBPeripheralManagerDelegate>>, queue: Option<&DispatchQueue>, options: Option<&NSDictionary<NSString, AnyObject>>, ) -> Retained<Self>

Available on crate feature dispatch2 only.

Parameter delegate: The delegate that will receive peripheral role events.

Parameter queue: The dispatch queue on which the events will be dispatched.

Parameter options: An optional dictionary specifying options for the manager.

The initialization call. The events of the peripheral role will be dispatched on the provided queue. If nil , the main queue will be used.

See also: CBPeripheralManagerOptionShowPowerAlertKey

See also: CBPeripheralManagerOptionRestoreIdentifierKey

pub unsafe fn startAdvertising( &self, advertisement_data: Option<&NSDictionary<NSString, AnyObject>>, )

Parameter advertisementData: An optional dictionary containing the data to be advertised.

Starts advertising. Supported advertising data types are CBAdvertisementDataLocalNameKey and CBAdvertisementDataServiceUUIDsKey . When in the foreground, an application can utilize up to 28 bytes of space in the initial advertisement data for any combination of the supported advertising data types. If this space is used up, there are an additional 10 bytes of space in the scan response that can be used only for the local name. Note that these sizes do not include the 2 bytes of header information that are required for each new data type. Any service UUIDs that do not fit in the allotted space will be added to a special “overflow” area, and can only be discovered by an iOS device that is explicitly scanning for them. While an application is in the background, the local name will not be used and all service UUIDs will be placed in the “overflow” area. However, applications that have not specified the “bluetooth-peripheral” background mode will not be able to advertise anything while in the background.

See: peripheralManagerDidStartAdvertising:error:

See also: CBAdvertisementData.h

pub unsafe fn stopAdvertising(&self)

Stops advertising.

pub unsafe fn setDesiredConnectionLatency_forCentral( &self, latency: CBPeripheralManagerConnectionLatency, central: &CBCentral, )

Available on crate features CBCentral and CBPeer only.

Parameter latency: The desired connection latency.

Parameter central: A connected central.

Sets the desired connection latency for an existing connection to central . Connection latency changes are not guaranteed, so the resultant latency may vary. If a desired latency is not set, the latency chosen by central at the time of connection establishment will be used. Typically, it is not necessary to change the latency.

See: CBPeripheralManagerConnectionLatency

pub unsafe fn addService(&self, service: &CBMutableService)

Available on crate features CBAttribute and CBService only.

Parameter service: A GATT service.

Publishes a service and its associated characteristic(s) to the local database. If the service contains included services, they must be published first.

See: peripheralManager:didAddService:error:

pub unsafe fn removeService(&self, service: &CBMutableService)

Available on crate features CBAttribute and CBService only.

Parameter service: A GATT service.

Removes a published service from the local database. If the service is included by other service(s), they must be removed first.

pub unsafe fn removeAllServices(&self)

Removes all published services from the local database.

pub unsafe fn respondToRequest_withResult( &self, request: &CBATTRequest, result: CBATTError, )

Available on crate features CBATTRequest and CBError only.

Parameter request: The original request that was received from the central.

Parameter result: The result of attempting to fulfill request .

Used to respond to request(s) received via the

 peripheralManager:didReceiveReadRequest:

or

 peripheralManager:didReceiveWriteRequests:

delegate methods.

See: peripheralManager:didReceiveReadRequest:

See: peripheralManager:didReceiveWriteRequests:

pub unsafe fn updateValue_forCharacteristic_onSubscribedCentrals( &self, value: &NSData, characteristic: &CBMutableCharacteristic, centrals: Option<&NSArray<CBCentral>>, ) -> bool

Available on crate features CBAttribute and CBCentral and CBCharacteristic and CBPeer only.

Parameter value: The value to be sent via a notification/indication.

Parameter characteristic: The characteristic whose value has changed.

Parameter centrals: A list of CBCentral objects to receive the update. Note that centrals which have not subscribed to characteristic will be ignored. If nil , all centrals that are subscribed to characteristic will be updated.

Sends an updated characteristic value to one or more centrals, via a notification or indication. If value exceeds {

 maximumUpdateValueLength}, it will be truncated to fit.

  @return                 <i>YES</i> if the update could be sent, or <i>NO</i> if the underlying transmit queue is full. If <i>NO</i> was returned,
                          the delegate method @link peripheralManagerIsReadyToUpdateSubscribers:

will be called once space has become available, and the update should be re-sent if so desired.

See: peripheralManager:central:didSubscribeToCharacteristic:

See: peripheralManager:central:didUnsubscribeFromCharacteristic:

See: peripheralManagerIsReadyToUpdateSubscribers:

See also: maximumUpdateValueLength

pub unsafe fn publishL2CAPChannelWithEncryption( &self, encryption_required: bool, )

Parameter encryptionRequired: YES if the service requires the link to be encrypted before a stream can be established. NO if the service can be used over an unsecured link.

Create a listener for incoming L2CAP Channel connections. The system will determine an unused PSM at the time of publishing, which will be returned with

 peripheralManager:didPublishL2CAPChannel:error:

. L2CAP Channels are not discoverable by themselves, so it is the application’s responsibility to handle PSM discovery on the client.

pub unsafe fn unpublishL2CAPChannel(&self, psm: CBL2CAPPSM)

Available on crate feature CBL2CAPChannel only.

Parameter PSM: The service PSM to be removed from the system.

Removes a published service from the local system. No new connections for this PSM will be accepted, and any existing L2CAP channels using this PSM will be closed.

impl CBPeripheralManager

Methods declared on superclass NSObject.

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

Methods from Deref<Target = CBManager>

pub unsafe fn state(&self) -> CBManagerState

The current state of the manager, initially set to CBManagerStateUnknown . Updates are provided by required delegate method {

 managerDidUpdateState:}.

  

pub unsafe fn authorization(&self) -> CBManagerAuthorization

👎Deprecated

The current authorization of the manager, initially set to CBManagerAuthorizationNotDetermined . Updates are provided by required delegate method {

 managerDidUpdateState:}.
  @seealso    state
  

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 CBPeripheralManager

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CBManager> for CBPeripheralManager

fn as_ref(&self) -> &CBManager

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

impl AsRef<CBPeripheralManager> for CBPeripheralManager

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for CBPeripheralManager

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for CBPeripheralManager

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CBManager> for CBPeripheralManager

fn borrow(&self) -> &CBManager

Immutably borrows from an owned value.

impl Borrow<NSObject> for CBPeripheralManager

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for CBPeripheralManager

const NAME: &'static str = "CBPeripheralManager"

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

type Super = CBManager

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for CBPeripheralManager

type Target = CBManager

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CBPeripheralManager

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 CBPeripheralManager

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for CBPeripheralManager

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 CBPeripheralManager

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 CBPeripheralManager

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

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

impl DowncastTarget for CBPeripheralManager

impl Eq for CBPeripheralManager