corebluetooth

func (CBATTError) String ¶

func (e CBATTError) String() string

func (CBATTRequest) Autorelease ¶

func (c CBATTRequest) Autorelease() CBATTRequest

Autorelease adds the receiver to the current autorelease pool.

func (CBATTRequest) Central ¶

func (c CBATTRequest) Central() ICBCentral

The remote central device that originated the request.

Overview ¶

For more information, see Core Bluetooth Programming Guide.

See: https://developer.apple.com/documentation/CoreBluetooth/CBATTRequest/central

func (CBATTRequest) Characteristic ¶

func (c CBATTRequest) Characteristic() ICBCharacteristic

The characteristic to read or write the value of.

See: https://developer.apple.com/documentation/CoreBluetooth/CBATTRequest/characteristic

func (CBATTRequest) Init ¶

func (c CBATTRequest) Init() CBATTRequest

Init initializes the instance.

func (CBATTRequest) Offset ¶

func (c CBATTRequest) Offset() uint

The zero-based index of the first byte for the read or write request.

Discussion ¶

You can use the value of this property to ensure that the ATT request is attempting to read or write within the proper bounds of the characteristic’s value. For an example of how to take a request’s offset property into account when responding to a read or write request, see Responding to Read and Write Requests from a Central.

See: https://developer.apple.com/documentation/CoreBluetooth/CBATTRequest/offset

func (CBATTRequest) SetValue ¶

func (c CBATTRequest) SetValue(value foundation.NSData)

func (CBATTRequest) Value ¶

func (c CBATTRequest) Value() foundation.NSData

The data that the central reads from or writes to the peripheral.

Discussion ¶

The value of this property depends on whether the request type is read or write. For read requests, the property is `nil,` and you should set it before responding to the remote central through the CBPeripheralManager.RespondToRequestWithResult method. For write requests, the value is the data to write to the characteristic’s value.

See: https://developer.apple.com/documentation/CoreBluetooth/CBATTRequest/value

func (CBATTRequestClass) Alloc ¶

func (cc CBATTRequestClass) Alloc() CBATTRequest

Alloc allocates memory for a new instance of the class.

func (CBATTRequestClass) Class ¶

func (cc CBATTRequestClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CBAttribute) Autorelease ¶

func (c CBAttribute) Autorelease() CBAttribute

Autorelease adds the receiver to the current autorelease pool.

func (CBAttribute) Init ¶

func (c CBAttribute) Init() CBAttribute

Init initializes the instance.

func (CBAttribute) UUID ¶

func (c CBAttribute) UUID() ICBUUID

The Bluetooth-specific UUID of the attribute.

Discussion ¶

This property is a 128-bit UUID that identifies the attribute.

For more information, see Core Bluetooth Programming Guide.

See: https://developer.apple.com/documentation/CoreBluetooth/CBAttribute/uuid

func (CBAttributeClass) Alloc ¶

func (cc CBAttributeClass) Alloc() CBAttribute

Alloc allocates memory for a new instance of the class.

func (CBAttributeClass) Class ¶

func (cc CBAttributeClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CBAttributePermissions) String ¶

func (e CBAttributePermissions) String() string

func (CBCentral) Autorelease ¶

func (c CBCentral) Autorelease() CBCentral

Autorelease adds the receiver to the current autorelease pool.

func (CBCentral) Init ¶

func (c CBCentral) Init() CBCentral

Init initializes the instance.

func (CBCentral) MaximumUpdateValueLength ¶

func (c CBCentral) MaximumUpdateValueLength() uint

The maximum amount of data, in bytes, that the central can receive in a single notification or indication.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentral/maximumUpdateValueLength

func (CBCentralClass) Alloc ¶

func (cc CBCentralClass) Alloc() CBCentral

Alloc allocates memory for a new instance of the class.

func (CBCentralClass) Class ¶

func (cc CBCentralClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CBCentralManager) Autorelease ¶

func (c CBCentralManager) Autorelease() CBCentralManager

Autorelease adds the receiver to the current autorelease pool.

func (CBCentralManager) CancelPeripheralConnection ¶

func (c CBCentralManager) CancelPeripheralConnection(peripheral ICBPeripheral)

Cancels an active or pending local connection to a peripheral.

peripheral: The peripheral to which the central manager is either trying to connect or has already connected.

Discussion ¶

This method is nonblocking, and any CBPeripheral class commands that are still pending to `peripheral` may not complete. Because other apps may still have a connection to the peripheral, canceling a local connection doesn’t guarantee that the underlying physical link is immediately disconnected. From the app’s perspective, however, the peripheral is effectively disconnected, and the central manager object calls the [CentralManagerDidDisconnectPeripheralError] method of its delegate object.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManager/cancelPeripheralConnection(_:)

func (CBCentralManager) ConnectPeripheralOptions ¶

func (c CBCentralManager) ConnectPeripheralOptions(peripheral ICBPeripheral, options foundation.INSDictionary)

Establishes a local connection to a peripheral.

peripheral: The peripheral to which the central is attempting to connect.

options: A dictionary to customize the behavior of the connection. For available options, see Peripheral Connection Options.

Discussion ¶

After successfully establishing a local connection to a peripheral, the central manager object calls the [CentralManagerDidConnectPeripheral] method of its delegate object. If the connection attempt fails, the central manager object calls the [CentralManagerDidFailToConnectPeripheralError] method of its delegate object instead. Attempts to connect to a peripheral don’t time out. To explicitly cancel a pending connection to a peripheral, call the CBCentralManager.CancelPeripheralConnection method. Deallocating `peripheral` also implicitly calls CBCentralManager.CancelPeripheralConnection.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManager/connect(_:options:)

func (CBCentralManager) Delegate ¶

func (c CBCentralManager) Delegate() CBCentralManagerDelegate

The delegate object that you want to receive central manager events.

Discussion ¶

For information about how to implement your central manager delegate, see CBCentralManagerDelegate.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManager/delegate

func (CBCentralManager) Init ¶

func (c CBCentralManager) Init() CBCentralManager

Init initializes the instance.

func (CBCentralManager) InitWithDelegateQueue ¶

func (c CBCentralManager) InitWithDelegateQueue(delegate CBCentralManagerDelegate, queue dispatch.Queue) CBCentralManager

Initializes the central manager with a specified delegate and dispatch queue.

delegate: The delegate that receives central events.

queue: The dispatch queue used to dispatch the central role events. If the value is `nil`, the central manager dispatches central role events using the main queue.

Return Value ¶

Returns a newly initialized central manager.

Discussion ¶

For more information, see Core Bluetooth Programming Guide.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManager/init(delegate:queue:)

func (CBCentralManager) InitWithDelegateQueueOptions ¶

func (c CBCentralManager) InitWithDelegateQueueOptions(delegate CBCentralManagerDelegate, queue dispatch.Queue, options foundation.INSDictionary) CBCentralManager

Initializes the central manager with specified delegate, dispatch queue, and initialization options.

delegate: The delegate that receives the central events.

queue: The dispatch queue used to dispatch the central role events. If the value is `nil`, the central manager dispatches central role events using the main queue.

options: An optional dictionary that contains initialization options for a central manager. For available options, see Central Manager Initialization Options.

Return Value ¶

Returns a newly initialized central manager.

Discussion ¶

This method is the designated initializer for the CBCentralManager class.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManager/init(delegate:queue:options:)

func (CBCentralManager) IsScanning ¶

func (c CBCentralManager) IsScanning() bool

A Boolean value that indicates whether the central is currently scanning.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManager/isScanning

func (CBCentralManager) RetrieveConnectedPeripheralsWithServices ¶

func (c CBCentralManager) RetrieveConnectedPeripheralsWithServices(serviceUUIDs []CBUUID) []CBPeripheral

Returns a list of the peripherals connected to the system whose services match a given set of criteria.

serviceUUIDs: A list of service UUIDs, represented by CBUUID objects.

Return Value ¶

A list of the peripherals that are currently connected to the system and that contain any of the services specified in the `serviceUUID` parameter.

Discussion ¶

The list of connected peripherals can include those that other apps have connected. You need to connect these peripherals locally using the CBCentralManager.ConnectPeripheralOptions method before using them.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManager/retrieveConnectedPeripherals(withServices:)

func (CBCentralManager) RetrievePeripheralsWithIdentifiers ¶

func (c CBCentralManager) RetrievePeripheralsWithIdentifiers(identifiers []foundation.NSUUID) []CBPeripheral

Returns a list of known peripherals by their identifiers.

identifiers: A list of peripheral identifiers (represented by NSUUID objects) from which CBPeripheral objects can be retrieved.

Return Value ¶

A list of peripherals that the central manager is able to match to the provided identifiers.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManager/retrievePeripherals(withIdentifiers:)

func (CBCentralManager) ScanForPeripheralsWithServicesOptions ¶

func (c CBCentralManager) ScanForPeripheralsWithServicesOptions(serviceUUIDs []CBUUID, options foundation.INSDictionary)

Scans for peripherals that are advertising services.

serviceUUIDs: An array of CBUUID objects that the app is interested in. Each CBUUID object represents the UUID of a service that a peripheral advertises.

options: A dictionary of options for customizing the scan. For available options, see Peripheral Scanning Options.

Discussion ¶

You can provide an array of CBUUID objects — representing service UUIDs — in the `serviceUUIDs` parameter. When you do, the central manager returns only peripherals that advertise the services you specify. If the `serviceUUIDs` parameter is `nil`, this method returns all discovered peripherals, regardless of their supported services.

If the central manager is actively scanning with one set of parameters and it receives another set to scan, the new parameters override the previous set. When the central manager discovers a peripheral, it calls the [CentralManagerDidDiscoverPeripheralAdvertisementDataRSSI] method of its delegate object.

Your app can scan for Bluetooth devices in the background by specifying the `bluetooth-central` background mode. To do this, your app must explicitly scan for one or more services by specifying them in the `serviceUUIDs` parameter. The CBCentralManager scan option has no effect while scanning in the background.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManager/scanForPeripherals(withServices:options:)

func (CBCentralManager) SetDelegate ¶

func (c CBCentralManager) SetDelegate(value CBCentralManagerDelegate)

