Skip Navigation
Class

CBPeripheralManager

An object that manages and advertises peripheral services exposed by this app.
class CBPeripheralManager

Overview

Core Bluetooth uses CBPeripheralManager objects to manage published services within the local peripheral’s Generic Attribute Profile (GATT) database and to advertise these services to central devices (represented by CBCentral objects). While a service is in the database, any connected central can see and connect to it. That said, if your app hasn’t specified the bluetooth-peripheral background mode, the contents of its services become disabled when it’s in the background or in a suspended state. In this scenario, any remote central trying to access the service’s characteristic value or characteristic descriptors receives an error.

Before you call CBPeripheralManager methods, the peripheral manager object must be in the powered-on state, as indicated by the CBPeripheralManagerState.poweredOn. This state indicates that the device (your iPhone or iPad, for instance) supports Bluetooth low energy and that its Bluetooth is on and available for use.

In watchOS, tvOS, and visionOS, you can’t advertise services using a CBPeripheralManager object because support for doing so is unavailable.

Topics

Initializing a Peripheral Manager

convenienceinit()
Initializes the peripheral manager without a delegate.
convenienceinit(delegate: (any CBPeripheralManagerDelegate)?, queue: dispatch_queue_t?)
Initializes the peripheral manager with a specified delegate and dispatch queue.
init(delegate: (any CBPeripheralManagerDelegate)?, queue: dispatch_queue_t?, options: [String: Any]?)
Initializes the peripheral manager with a specified delegate, dispatch queue, and initialization options.
vardelegate: (any CBPeripheralManagerDelegate)?
The delegate object specified to receive peripheral events.
Peripheral Manager Initialization Options
Keys used to specify options when creating a peripheral manager.

Monitoring the State of a Peripheral Manager

classfuncauthorizationStatus() -> CBPeripheralManagerAuthorizationStatus
Returns the app’s authorization status for sharing data while in the background.
Deprecated
enumCBPeripheralManagerAuthorizationStatus
Values representing the current authorization state of the peripheral manager.
Deprecated
enumCBPeripheralManagerState
Values that represent the current state of the peripheral manager.
Deprecated

Adding and Removing Services

funcadd(CBMutableService)
Publishes a service and any of its associated characteristics and characteristic descriptors to the local GATT database.
funcremove(CBMutableService)
Removes a specified published service from the local GATT database.
funcremoveAllServices()
Removes all published services from the local GATT database.

Managing Advertising

funcstartAdvertising([String: Any]?)
Advertises peripheral manager data.
Advertising Data
funcstopAdvertising()
Stops advertising peripheral manager data.
varisAdvertising: Bool
A Boolean value that indicates whether the peripheral is advertising data.

Sending Updates of a Characteristic’s Value

funcupdateValue(Data, for: CBMutableCharacteristic, onSubscribedCentrals: [CBCentral]?) -> Bool
Send an updated characteristic value to one or more subscribed centrals, using a notification or indication.

Responding to Read and Write Requests

funcrespond(to: CBATTRequest, withResult: CBATTError.Code)
Responds to a read or write request from a connected central.

Setting Connection Latency

funcsetDesiredConnectionLatency(CBPeripheralManagerConnectionLatency, for: CBCentral)
Sets the desired connection latency for an existing connection to a central device.
enumCBPeripheralManagerConnectionLatency
Values representing the connection latency of the peripheral manager.

Using L2CAP Channels

funcpublishL2CAPChannel(withEncryption: Bool)
Creates a listener for incoming L2CAP channel connections.
funcunpublishL2CAPChannel(CBL2CAPPSM)
Removes a published service from the local system.

Relationships

Inherits From

Conforms To

See Also

Peripherals

classCBPeripheral
A remote peripheral device.
protocolCBPeripheralDelegate
A protocol that provides updates on the use of a peripheral’s services.
protocolCBPeripheralManagerDelegate
A protocol that provides updates for local peripheral state and interactions with remote central devices.
classCBAttribute
A representation of common aspects of services offered by a peripheral.
structCBAttributePermissions
Values that represent the read, write, and encryption permissions for a characteristic’s value.
Current page is CBPeripheralManager