func (CBCentralManager) StopScan ¶

func (c CBCentralManager) StopScan()

Asks the central manager to stop scanning for peripherals.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManager/stopScan()

func (CBCentralManagerClass) Alloc ¶

func (cc CBCentralManagerClass) Alloc() CBCentralManager

Alloc allocates memory for a new instance of the class.

func (CBCentralManagerClass) Class ¶

func (cc CBCentralManagerClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CBCentralManagerDelegateObject) BaseObject ¶

func (o CBCentralManagerDelegateObject) BaseObject() objectivec.Object

func (CBCentralManagerDelegateObject) CentralManagerConnectionEventDidOccurForPeripheral ¶

func (o CBCentralManagerDelegateObject) CentralManagerConnectionEventDidOccurForPeripheral(central ICBCentralManager, event CBConnectionEvent, peripheral ICBPeripheral)

Tells the delegate that a connection event occurred which matches the registered options.

Discussion ¶

The manager calls this method when it observes a connection event that matches the options provided to [CBCentralManager.RegisterForConnectionEventsWithOptions].

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManagerDelegate/centralManager(_:connectionEventDidOccur:for:)

func (CBCentralManagerDelegateObject) CentralManagerDidConnectPeripheral ¶

func (o CBCentralManagerDelegateObject) CentralManagerDidConnectPeripheral(central ICBCentralManager, peripheral ICBPeripheral)

Tells the delegate that the central manager connected to a peripheral.

central: The central manager that provides this information.

peripheral: The now-connected peripheral.

Discussion ¶

The manager invokes this method when a call to CBCentralManager.ConnectPeripheralOptions succeeds. You typically implement this method to set the peripheral’s delegate and discover its services.

For more information, see Core Bluetooth Programming Guide.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManagerDelegate/centralManager(_:didConnect:)

func (CBCentralManagerDelegateObject) CentralManagerDidDisconnectPeripheralError ¶

func (o CBCentralManagerDelegateObject) CentralManagerDidDisconnectPeripheralError(central ICBCentralManager, peripheral ICBPeripheral, error_ foundation.NSError)

Tells the delegate that the central manager disconnected from a peripheral.

central: The central manager that provides this information.

peripheral: The now-disconnected peripheral.

error: The cause of the failure, or `nil` if no error occurred.

Discussion ¶

The manager invokes this method when disconnecting a peripheral previously connected with the CBCentralManager.ConnectPeripheralOptions method. The error parameter contains the reason for the disconnection, unless the disconnect resulted from a call to CBCentralManager.CancelPeripheralConnection. After this method executes, the peripheral device’s CBPeripheralDelegate object receives no further method calls.

All services, characteristics, and characteristic descriptors a peripheral become invalidated after it disconnects.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManagerDelegate/centralManager(_:didDisconnectPeripheral:error:)

func (CBCentralManagerDelegateObject) CentralManagerDidDisconnectPeripheralTimestampIsReconnectingError ¶

func (o CBCentralManagerDelegateObject) CentralManagerDidDisconnectPeripheralTimestampIsReconnectingError(central ICBCentralManager, peripheral ICBPeripheral, timestamp corefoundation.CFAbsoluteTime, isReconnecting bool, error_ foundation.NSError)

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManagerDelegate/centralManager(_:didDisconnectPeripheral:timestamp:isReconnecting:error:)

func (CBCentralManagerDelegateObject) CentralManagerDidDiscoverPeripheralAdvertisementDataRSSI ¶

func (o CBCentralManagerDelegateObject) CentralManagerDidDiscoverPeripheralAdvertisementDataRSSI(central ICBCentralManager, peripheral ICBPeripheral, advertisementData foundation.INSDictionary, RSSI foundation.NSNumber)

Tells the delegate the central manager discovered a peripheral while scanning for devices.

central: The central manager that provides the update.

peripheral: The discovered peripheral.

advertisementData: A dictionary containing any advertisement data.

RSSI: The current received signal strength indicator (RSSI) of the peripheral, in decibels.

Discussion ¶

You can access the advertisement data with the keys listed in Advertisement Data Retrieval Keys. You must retain a local copy of the peripheral if you want to perform commands on it. Use the RSSI data to determine the proximity of a discoverable peripheral device, and whether you want to connect to it automatically.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManagerDelegate/centralManager(_:didDiscover:advertisementData:rssi:)

func (CBCentralManagerDelegateObject) CentralManagerDidFailToConnectPeripheralError ¶

func (o CBCentralManagerDelegateObject) CentralManagerDidFailToConnectPeripheralError(central ICBCentralManager, peripheral ICBPeripheral, error_ foundation.NSError)

Tells the delegate the central manager failed to create a connection with a peripheral.

central: The central manager that provides this information.

peripheral: The peripheral that failed to connect.

error: The cause of the failure, or `nil` if no error occurred.

Discussion ¶

The manager invokes this method when a connection initiated with the CBCentralManager.ConnectPeripheralOptions method fails to complete. Because connection attempts don’t time out, a failed connection usually indicates a transient issue, in which case you may attempt connecting to the peripheral again.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManagerDelegate/centralManager(_:didFailToConnect:error:)

func (CBCentralManagerDelegateObject) CentralManagerDidUpdateANCSAuthorizationForPeripheral ¶

func (o CBCentralManagerDelegateObject) CentralManagerDidUpdateANCSAuthorizationForPeripheral(central ICBCentralManager, peripheral ICBPeripheral)

Tells the delegate the authorization status changed for a ANCS-requiring connected peripheral.

central: The central manager providing this information.

peripheral: The CBPeripheral that caused the event.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManagerDelegate/centralManager(_:didUpdateANCSAuthorizationFor:)

func (CBCentralManagerDelegateObject) CentralManagerDidUpdateState ¶

func (o CBCentralManagerDelegateObject) CentralManagerDidUpdateState(central ICBCentralManager)

Tells the delegate the central manager’s state updated.

central: The central manager whose state has changed.

Discussion ¶

You implement this required method to ensure that the central device supports Bluetooth low energy and that it’s available to use. You should issue commands to the central manager only when the central manager’s CBManager.State indicates it’s powered on. A state with a value lower than CBManagerState.poweredOn implies that scanning has stopped, which in turn disconnects any previously-connected peripherals. If the state moves below CBManagerState.poweredOff, all CBPeripheral objects obtained from this central manager become invalid; you must retrieve or discover these peripherals again. For a complete list of possible states, see CBManagerState.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManagerDelegate/centralManagerDidUpdateState(_:)

func (CBCentralManagerDelegateObject) CentralManagerWillRestoreState ¶

func (o CBCentralManagerDelegateObject) CentralManagerWillRestoreState(central ICBCentralManager, dict foundation.INSDictionary)

Tells the delegate the system is about to restore the central manager, as part of relaunching the app into the background.

central: The central manager that provides this information.

dict: A dictionary that contains information about the central manager preserved by the system when it terminated the app. For the available keys to this dictionary, see Central Manager State Restoration Options.

Discussion ¶

This method only applies to apps that opt in to the state preservation and restoration feature of Core Bluetooth. The system invokes this method when relaunching your app into the background to complete some Bluetooth-related task. Use this method to synchronize the state of your app with the state of the Bluetooth system.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCentralManagerDelegate/centralManager(_:willRestoreState:)

func (CBCentralManagerFeature) String ¶

func (e CBCentralManagerFeature) String() string

func (CBCentralManagerState) String ¶

func (e CBCentralManagerState) String() string

func (CBCharacteristic) Autorelease ¶

func (c CBCharacteristic) Autorelease() CBCharacteristic

Autorelease adds the receiver to the current autorelease pool.

func (CBCharacteristic) Descriptors ¶

func (c CBCharacteristic) Descriptors() []CBDescriptor

A list of the descriptors discovered in this characteristic.

Discussion ¶

The value of this property is an array of CBDescriptor objects that represent a characteristic’s descriptors. Characteristic descriptors provide more information about a characteristic’s value. For example, they may describe the value in human-readable form and describe how to format the value for presentation purposes. For more information about characteristic descriptors, see CBDescriptor.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCharacteristic/descriptors

func (CBCharacteristic) Init ¶

func (c CBCharacteristic) Init() CBCharacteristic

Init initializes the instance.

func (CBCharacteristic) IsNotifying ¶

func (c CBCharacteristic) IsNotifying() bool

A Boolean value that indicates whether the characteristic is currently notifying a subscribed central of its value.

Discussion ¶

This value is true if you enabled notifications or indications for the characteristic by successfully calling the CBPeripheral.SetNotifyValueForCharacteristic method of the CBPeripheral class. In this case, the peripheral updates its connected central that whenever the characteristic’s value changes.

If the value of the property is false, notifications (or indications) aren’t enabled for the characteristic, and the peripheral doesn’t update its connected central when the characteristic’s value changes.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCharacteristic/isNotifying

func (CBCharacteristic) Properties ¶

func (c CBCharacteristic) Properties() CBCharacteristicProperties

The properties of the characteristic.

Discussion ¶

The properties of a characteristic determine the access to and use of the characteristic’s value and descriptors. For a list of the possible values representing the properties of a characteristic, see CBCharacteristicProperties.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCharacteristic/properties

func (CBCharacteristic) Service ¶

func (c CBCharacteristic) Service() ICBService

The service to which this characteristic belongs.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCharacteristic/service

func (CBCharacteristic) Value ¶

func (c CBCharacteristic) Value() foundation.NSData

The value of the characteristic.

Discussion ¶

This property contains the value of the characteristic. For example, a temperature measurement characteristic of a health thermometer service may have a value that indicates a temperature in Celsius.

See: https://developer.apple.com/documentation/CoreBluetooth/CBCharacteristic/value

func (CBCharacteristicClass) Alloc ¶

func (cc CBCharacteristicClass) Alloc() CBCharacteristic

Alloc allocates memory for a new instance of the class.

func (CBCharacteristicClass) Class ¶

func (cc CBCharacteristicClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CBCharacteristicProperties) String ¶

func (e CBCharacteristicProperties) String() string

func (CBCharacteristicWriteType) String ¶

func (e CBCharacteristicWriteType) String() string

func (CBConnectionEvent) String ¶

func (e CBConnectionEvent) String() string

func (CBDescriptor) Autorelease ¶

func (c CBDescriptor) Autorelease() CBDescriptor

Autorelease adds the receiver to the current autorelease pool.

func (CBDescriptor) Characteristic ¶

func (c CBDescriptor) Characteristic() ICBCharacteristic

The characteristic to which this descriptor belongs.

See: https://developer.apple.com/documentation/CoreBluetooth/CBDescriptor/characteristic

func (CBDescriptor) Init ¶

func (c CBDescriptor) Init() CBDescriptor

Init initializes the instance.

func (CBDescriptor) Value ¶

func (c CBDescriptor) Value() objectivec.IObject

The value of the descriptor.

Discussion ¶

The documentation for CBUUID details the value types for the various descriptor types.

You can read the value of a descriptor by calling the CBPeripheral.ReadValueForDescriptor method of the CBPeripheral class. You can write the value of a descriptor by calling the CBPeripheral.WriteValueForDescriptor method of the CBPeripheral class. You can’t, however, use the CBPeripheral.WriteValueForDescriptor method to write the value of a client configuration descriptor (CBUUIDClientCharacteristicConfigurationString). Instead, you use the CBPeripheral.SetNotifyValueForCharacteristic method of the CBPeripheral class to configure client indications or notifications of a characteristic’s value on a server.

See: https://developer.apple.com/documentation/CoreBluetooth/CBDescriptor/value

func (CBDescriptorClass) Alloc ¶

func (cc CBDescriptorClass) Alloc() CBDescriptor

Alloc allocates memory for a new instance of the class.

func (CBDescriptorClass) Class ¶

func (cc CBDescriptorClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CBError) String ¶

func (e CBError) String() string

func (CBL2CAPChannel) Autorelease ¶

func (c CBL2CAPChannel) Autorelease() CBL2CAPChannel

Autorelease adds the receiver to the current autorelease pool.

func (CBL2CAPChannel) Init ¶

func (c CBL2CAPChannel) Init() CBL2CAPChannel

Init initializes the instance.

func (CBL2CAPChannel) InputStream ¶

func (c CBL2CAPChannel) InputStream() foundation.InputStream

The stream used for reading data from the remote peer.

See: https://developer.apple.com/documentation/CoreBluetooth/CBL2CAPChannel/inputStream

func (CBL2CAPChannel) OutputStream ¶

func (c CBL2CAPChannel) OutputStream() foundation.OutputStream

The stream used for writing data to the peer.

See: https://developer.apple.com/documentation/CoreBluetooth/CBL2CAPChannel/outputStream

func (CBL2CAPChannel) PSM ¶

func (c CBL2CAPChannel) PSM() CBL2CAPPSM

The PSM of the channel.

See: https://developer.apple.com/documentation/CoreBluetooth/CBL2CAPChannel/psm

func (CBL2CAPChannel) Peer ¶

func (c CBL2CAPChannel) Peer() ICBPeer

The peer connected to the channel.

See: https://developer.apple.com/documentation/CoreBluetooth/CBL2CAPChannel/peer

func (CBL2CAPChannelClass) Alloc ¶

func (cc CBL2CAPChannelClass) Alloc() CBL2CAPChannel

Alloc allocates memory for a new instance of the class.

func (CBL2CAPChannelClass) Class ¶

func (cc CBL2CAPChannelClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CBManager) Authorization ¶

func (c CBManager) Authorization() CBManagerAuthorization

The current authorization status for using Bluetooth.

See: https://developer.apple.com/documentation/CoreBluetooth/CBManager/authorization-swift.property

func (CBManager) Autorelease ¶

func (c CBManager) Autorelease() CBManager

Autorelease adds the receiver to the current autorelease pool.

func (CBManager) Init ¶

func (c CBManager) Init() CBManager

Init initializes the instance.

func (CBManager) State ¶

func (c CBManager) State() CBManagerState

The current state of the manager.

Discussion ¶

This state is initially set to CBManagerState.unknown. When the state updates, the manager calls its delegate’s [CentralManagerDidUpdateState] method.

See: https://developer.apple.com/documentation/CoreBluetooth/CBManager/state

func (CBManagerAuthorization) String ¶

func (e CBManagerAuthorization) String() string

func (CBManagerClass) Alloc ¶

func (cc CBManagerClass) Alloc() CBManager

Alloc allocates memory for a new instance of the class.

func (CBManagerClass) Class ¶

func (cc CBManagerClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CBManagerState) String ¶

func (e CBManagerState) String() string

func (CBMutableCharacteristic) Autorelease ¶

func (c CBMutableCharacteristic) Autorelease() CBMutableCharacteristic

Autorelease adds the receiver to the current autorelease pool.

func (CBMutableCharacteristic) Init ¶

func (c CBMutableCharacteristic) Init() CBMutableCharacteristic

Init initializes the instance.

func (CBMutableCharacteristic) InitWithTypePropertiesValuePermissions ¶

func (c CBMutableCharacteristic) InitWithTypePropertiesValuePermissions(UUID ICBUUID, properties CBCharacteristicProperties, value foundation.NSData, permissions CBAttributePermissions) CBMutableCharacteristic

Creates a mutable characteristic with specified permissions, properties, and value.

UUID: A 128-bit UUID that identifies the characteristic.

properties: The properties of the characteristic.

value: The characteristic value to cache. If `nil`, the value is dynamic and the peripheral manager fetches it on demand.

permissions: The permissions of the characteristic value.

Return Value ¶

A newly initialized mutable characteristic.

Discussion ¶

If you specify a value for the characteristic, the characteristic caches the value and sets its properties and permissions to CBCharacteristicPropertyRead and CBAttributePermissionsReadable, respectively. Therefore, if you need the value of a characteristic to be writeable, or if you expect the value to change during the lifetime of the published service to which the characteristic belongs, you must specify the value as `nil`. This ensures that the characteristic treats the value dynamically. With a dynamic value, the peripheral manager requests the value whenever the peripheral manager receives a read or write request from a central. The peripheral does this by calling the [PeripheralManagerDidReceiveReadRequest] and [PeripheralManagerDidReceiveWriteRequests] methods of its delegate object, respectively.

For more information, see Core Bluetooth Programming Guide.

See: https://developer.apple.com/documentation/CoreBluetooth/CBMutableCharacteristic/init(type:properties:value:permissions:)

func (CBMutableCharacteristic) Permissions ¶

func (c CBMutableCharacteristic) Permissions() CBAttributePermissions

The permissions of the characteristic value.

Discussion ¶

Characteristic permissions represent the read, write, and encryption permissions for a characteristic’s value. For a complete list and discussion of the available characteristic permissions, see CBAttributePermissions.

See: https://developer.apple.com/documentation/CoreBluetooth/CBMutableCharacteristic/permissions

func (CBMutableCharacteristic) SetPermissions ¶

func (c CBMutableCharacteristic) SetPermissions(value CBAttributePermissions)

func (CBMutableCharacteristic) SubscribedCentrals ¶

func (c CBMutableCharacteristic) SubscribedCentrals() []CBCentral

A list of centrals that are currently subscribed to the characteristic’s value.

Discussion ¶

The value of this property is an array of CBCentral objects that currently subscribe to the characteristic’s value. The array is empty if the characteristic isn’t configured to support notifications or indications. Even if the characteristic’s configuration supports notifications or indications, the array is empty if centrals aren’t subscribing to the characteristic’s value.

See: https://developer.apple.com/documentation/CoreBluetooth/CBMutableCharacteristic/subscribedCentrals

func (CBMutableCharacteristicClass) Alloc ¶

func (cc CBMutableCharacteristicClass) Alloc() CBMutableCharacteristic

Alloc allocates memory for a new instance of the class.

func (CBMutableCharacteristicClass) Class ¶

func (cc CBMutableCharacteristicClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CBMutableDescriptor) Autorelease ¶

func (c CBMutableDescriptor) Autorelease() CBMutableDescriptor

Autorelease adds the receiver to the current autorelease pool.

func (CBMutableDescriptor) Init ¶

func (c CBMutableDescriptor) Init() CBMutableDescriptor

Init initializes the instance.

func (CBMutableDescriptor) InitWithTypeValue ¶

func (c CBMutableDescriptor) InitWithTypeValue(UUID ICBUUID, value objectivec.IObject) CBMutableDescriptor

Creates a mutable descriptor with a specified value.

UUID: A 128-bit UUID that identifies the characteristic. You must use only one of the two currently supported descriptor types: CBUUIDCharacteristicUserDescriptionString or CBUUIDCharacteristicFormatString. For more details about these descriptor types, see CBUUID.

value: The descriptor value to cache. You must provide a non-`nil` value. Once published, you can’t update the value dynamically.

Return Value ¶

A newly initialized mutable descriptor.

Discussion ¶

The value type of `value` depends on the type of descriptor:

- The value type of CBUUIDCharacteristicUserDescriptionString is a string you use to provide a human-readable description of the characteristic’s value. - The value type of a CBUUIDCharacteristicFormatString is an NSData object that you use to specify how to format the characteristic’s value for presentation purposes.

If you want to create a local characteristic format descriptor, the descriptor’s value must conform to the attribute value of the characteristic format descriptor as defined in the Bluetooth 4.0 specification, Volume 3, Part G, Section 3.3.3.5.

For more information, see Core Bluetooth Programming Guide.

See: https://developer.apple.com/documentation/CoreBluetooth/CBMutableDescriptor/init(type:value:)

func (CBMutableDescriptorClass) Alloc ¶

func (cc CBMutableDescriptorClass) Alloc() CBMutableDescriptor

Alloc allocates memory for a new instance of the class.

func (CBMutableDescriptorClass) Class ¶

func (cc CBMutableDescriptorClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CBMutableService) Autorelease ¶

func (c CBMutableService) Autorelease() CBMutableService

Autorelease adds the receiver to the current autorelease pool.

func (CBMutableService) Init ¶

func (c CBMutableService) Init() CBMutableService

Init initializes the instance.

func (CBMutableService) InitWithTypePrimary ¶

func (c CBMutableService) InitWithTypePrimary(UUID ICBUUID, isPrimary bool) CBMutableService

Creates a newly initialized mutable service specified by UUID and service type.

UUID: A 128-bit UUID that identifies the service.

isPrimary: A Boolean value that indicates whether the type of service is primary or secondary. If the value is true, the type of service is primary. If the value is false, the type of service is secondary.

Return Value ¶

A newly initialized mutable service.

Discussion ¶

For more information, see Core Bluetooth Programming Guide.

See: https://developer.apple.com/documentation/CoreBluetooth/CBMutableService/init(type:primary:)

func (CBMutableServiceClass) Alloc ¶

func (cc CBMutableServiceClass) Alloc() CBMutableService

Alloc allocates memory for a new instance of the class.

func (CBMutableServiceClass) Class ¶

func (cc CBMutableServiceClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CBPeer) Autorelease ¶

func (c CBPeer) Autorelease() CBPeer

Autorelease adds the receiver to the current autorelease pool.

func (CBPeer) Identifier ¶

func (c CBPeer) Identifier() foundation.NSUUID

The UUID associated with the peer.

Discussion ¶

The value of this property represents the unique identifier of the peer. The first time a local manager encounters a peer, the system assigns the peer a UUID, represented by a new UUID object. Peers use UUID instances to identify themselves, instead of by the CBUUID objects that identify a peripheral’s services, characteristics, and descriptors.

For more information, see Core Bluetooth Programming Guide.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeer/identifier

func (CBPeer) Init ¶

func (c CBPeer) Init() CBPeer

Init initializes the instance.

func (CBPeerClass) Alloc ¶

func (cc CBPeerClass) Alloc() CBPeer

Alloc allocates memory for a new instance of the class.

func (CBPeerClass) Class ¶

func (cc CBPeerClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CBPeripheral) Autorelease ¶

func (c CBPeripheral) Autorelease() CBPeripheral

Autorelease adds the receiver to the current autorelease pool.

func (CBPeripheral) CanSendWriteWithoutResponse ¶

func (c CBPeripheral) CanSendWriteWithoutResponse() bool

A Boolean value that indicates whether the remote device can send a write without a response.

Discussion ¶

If this value is false, flushing all current writes sets the value to true. This also results in a call to the delegate’s [PeripheralIsReadyToSendWriteWithoutResponse].

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/canSendWriteWithoutResponse

func (CBPeripheral) Delegate ¶

func (c CBPeripheral) Delegate() CBPeripheralDelegate

The delegate object specified to receive peripheral events.

Discussion ¶

For information about how to implement your peripheral delegate, see CBPeripheralDelegate.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/delegate

func (CBPeripheral) DiscoverCharacteristicsForService ¶

func (c CBPeripheral) DiscoverCharacteristicsForService(characteristicUUIDs []CBUUID, service ICBService)

Discovers the specified characteristics of a service.

characteristicUUIDs: An array of CBUUID objects that you are interested in. Each CBUUID object represents a UUID that identifies the type of a characteristic you want to discover.

service: The service whose characteristics you want to discover.

Discussion ¶

You can provide an array of CBUUID objects—representing characteristic UUIDs— in the `characteristicUUIDs` parameter. When you do, the peripheral returns only the characteristics of the service that match the provided UUIDs. If the `characteristicUUIDs` parameter is `nil`, this method returns all characteristics of the service.

When the peripheral discovers one or more characteristics of the specified service, it calls the [PeripheralDidDiscoverCharacteristicsForServiceError] method of its delegate object. After the peripheral discovers the service’s characteristics, you can access them through the service’s CBService.Characteristics property.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/discoverCharacteristics(_:for:)

func (CBPeripheral) DiscoverDescriptorsForCharacteristic ¶

func (c CBPeripheral) DiscoverDescriptorsForCharacteristic(characteristic ICBCharacteristic)

Discovers the descriptors of a characteristic.

characteristic: The characteristic whose descriptors you want to discover.

Discussion ¶

When the peripheral discovers one or more descriptors of the specified characteristic, it calls the [PeripheralDidDiscoverDescriptorsForCharacteristicError] method of its delegate object. After the peripheral discovers the descriptors of the characteristic, you can access them through the characteristic’s CBCharacteristic.Descriptors property.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/discoverDescriptors(for:)

func (CBPeripheral) DiscoverIncludedServicesForService ¶

func (c CBPeripheral) DiscoverIncludedServicesForService(includedServiceUUIDs []CBUUID, service ICBService)

Discovers the specified included services of a previously-discovered service.

includedServiceUUIDs: An array of CBUUID objects that you are interested in. Here, each CBUUID object represents a UUID that identifies the type of included service you want to discover.

service: The previously-discovered service whose included services you want to discover.

Discussion ¶

You can provide an array of CBUUID objects—representing included service UUIDs—in the `includedServiceUUIDs` parameter. When you do, the peripheral returns only the services of the peripheral that match the provided UUIDs.

When the peripheral discovers one or more included services of the specified service, it calls the [PeripheralDidDiscoverIncludedServicesForServiceError] method of its delegate object. After the service discovers its included services, you can access them through the service’s CBService.IncludedServices property.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/discoverIncludedServices(_:for:)

func (CBPeripheral) DiscoverServices ¶

func (c CBPeripheral) DiscoverServices(serviceUUIDs []CBUUID)

Discovers the specified services of the peripheral.

serviceUUIDs: An array of CBUUID objects that you are interested in. Each CBUUID object represents a UUID that identifies the type of service you want to discover.

Discussion ¶

You can provide an array of CBUUID objects—representing service UUIDs—in the `serviceUUIDs` parameter. When you do, the peripheral returns only the services of the peripheral that match the provided UUIDs.

When the peripheral discovers one or more services, it calls the [PeripheralDidDiscoverServices]: method of its delegate object. After a peripheral discovers services, you can access them through the peripheral’s CBPeripheral.Services property.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/discoverServices(_:)

func (CBPeripheral) Init ¶

func (c CBPeripheral) Init() CBPeripheral

Init initializes the instance.

func (CBPeripheral) MaximumWriteValueLengthForType ¶

func (c CBPeripheral) MaximumWriteValueLengthForType(type_ CBCharacteristicWriteType) uint

The maximum amount of data, in bytes, you can send to a characteristic in a single write type.

type: The characteristic write type to inspect.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/maximumWriteValueLength(for:)

func (CBPeripheral) Name ¶

func (c CBPeripheral) Name() string

The name of the peripheral.

Discussion ¶

Use this property to retrieve a human-readable name of the peripheral. A peripheral may have two different name types: one that the device advertises and another that the device publishes in its database as its Bluetooth low energy Generic Access Profile (GAP) device name. If a peripheral has both types of names, this property returns its GAP device name.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/name

func (CBPeripheral) OpenL2CAPChannel ¶

func (c CBPeripheral) OpenL2CAPChannel(PSM CBL2CAPPSM)

Attempts to open an L2CAP channel to the peripheral using the supplied Protocol/Service Multiplexer (PSM).

PSM: The PSM of the channel to open.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/openL2CAPChannel(_:)

func (CBPeripheral) ReadRSSI ¶

func (c CBPeripheral) ReadRSSI()

Retrieves the current RSSI value for the peripheral while connected to the central manager.

Discussion ¶

On macOS, when you call this method to retrieve the Received Signal Strength Indicator (RSSI) of the peripheral while connected to the central manager, the peripheral calls the peripheralDidUpdateRSSI(_:error:) method of its delegate object. If retrieving the RSSI value of the peripheral succeeds, you can access it through the peripheral’s rssi property.

On iOS and tvOS, when you call this method to retrieve the RSSI of the peripheral while connected to the central manager, the peripheral calls the [PeripheralDidReadRSSIError] method of its delegate object, which includes the RSSI value as a parameter.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/readRSSI()

func (CBPeripheral) ReadValueForCharacteristic ¶

func (c CBPeripheral) ReadValueForCharacteristic(characteristic ICBCharacteristic)

Retrieves the value of a specified characteristic.

characteristic: The characteristic whose value you want to read.

Discussion ¶

When you call this method to read the value of a characteristic, the peripheral calls the [PeripheralDidUpdateValueForDescriptorError] method of its delegate object. If the peripheral successfully reads the value of the characteristic, you can access it through the characteristic’s CBCharacteristic.Value property.

Not all characteristics have a readable value. You can determine whether a characteristic’s value is readable by accessing the relevant properties of the CBCharacteristicProperties enumeration.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/readValue(for:)-6u2kr

func (CBPeripheral) ReadValueForDescriptor ¶

func (c CBPeripheral) ReadValueForDescriptor(descriptor ICBDescriptor)

Retrieves the value of a specified characteristic descriptor.

descriptor: The characteristic descriptor whose value you want to read.

Discussion ¶

When you call this method to read the value of a characteristic descriptor, the peripheral calls the [PeripheralDidUpdateValueForDescriptorError] method of its delegate object. If the peripheral successfully retrieves the value of the characteristic descriptor, you can access it through the characteristic descriptor’s CBDescriptor.Value property.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/readValue(for:)-91hhp

func (CBPeripheral) Services ¶

func (c CBPeripheral) Services() []CBService

A list of a peripheral’s discovered services.

Discussion ¶

Returns an array of services (represented by CBService objects) that successful call to the CBPeripheral.DiscoverServices method discovered. If you haven’t yet called the CBPeripheral.DiscoverServices method to discover the services of the peripheral, or if there was an error in doing so, the value of this property is `nil`.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/services

func (CBPeripheral) SetDelegate ¶

func (c CBPeripheral) SetDelegate(value CBPeripheralDelegate)

func (CBPeripheral) SetNotifyValueForCharacteristic ¶

func (c CBPeripheral) SetNotifyValueForCharacteristic(enabled bool, characteristic ICBCharacteristic)

Sets notifications or indications for the value of a specified characteristic.

enabled: A Boolean value that indicates whether to receive notifications or indications whenever the characteristic’s value changes. true if you want to enable notifications or indications for the characteristic’s value. false if you don’t want to receive notifications or indications whenever the characteristic’s value changes.

characteristic: The specified characteristic.

Discussion ¶

When you enable notifications for the characteristic’s value, the peripheral calls the [PeripheralDidUpdateNotificationStateForCharacteristicError] method of its delegate object to indicate if the action succeeded. If successful, the peripheral then calls the [PeripheralDidUpdateValueForDescriptorError] method of its delegate object whenever the characteristic value changes. Because the peripheral chooses when it sends an update, your app should prepare to handle them as long as notifications or indications remain enabled. If the specified characteristic’s configuration allows both notifications and indications, calling this method enables notifications only. You can disable notifications and indications for a characteristic’s value by calling this method with the `enabled` parameter set to false.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/setNotifyValue(_:for:)

func (CBPeripheral) State ¶

func (c CBPeripheral) State() CBPeripheralState

The connection state of the peripheral.

Discussion ¶

This property represents the current connection state of the peripheral. For a list of the possible values, see CBPeripheralState.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/state

func (CBPeripheral) WriteValueForCharacteristicType ¶

func (c CBPeripheral) WriteValueForCharacteristicType(data foundation.NSData, characteristic ICBCharacteristic, type_ CBCharacteristicWriteType)

Writes the value of a characteristic.

data: The value to write.

characteristic: The characteristic containing the value to write.

type: The type of write to execute. For a list of the possible types of writes to a characteristic’s value, see CBCharacteristicWriteType.

Discussion ¶

When you call this method to write the value of a characteristic, the peripheral calls the [PeripheralDidWriteValueForDescriptorError] method of its delegate object only if you specified the write type as CBCharacteristicWriteType.withResponse. The response you receive through the [PeripheralDidWriteValueForDescriptorError] delegate method indicates whether the write was successful; if the write failed, it details the cause of the failure in an error.

On the other hand, if you specify the write type as CBCharacteristicWriteType.withoutResponse, Core Bluetooth attempts to write the value but doesn’t guarantee success. If the write doesn’t succeed in this case, you aren’t notified and you don’t receive an error indicating the cause of the failure.

Use the CBCharacteristicPropertyWrite and CBCharacteristicPropertyWriteWithoutResponse members of the characteristic’s CBCharacteristic.Properties enumeration to determine which kinds of writes you can perform.

This method copies the data passed into the `data` parameter, and you can dispose of it after the method returns.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/writeValue(_:for:type:)

func (CBPeripheral) WriteValueForDescriptor ¶

func (c CBPeripheral) WriteValueForDescriptor(data foundation.NSData, descriptor ICBDescriptor)

Writes the value of a characteristic descriptor.

data: The value to write.

descriptor: The descriptor containing the value to write.

Discussion ¶

When you call this method to write the value of a characteristic descriptor, the peripheral calls the [PeripheralDidWriteValueForDescriptorError] method of its delegate object.

This method copies the `data` passed into the data parameter, and you can dispose of it after the method returns.

You can’t use this method to write the value of a client configuration descriptor (represented by the CBUUIDClientCharacteristicConfigurationString constant), which describes the configuration of notification or indications for a characteristic’s value. If you want to manage notifications or indications for a characteristic’s value, you must use the CBPeripheral.SetNotifyValueForCharacteristic method instead.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheral/writeValue(_:for:)

func (CBPeripheralClass) Alloc ¶

func (cc CBPeripheralClass) Alloc() CBPeripheral

Alloc allocates memory for a new instance of the class.

func (CBPeripheralClass) Class ¶

func (cc CBPeripheralClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CBPeripheralDelegateObject) BaseObject ¶

func (o CBPeripheralDelegateObject) BaseObject() objectivec.Object

func (CBPeripheralDelegateObject) PeripheralDidCompleteChannelSoundingSession ¶

func (o CBPeripheralDelegateObject) PeripheralDidCompleteChannelSoundingSession(peripheral ICBPeripheral, error_ foundation.NSError)

peripheral: The peripheral providing this update.

error: If an error occurred, the cause of the failure.

Discussion ¶

This method is called when a channel sounding session completes.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheral(_:didCompleteChannelSoundingSession:)

func (CBPeripheralDelegateObject) PeripheralDidDiscoverCharacteristicsForServiceError ¶

func (o CBPeripheralDelegateObject) PeripheralDidDiscoverCharacteristicsForServiceError(peripheral ICBPeripheral, service ICBService, error_ foundation.NSError)

Tells the delegate that the peripheral found characteristics for a service.

peripheral: The peripheral providing this information.

service: The service to which the characteristics belong.

error: The reason the call failed, or `nil` if no error occurred.

Discussion ¶

Core Bluetooth invokes this method when your app calls the CBPeripheral.DiscoverCharacteristicsForService method. If the peripheral successfully discovers the characteristics of the specified service, you can access them through the service’s CBService.Characteristics property. If successful, the `error` parameter is `nil`. If unsuccessful, the `error` parameter returns the cause of the failure.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheral(_:didDiscoverCharacteristicsFor:error:)

func (CBPeripheralDelegateObject) PeripheralDidDiscoverDescriptorsForCharacteristicError ¶

func (o CBPeripheralDelegateObject) PeripheralDidDiscoverDescriptorsForCharacteristicError(peripheral ICBPeripheral, characteristic ICBCharacteristic, error_ foundation.NSError)

Tells the delegate that the peripheral found descriptors for a characteristic.

peripheral: The peripheral providing this information.

characteristic: The characteristic to which the characteristic descriptors belong.

error: The reason the call failed, or `nil` if no error occurred.

Discussion ¶

Core Bluetooth invokes this method when your app calls the CBPeripheral.DiscoverDescriptorsForCharacteristic method. If the peripheral successfully discovers the descriptors of the specified characteristic, you can access them through the characteristic’s CBCharacteristic.Descriptors property. If successful, the `error` parameter is `nil`. If unsuccessful, the `error` parameter returns the cause of the failure.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheral(_:didDiscoverDescriptorsFor:error:)

func (CBPeripheralDelegateObject) PeripheralDidDiscoverIncludedServicesForServiceError ¶

func (o CBPeripheralDelegateObject) PeripheralDidDiscoverIncludedServicesForServiceError(peripheral ICBPeripheral, service ICBService, error_ foundation.NSError)

Tells the delegate that discovering included services within the indicated service completed.

peripheral: The peripheral providing this information.

service: The CBService object containing the included service.

error: The reason the call failed, or `nil` if no error occurred.

Discussion ¶

Core Bluetooth invokes this method when your app calls the CBPeripheral.DiscoverIncludedServicesForService method. If the peripheral successfully discovers services, you can access them through the service’s CBService.IncludedServices property. If successful, the `error` parameter is `nil`. If unsuccessful, the `error` parameter returns the cause of the failure.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheral(_:didDiscoverIncludedServicesFor:error:)

func (CBPeripheralDelegateObject) PeripheralDidDiscoverServices ¶

func (o CBPeripheralDelegateObject) PeripheralDidDiscoverServices(peripheral ICBPeripheral, error_ foundation.NSError)

Tells the delegate that peripheral service discovery succeeded.

peripheral: The peripheral to which the services belong.

error: The reason the call failed, or `nil` if no error occurred.

Discussion ¶

Core Bluetooth invokes this method when your app calls the CBPeripheral.DiscoverServices method. If the peripheral successfully discovers services, you can access them through the peripheral’s CBPeripheral.Services property. If successful, the `error` parameter is `nil`. If unsuccessful, the `error` parameter returns the cause of the failure.

For more information, see Core Bluetooth Programming Guide.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheral(_:didDiscoverServices:)

func (CBPeripheralDelegateObject) PeripheralDidModifyServices ¶

func (o CBPeripheralDelegateObject) PeripheralDidModifyServices(peripheral ICBPeripheral, invalidatedServices []CBService)

Tells the delegate that a peripheral’s services changed.

peripheral: The peripheral providing this information.

invalidatedServices: A list of services invalidated by this change.

Discussion ¶

Core Bluetooth invokes this method whenever one or more services of a peripheral change. A peripheral’s services have changed if:

- The peripheral removes a service from its database. - The peripheral adds a new service to its database. - The peripheral adds back a previously-removed service, but at a different location in the database.

The `invalidatedServices` parameter includes any changed services that you previously discovered; you can no longer use these services. You can use the CBPeripheral.DiscoverServices method to discover any new services that the peripheral added to its database. Use this same method to find out whether any of the invalidated services that you were using (and want to continue using) now have a different location in the peripheral’s database.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheral(_:didModifyServices:)

func (CBPeripheralDelegateObject) PeripheralDidOpenL2CAPChannelError ¶

func (o CBPeripheralDelegateObject) PeripheralDidOpenL2CAPChannelError(peripheral ICBPeripheral, channel ICBL2CAPChannel, error_ foundation.NSError)

Delivers the result of an attempt to open an L2CAP channel.

Discussion ¶

This method delivers the result of a previous call to CBPeripheral.OpenL2CAPChannel.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheral(_:didOpen:error:)

func (CBPeripheralDelegateObject) PeripheralDidReadRSSIError ¶

func (o CBPeripheralDelegateObject) PeripheralDidReadRSSIError(peripheral ICBPeripheral, RSSI foundation.NSNumber, error_ foundation.NSError)

Tells the delegate that retrieving the value of the peripheral’s current Received Signal Strength Indicator (RSSI) succeeded.

peripheral: The peripheral providing this information.

RSSI: The RSSI, in decibels, of the peripheral.

error: The reason the call failed, or `nil` if no error occurred.

Discussion ¶

Core Bluetooth invokes this method when your app calls the CBPeripheral.ReadRSSI method, while the peripheral is connected to the central manager. If successful, the `error` parameter is `nil` and the parameter [RSSI] reports the peripheral’s signal strength, in decibels. If unsuccessful, the `error` parameter returns the cause of the failure.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheral(_:didReadRSSI:error:)

func (CBPeripheralDelegateObject) PeripheralDidReceiveChannelSoundingProcedureResultsError ¶

func (o CBPeripheralDelegateObject) PeripheralDidReceiveChannelSoundingProcedureResultsError(peripheral ICBPeripheral, results *uintptr, error_ foundation.NSError)

peripheral: The peripheral providing this update.

results: An object containing the results of a channel sounding procedure.

error: If an error occurred, the cause of the failure.

Discussion ¶

This method returns the results of a channel sounding procedure.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheral(_:didReceive:error:)

func (CBPeripheralDelegateObject) PeripheralDidUpdateName ¶

func (o CBPeripheralDelegateObject) PeripheralDidUpdateName(peripheral ICBPeripheral)

Tells the delegate that a peripheral’s name changed.

peripheral: The peripheral providing this information.

Discussion ¶

Core Bluetooth invokes this method whenever the peripheral’s Generic Access Profile (GAP) device name changes. Since a peripheral device can change its GAP device name, you can implement this method if your app needs to display the current name of the peripheral device.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheralDidUpdateName(_:)

func (CBPeripheralDelegateObject) PeripheralDidUpdateNotificationStateForCharacteristicError ¶

func (o CBPeripheralDelegateObject) PeripheralDidUpdateNotificationStateForCharacteristicError(peripheral ICBPeripheral, characteristic ICBCharacteristic, error_ foundation.NSError)

Tells the delegate that the peripheral received a request to start or stop providing notifications for a specified characteristic’s value.

peripheral: The peripheral providing this information.

characteristic: The characteristic for which to configure value notifications.

error: The reason the call failed, or `nil` if no error occurred.

Discussion ¶

Core Bluetooth invokes this method when your app calls the CBPeripheral.SetNotifyValueForCharacteristic method. If successful, the `error` parameter is `nil`. If unsuccessful, the `error` parameter returns the cause of the failure.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheral(_:didUpdateNotificationStateFor:error:)

func (CBPeripheralDelegateObject) PeripheralDidUpdateValueForCharacteristicError ¶

func (o CBPeripheralDelegateObject) PeripheralDidUpdateValueForCharacteristicError(peripheral ICBPeripheral, characteristic ICBCharacteristic, error_ foundation.NSError)

Tells the delegate that retrieving the specified characteristic’s value succeeded, or that the characteristic’s value changed.

peripheral: The peripheral providing this information.

characteristic: The characteristic containing the value.

error: The reason the call failed, or `nil` if no error occurred.

Discussion ¶

Core Bluetooth invokes this method when your app calls the CBPeripheral.ReadValueForDescriptor method. A peripheral also invokes this method to notify your app of a change to the value of the characteristic for which the app previously enabled notifications by calling CBPeripheral.SetNotifyValueForCharacteristic. If successful, the `error` parameter is `nil`. If unsuccessful, the `error` parameter returns the cause of the failure.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheral(_:didUpdateValueFor:error:)-1xyna

func (CBPeripheralDelegateObject) PeripheralDidUpdateValueForDescriptorError ¶

func (o CBPeripheralDelegateObject) PeripheralDidUpdateValueForDescriptorError(peripheral ICBPeripheral, descriptor ICBDescriptor, error_ foundation.NSError)

Tells the delegate that retrieving a specified characteristic descriptor’s value succeeded.

peripheral: The peripheral providing this information.

descriptor: The characteristic descriptor containing the value.

error: The reason the call failed, or `nil` if no error occurred.

Discussion ¶

Core Bluetooth invokes this method when your app calls the CBPeripheral.ReadValueForDescriptor method. If successful, the `error` parameter is `nil`. If unsuccessful, the `error` parameter returns the cause of the failure.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheral(_:didUpdateValueFor:error:)-1t3wm

func (CBPeripheralDelegateObject) PeripheralDidWriteValueForCharacteristicError ¶

func (o CBPeripheralDelegateObject) PeripheralDidWriteValueForCharacteristicError(peripheral ICBPeripheral, characteristic ICBCharacteristic, error_ foundation.NSError)

Tells the delegate that the peripheral successfully set a value for the characteristic.

peripheral: The peripheral providing this information.

characteristic: The characteristic containing the value.

error: The reason the call failed, or `nil` if no error occurred.

Discussion ¶

Core Bluetooth invokes this method only when your app calls the CBPeripheral.WriteValueForCharacteristicType method with the CBCharacteristicWriteType.withResponse constant specified as the write type. If successful, the `error` parameter is `nil`. If unsuccessful, the `error` parameter returns the cause of the failure.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheral(_:didWriteValueFor:error:)-4f5ea

func (CBPeripheralDelegateObject) PeripheralDidWriteValueForDescriptorError ¶

func (o CBPeripheralDelegateObject) PeripheralDidWriteValueForDescriptorError(peripheral ICBPeripheral, descriptor ICBDescriptor, error_ foundation.NSError)

Tells the delegate that the peripheral successfully set a value for the descriptor.

peripheral: The peripheral providing this information.

descriptor: The characteristic descriptor containing the value.

error: The reason the call failed, or `nil` if no error occurred.

Discussion ¶

Core Bluetooth invokes this method when your app calls the CBPeripheral.WriteValueForDescriptor method. If successful, the `error` parameter is `nil`. If unsuccessful, the `error` parameter returns the cause of the failure.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheral(_:didWriteValueFor:error:)-1ybl3

func (CBPeripheralDelegateObject) PeripheralIsReadyToSendWriteWithoutResponse ¶

func (o CBPeripheralDelegateObject) PeripheralIsReadyToSendWriteWithoutResponse(peripheral ICBPeripheral)

Tells the delegate that a peripheral is again ready to send characteristic updates.

peripheral: The peripheral providing this update.

Discussion ¶

The peripheral calls this delegate method after a failed call to CBPeripheral.WriteValueForCharacteristicType, once `peripheral` is ready to send characteristic value updates.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralDelegate/peripheralIsReady(toSendWriteWithoutResponse:)

func (CBPeripheralManager) AddService ¶

func (c CBPeripheralManager) AddService(service ICBMutableService)

Publishes a service and any of its associated characteristics and characteristic descriptors to the local GATT database.

service: The service you want to publish.

Discussion ¶

When you add a service to the database, the peripheral manager calls the [PeripheralManagerDidAddServiceError] method of its delegate object. If the service contains any included services, you must first publish them.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManager/add(_:)

func (CBPeripheralManager) Autorelease ¶

func (c CBPeripheralManager) Autorelease() CBPeripheralManager

Autorelease adds the receiver to the current autorelease pool.

func (CBPeripheralManager) Delegate ¶

func (c CBPeripheralManager) Delegate() CBPeripheralManagerDelegate

The delegate object specified to receive peripheral events.

Discussion ¶

For information about how to implement your peripheral manager delegate, see CBPeripheralManagerDelegate.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManager/delegate

func (CBPeripheralManager) Init ¶

func (c CBPeripheralManager) Init() CBPeripheralManager

Init initializes the instance.

func (CBPeripheralManager) InitWithDelegateQueue ¶

func (c CBPeripheralManager) InitWithDelegateQueue(delegate CBPeripheralManagerDelegate, queue dispatch.Queue) CBPeripheralManager

Initializes the peripheral manager with a specified delegate and dispatch queue.

delegate: The delegate to receive the peripheral role events.

queue: The dispatch queue for dispatching the peripheral role events. If the value is `nil`, the peripheral manager dispatches peripheral role events using the main queue.

Return Value ¶

Returns a newly initialized peripheral manager.

Discussion ¶

For more information, see Core Bluetooth Programming Guide.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManager/init(delegate:queue:)

func (CBPeripheralManager) InitWithDelegateQueueOptions ¶

func (c CBPeripheralManager) InitWithDelegateQueueOptions(delegate CBPeripheralManagerDelegate, queue dispatch.Queue, options foundation.INSDictionary) CBPeripheralManager

Initializes the peripheral manager with a specified delegate, dispatch queue, and initialization options.

delegate: The delegate to receive the peripheral role events.

queue: The dispatch queue for dispatching the peripheral role events. If the value is `nil`, the peripheral manager dispatches peripheral role events using the main queue.

options: An optional dictionary containing initialization options for a peripheral manager. For available options, see Peripheral Manager Initialization Options.

Return Value ¶

Returns a newly initialized peripheral manager.

Discussion ¶

This method is the designated initializer for the CBPeripheralManager class.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManager/init(delegate:queue:options:)

func (CBPeripheralManager) IsAdvertising ¶

func (c CBPeripheralManager) IsAdvertising() bool

A Boolean value that indicates whether the peripheral is advertising data.

Discussion ¶

This value is true if the peripheral is advertising data as a result of successfully calling the CBPeripheralManager.StartAdvertising method. The value is false if the peripheral is no longer advertising its data.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManager/isAdvertising

func (CBPeripheralManager) PublishL2CAPChannelWithEncryption ¶

func (c CBPeripheralManager) PublishL2CAPChannelWithEncryption(encryptionRequired bool)

Creates a listener for incoming L2CAP channel connections.

encryptionRequired: true if the service requires link encryption before a stream can be established. false if the service supports use over an unsecured link.

Discussion ¶

The system determines an unused Protocol and Service Multiplexer (PSM) at the time of publishing, and provides it to your app with [PeripheralManagerDidPublishL2CAPChannelError]. L2CAP channels aren’t discoverable by themselves, so it’s the app’s responsibility to handle PSM discovery on the client.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManager/publishL2CAPChannel(withEncryption:)

func (CBPeripheralManager) RemoveAllServices ¶

func (c CBPeripheralManager) RemoveAllServices()

Removes all published services from the local GATT database.

Discussion ¶

Use this when you want to remove all services you’ve previously published, for example, if your app has a toggle button to expose GATT services.

Because apps on the local peripheral device share the GATT database, this method removes only the services that you added using the CBPeripheralManager.AddService method. This call doesn’t remove any services published by other apps on the local peripheral device.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManager/removeAllServices()

func (CBPeripheralManager) RemoveService ¶

func (c CBPeripheralManager) RemoveService(service ICBMutableService)

Removes a specified published service from the local GATT database.

service: The service you want to remove.

Discussion ¶

Because apps on the local peripheral device share the GATT database, more than one instance of a service may exist in the database. As a result, this method removes only the instance of the service that your app added to the database (using the CBPeripheralManager.AddService method). If any other services contains this service, you must first remove them.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManager/remove(_:)

func (CBPeripheralManager) RespondToRequestWithResult ¶

func (c CBPeripheralManager) RespondToRequestWithResult(request ICBATTRequest, result CBATTError)

Responds to a read or write request from a connected central.

request: The read or write request received from the connected central. For more information about read and write requests, see CBATTRequest.

result: The result of attempting to fulfill the request. For a list of possible results, see Deprecated Constants.

Discussion ¶

When the peripheral manager receives a request from a connected central to read or write a characteristic’s value, it calls the [PeripheralManagerDidReceiveReadRequest] or [PeripheralManagerDidReceiveWriteRequests] method of its delegate object. To respond to the corresponding read or write request, you call this method whenever you recevie one of these delegate method callbacks.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManager/respond(to:withResult:)

func (CBPeripheralManager) SetDelegate ¶

func (c CBPeripheralManager) SetDelegate(value CBPeripheralManagerDelegate)

func (CBPeripheralManager) SetDesiredConnectionLatencyForCentral ¶

func (c CBPeripheralManager) SetDesiredConnectionLatencyForCentral(latency CBPeripheralManagerConnectionLatency, central ICBCentral)

Sets the desired connection latency for an existing connection to a central device.

latency: The desired connection latency. For a list of the possible connection latency values that you may set for the peripheral manager, see CBPeripheralManagerConnectionLatency.

central: The central to which the peripheral manager is currently connected.

Discussion ¶

The latency of a peripheral-central connection controls how frequently the peripheral and the peripheral’s connected central can exchange messages. By setting a desired connection latency, you manage the relationship between the frequency of the data exchange and the resulting battery performance of the peripheral device. When you call this method to set the connection latency, note that connection latency changes aren’t guaranteed. As a result, the latency may vary. If you don’t explicitly set a latency, the central device uses the connection latency it chose when establishing the connection. Typically, you don’t need to change the connection latency.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManager/setDesiredConnectionLatency(_:for:)

func (CBPeripheralManager) StartAdvertising ¶

func (c CBPeripheralManager) StartAdvertising(advertisementData foundation.INSDictionary)

Advertises peripheral manager data.

advertisementData: An optional dictionary containing the data you want to advertise. The peripheral manager only supports two keys: CBAdvertisementDataLocalNameKey and CBAdvertisementDataServiceUUIDsKey.

Discussion ¶

When you start advertising peripheral data, the peripheral manager calls the [PeripheralManagerDidStartAdvertisingError] method of its delegate object.

Core Bluetooth advertises data on a “best effort” basis, due to limited space and because there may be multiple apps advertising simultaneously. While in the foreground, your app can use up to 28 bytes of space in the initial advertisement data for any combination of the supported advertising data keys. If no this space remains, there’s an additional 10 bytes of space in the scan response, usable only for the local name (represented by the value of the CBAdvertisementDataLocalNameKey key). Note that these sizes don’t include the 2 bytes of header information required for each new data type.

Any service UUIDs contained in the value of the CBAdvertisementDataServiceUUIDsKey key that don’t fit in the allotted space go to a special “overflow” area. These services are discoverable only by an iOS device explicitly scanning for them.

While your app is in the background, the local name isn’t advertised and all service UUIDs are in the overflow area.

For details about the format of advertising and response data, see the Bluetooth 4.0 specification, Volume 3, Part C, Section 11.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManager/startAdvertising(_:)

func (CBPeripheralManager) StopAdvertising ¶

func (c CBPeripheralManager) StopAdvertising()

Stops advertising peripheral manager data.

Discussion ¶

Call this method when you no longer want to advertise peripheral manager data.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManager/stopAdvertising()

func (CBPeripheralManager) UnpublishL2CAPChannel ¶

func (c CBPeripheralManager) UnpublishL2CAPChannel(PSM CBL2CAPPSM)

Removes a published service from the local system.

PSM: The Protocol and Service Multiplexer (PSM) to remove from the system.

Discussion ¶

After you make this call, the peripheral manager accepts no new connections for this PSM, and closes any existing L2CAP channels using this PSM.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManager/unpublishL2CAPChannel(_:)

func (CBPeripheralManager) UpdateValueForCharacteristicOnSubscribedCentrals ¶

func (c CBPeripheralManager) UpdateValueForCharacteristicOnSubscribedCentrals(value foundation.NSData, characteristic ICBMutableCharacteristic, centrals []CBCentral) bool

Send an updated characteristic value to one or more subscribed centrals, using a notification or indication.

value: The characteristic value you want to send via a notification or indication.

characteristic: The characteristic whose value has changed.

centrals: A list of centrals (represented by CBCentral objects) that have subscribed to receive updates of the characteristic’s value. If `nil`, the manager updates all subscribed centrals. The manager ignores any centrals that haven’t subscribed to the characteristic’s value.

Return Value ¶

This value is true if the update is successfully sent to the subscribed central or centrals. false if the update isn’t successfully sent because the underlying transmit queue is full.

Discussion ¶

You use this method to send updates of a characteristic’s value—through a notification or indication—to selected centrals that have subscribed to that characteristic’s value. If the method returns false because the underlying transmit queue is full, the peripheral manager calls the [PeripheralManagerIsReadyToUpdateSubscribers] method of its delegate object when more space in the transmit queue becomes available. After you receive this delegate method callback, you may resend the update.

If the length of the `value` parameter exceeds the length of the CBCentral.MaximumUpdateValueLength property of a subscribed CBCentral, the `value` parameter truncates accordingly.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManager/updateValue(_:for:onSubscribedCentrals:)

func (CBPeripheralManagerAuthorizationStatus) String ¶

func (e CBPeripheralManagerAuthorizationStatus) String() string

func (CBPeripheralManagerClass) Alloc ¶

func (cc CBPeripheralManagerClass) Alloc() CBPeripheralManager

Alloc allocates memory for a new instance of the class.

func (CBPeripheralManagerClass) Class ¶

func (cc CBPeripheralManagerClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CBPeripheralManagerConnectionLatency) String ¶

func (e CBPeripheralManagerConnectionLatency) String() string

func (CBPeripheralManagerDelegateObject) BaseObject ¶

func (o CBPeripheralManagerDelegateObject) BaseObject() objectivec.Object

func (CBPeripheralManagerDelegateObject) PeripheralManagerCentralDidSubscribeToCharacteristic ¶

func (o CBPeripheralManagerDelegateObject) PeripheralManagerCentralDidSubscribeToCharacteristic(peripheral ICBPeripheralManager, central ICBCentral, characteristic ICBCharacteristic)

Tells the delegate that a remote central device subscribed to a characteristic’s value.

peripheral: The peripheral manager connected to the remote central.

central: The remote central device that subscribed to the characteristic’s value.

characteristic: The characteristic subscribed to.

Discussion ¶

Core Bluetooth invokes this method when a remote central device subscribes to the value of one of the local peripheral’s characteristics, by enabling notifications or indications on the characteristic’s value. When called, start sending the subscribed central updates as the characteristic’s value changes. To send updated characteristic values to subscribed centrals, use the CBPeripheralManager.UpdateValueForCharacteristicOnSubscribedCentrals method of the CBPeripheralManager class.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManagerDelegate/peripheralManager(_:central:didSubscribeTo:)

func (CBPeripheralManagerDelegateObject) PeripheralManagerCentralDidUnsubscribeFromCharacteristic ¶

func (o CBPeripheralManagerDelegateObject) PeripheralManagerCentralDidUnsubscribeFromCharacteristic(peripheral ICBPeripheralManager, central ICBCentral, characteristic ICBCharacteristic)

Tells the delegate that a remote central device unsubscribed from a characteristic’s value.

peripheral: The peripheral manager connected to the remote central.

central: The remote central device that subscribed to the characteristic’s value.

characteristic: The characteristic unsubscribed from.

Discussion ¶

Core Bluetooth calls this method when a remote central device unsubscribes from the value of one of the local peripheral’s characteristics, by disabling notifications or indications on the characteristic’s value. When called, stop sending the subscribed central updates of updates to the characteristic’s value.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManagerDelegate/peripheralManager(_:central:didUnsubscribeFrom:)

func (CBPeripheralManagerDelegateObject) PeripheralManagerDidAddServiceError ¶

func (o CBPeripheralManagerDelegateObject) PeripheralManagerDidAddServiceError(peripheral ICBPeripheralManager, service ICBService, error_ foundation.NSError)

Tells the delegate the peripheral manager published a service to the local GATT database.

peripheral: The peripheral manager adding the service.

service: The service added to the local GATT database.

error: The reason the call failed, or `nil` if no error occurred.

Discussion ¶

Core Bluetooth invokes this method when your app calls the CBPeripheralManager.AddService method to publish a service to the local peripheral’s GATT database. If the service published successfully to the local database, the `error` parameter is `nil`. If unsuccessful, the `error` parameter provides the cause of the failure.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManagerDelegate/peripheralManager(_:didAdd:error:)

func (CBPeripheralManagerDelegateObject) PeripheralManagerDidOpenL2CAPChannelError ¶

func (o CBPeripheralManagerDelegateObject) PeripheralManagerDidOpenL2CAPChannelError(peripheral ICBPeripheralManager, channel ICBL2CAPChannel, error_ foundation.NSError)

Tells the delegate that the peripheral manager opened an L2CAP channel.

peripheral: The peripheral manager that opened the channel.

channel: The channel opened by the manager.

error: The error that occurred, or `nil` if no error occurred.

Discussion ¶

The peripheral manager calls this method after you call CBPeripheralManager.PublishL2CAPChannelWithEncryption.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManagerDelegate/peripheralManager(_:didOpen:error:)

func (CBPeripheralManagerDelegateObject) PeripheralManagerDidPublishL2CAPChannelError ¶

func (o CBPeripheralManagerDelegateObject) PeripheralManagerDidPublishL2CAPChannelError(peripheral ICBPeripheralManager, PSM CBL2CAPPSM, error_ foundation.NSError)

Tells the delegate that the peripheral manager created a listener for incoming L2CAP channel connections.

peripheral: The peripheral manager that published the channel.

PSM: The Protocol/Service Multiplexer (PSM) of the published channel.

error: The error that prevented publishing, or `nil` if no error occurred.

Discussion ¶

The peripheral manager calls this method after you call CBPeripheralManager.PublishL2CAPChannelWithEncryption. The [PSM] parameter contains the PSM assigned for the published channel.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManagerDelegate/peripheralManager(_:didPublishL2CAPChannel:error:)

func (CBPeripheralManagerDelegateObject) PeripheralManagerDidReceiveReadRequest ¶

func (o CBPeripheralManagerDelegateObject) PeripheralManagerDidReceiveReadRequest(peripheral ICBPeripheralManager, request ICBATTRequest)

Tells the delegate that a local peripheral received an Attribute Protocol (ATT) read request for a characteristic with a dynamic value.

peripheral: The peripheral manager that received the request.

request: A CBATTRequest object that represents a request to read a characteristic’s value.

Discussion ¶

When you receive this callback, call the CBPeripheralManager.RespondToRequestWithResult method of the CBPeripheralManager class exactly once to respond to the read request.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManagerDelegate/peripheralManager(_:didReceiveRead:)

func (CBPeripheralManagerDelegateObject) PeripheralManagerDidReceiveWriteRequests ¶

func (o CBPeripheralManagerDelegateObject) PeripheralManagerDidReceiveWriteRequests(peripheral ICBPeripheralManager, requests []CBATTRequest)

Tells the delegate that a local peripheral device received an Attribute Protocol (ATT) write request for a characteristic with a dynamic value.

peripheral: The peripheral manager that received the request.

requests: A list of one or more CBATTRequest objects, each representing a request to write the value of a characteristic.

Discussion ¶

In the same way that you respond to a read request, each time you receive this callback, call the CBPeripheralManager.RespondToRequestWithResult method of the CBPeripheralManager class exactly once. If the `requests` parameter contains multiple requests, treat them as you would a single request—if you can’t fulfill an individual request, you shouldn’t fulfill any of them. Instead, call the CBPeripheralManager.RespondToRequestWithResult method immediately, and provide a result that indicates the cause of the failure.

When you respond to a write request, note that the first parameter of the CBPeripheralManager.RespondToRequestWithResult method expects a single CBATTRequest object, even though you received an array of them from the [PeripheralManagerDidReceiveWriteRequests] method. To respond properly, pass in the first request of the `requests` array.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManagerDelegate/peripheralManager(_:didReceiveWrite:)

func (CBPeripheralManagerDelegateObject) PeripheralManagerDidStartAdvertisingError ¶

func (o CBPeripheralManagerDelegateObject) PeripheralManagerDidStartAdvertisingError(peripheral ICBPeripheralManager, error_ foundation.NSError)

Tells the delegate the peripheral manager started advertising the local peripheral device’s data.

peripheral: The peripheral manager that is starting advertising.

error: The reason the call failed, or `nil` if no error occurred.

Discussion ¶

Core Bluetooth calls this method when your app calls the CBPeripheralManager.StartAdvertising method to advertise the local peripheral device’s data. If successful, the `error` parameter is `nil`. If a problem prevents advertising the data, the `error` parameter returns the cause of the failure.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManagerDelegate/peripheralManagerDidStartAdvertising(_:error:)

func (CBPeripheralManagerDelegateObject) PeripheralManagerDidUnpublishL2CAPChannelError ¶

func (o CBPeripheralManagerDelegateObject) PeripheralManagerDidUnpublishL2CAPChannelError(peripheral ICBPeripheralManager, PSM CBL2CAPPSM, error_ foundation.NSError)

Tells the delegate that the peripheral manager removed a published service from the local system.

peripheral: The peripheral manager that stopped publishing.

PSM: The Protocol/Service Multiplexer (PSM) of the channel that was unpublished.

error: The error that occurred, or `nil` if no error occurred.

Discussion ¶

The peripheral manager calls this method after you call CBPeripheralManager.UnpublishL2CAPChannel.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManagerDelegate/peripheralManager(_:didUnpublishL2CAPChannel:error:)

func (CBPeripheralManagerDelegateObject) PeripheralManagerDidUpdateState ¶

func (o CBPeripheralManagerDelegateObject) PeripheralManagerDidUpdateState(peripheral ICBPeripheralManager)

Tells the delegate the peripheral manager’s state updated.

peripheral: The peripheral manager whose state has changed.

Discussion ¶

You implement this required method to ensure that Bluetooth low energy is available to use on the local peripheral device.

Issue commands to the peripheral manager only when the peripheral manager is in the powered-on state, as indicated by the CBPeripheralManagerState.poweredOn constant. A state with a value lower than CBPeripheralManagerState.poweredOn implies that advertising has stopped and that any connected centrals have been disconnected. If the state moves below CBPeripheralManagerState.poweredOff, advertising has stopped you must explicitly restart it. In addition, the powered off state clears the local database; in this case you must explicitly re-add all services. For a complete list and discussion of the possible values representing the state of the peripheral manager, see the CBPeripheralManagerState enumeration in CBPeripheralManager.

For more information, see Core Bluetooth Programming Guide.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManagerDelegate/peripheralManagerDidUpdateState(_:)

func (CBPeripheralManagerDelegateObject) PeripheralManagerIsReadyToUpdateSubscribers ¶

func (o CBPeripheralManagerDelegateObject) PeripheralManagerIsReadyToUpdateSubscribers(peripheral ICBPeripheralManager)

Tells the delegate that a local peripheral device is ready to send characteristic value updates.

peripheral: The peripheral manager that sends characteristic value updates.

Discussion ¶

When a call to the CBPeripheralManager.UpdateValueForCharacteristicOnSubscribedCentrals method fails because the underlying queue used to transmit the updated characteristic value is full, Core Bluetooth calls the [PeripheralManagerIsReadyToUpdateSubscribers] method when more space in the transmit queue becomes available. You can then implement this delegate method to resend the value.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManagerDelegate/peripheralManagerIsReady(toUpdateSubscribers:)

func (CBPeripheralManagerDelegateObject) PeripheralManagerWillRestoreState ¶

func (o CBPeripheralManagerDelegateObject) PeripheralManagerWillRestoreState(peripheral ICBPeripheralManager, dict foundation.INSDictionary)

Tells the delegate the system is about to restore the peripheral manager.

peripheral: The peripheral manager undergoing state restoration.

dict: A dictionary that contains information about the peripheral manager, which the system preserved when the app terminated. For the available keys to this dictionary, see Peripheral Manager State Restoration Options.

Discussion ¶

For apps that opt in to the state preservation and restoration feature, Core Bluetooth invokes this method when relaunching your app into the background to complete some Bluetooth-related task. Use this method to synchronize the state of your app with the state of the Bluetooth system.

See: https://developer.apple.com/documentation/CoreBluetooth/CBPeripheralManagerDelegate/peripheralManager(_:willRestoreState:)

func (CBPeripheralManagerState) String ¶

func (e CBPeripheralManagerState) String() string

func (CBPeripheralState) String ¶

func (e CBPeripheralState) String() string

func (CBService) Autorelease ¶

func (c CBService) Autorelease() CBService

Autorelease adds the receiver to the current autorelease pool.

func (CBService) Characteristics ¶

func (c CBService) Characteristics() []CBCharacteristic

A list of characteristics discovered in this service.

Discussion ¶

This array contains CBCharacteristic objects that represent a service’s characteristics. Characteristics provide further details about a peripheral’s service. For example, a heart rate service may contain one characteristic that describes the intended body location of the device’s heart rate sensor, while another characteristic transmits heart rate measurement data.

See: https://developer.apple.com/documentation/CoreBluetooth/CBService/characteristics

func (CBService) IncludedServices ¶

func (c CBService) IncludedServices() []CBService

A list of included services discovered in this service.

Discussion ¶

This array contains CBService objects that represent the included services of a service. A service of a peripheral may contain a reference to other services that are available on the peripheral. These other services are the included services of the service. You discover included services using the CBPeripheral.DiscoverIncludedServicesForService method of the CBPeripheral class.

See: https://developer.apple.com/documentation/CoreBluetooth/CBService/includedServices

func (CBService) Init ¶

func (c CBService) Init() CBService

Init initializes the instance.

func (CBService) IsPrimary ¶

func (c CBService) IsPrimary() bool

A Boolean value that indicates whether the type of service is primary or secondary.

Discussion ¶

A peripheral’s service is either primary or secondary. A primary service describes the primary function of a device. A secondary service describes a service that’s relevant only in the context of another service that references it. For example, the primary service of a heart rate monitor may be to expose heart rate data from the monitor’s heart rate sensor. In this example, a secondary service may be to expose the sensor’s battery data.

If the value of this property is true, the type of service is primary. If the value of this property is false, the type of service is secondary.

See: https://developer.apple.com/documentation/CoreBluetooth/CBService/isPrimary

func (CBService) Peripheral ¶

func (c CBService) Peripheral() ICBPeripheral

The peripheral to which this service belongs.

See: https://developer.apple.com/documentation/CoreBluetooth/CBService/peripheral

func (CBServiceClass) Alloc ¶

func (cc CBServiceClass) Alloc() CBService

Alloc allocates memory for a new instance of the class.

func (CBServiceClass) Class ¶

func (cc CBServiceClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.

func (CBUUID) Autorelease ¶

func (c CBUUID) Autorelease() CBUUID

Autorelease adds the receiver to the current autorelease pool.

func (CBUUID) Data ¶

func (c CBUUID) Data() foundation.NSData

The data of the UUID.

See: https://developer.apple.com/documentation/CoreBluetooth/CBUUID/data

func (CBUUID) Init ¶

func (c CBUUID) Init() CBUUID

Init initializes the instance.

func (CBUUID) UUIDString ¶

func (c CBUUID) UUIDString() string

The UUID represented as a string.

See: https://developer.apple.com/documentation/CoreBluetooth/CBUUID/uuidString

func (CBUUIDClass) Alloc ¶

func (cc CBUUIDClass) Alloc() CBUUID

Alloc allocates memory for a new instance of the class.

func (CBUUIDClass) Class ¶

func (cc CBUUIDClass) Class() objc.Class

Class returns the underlying Objective-C class pointer.