nl::Ble::BleLayer

#include <src/ble/BleLayer.h>

Esta clase proporciona una interfaz para que un solo subproceso impulse los datos hacia arriba en la pila a través de las funciones de interfaz de la plataforma BleLayer o hacia abajo por la pila a través de un objeto WeaveConnection asociado con un BLEEndPoint.

Resumen

Existen dos maneras de asociar un WeaveConnection (definido por WeaveMessageLayer) con una conexión BLE:

Primero, la aplicación puede recibir de forma pasiva una conexión BLE entrante y entregar el BLE_CONNECTION_OBJECT específico de la plataforma que este recibo genera a BleLayer a través de la función de interfaz de la plataforma correspondiente. Esto hace que BleLayer una el BLE_CONNECTION_OBJECT en un BLEEndPoint y notifica a WeaveMessageLayer que se recibió una nueva conexión BLE. Luego, la capa de mensaje une el nuevo objeto BLEEndPoint en una WeaveConnection y entrega este objeto a la aplicación a través de la devolución de llamada OnConnectionReceived de la capa de mensaje.

En segundo lugar, la aplicación puede formar de manera activa una conexión BLE saliente, p.ej., conectándose a un periférico BLE. Luego, crea un WeaveConnection nuevo a través de WeaveMessageLayer, asigna un tipo de autenticación a esta conexión y lo vincula al BLE_CONNECTION_OBJECT para la nueva conexión BLE a través de WeaveConnection::ConnectBle. Luego, esta función establece el tipo de sesión segura que especifica la variable de miembro del tipo de autenticación de WeaveConnection.

Herencia

Subclases conocidas directas:
  nl::Weave::DeviceLayer::Internal::BLEManagerImpl
  nl::Weave::DeviceLayer::Internal::BLEManagerImpl
  nl::Weave::DeviceLayer::Internal::BLEManagerImpl

Constructores y destructores
BleLayer(void)

Tipos públicos
@14 enum
BleConnectionReceivedFunct)(BLEEndPoint *newEndPoint) typedef
void(*

Atributos públicos
OnWeaveBleConnectReceived
BleConnectionReceivedFunct
mAppState
void *
mState
enum nl::Ble::BleLayer::@14
[READ-ONLY] Estado actual

Funciones públicas
HandleConnectionError(BLE_CONNECTION_OBJECT connObj, BLE_ERROR err)
void
HandleIndicationConfirmation(BLE_CONNECTION_OBJECT connObj, const WeaveBleUUID *svcId, const WeaveBleUUID *charId)
bool
Llama cuando un indicador GATT pendiente reciba una confirmación de recepción positiva.
HandleIndicationReceived(BLE_CONNECTION_OBJECT connObj, const WeaveBleUUID *svcId, const WeaveBleUUID *charId, PacketBuffer *pBuf)
bool
Llamada cuando se recibe un indicador GATT.
HandleReadReceived(BLE_CONNECTION_OBJECT connObj, BLE_READ_REQUEST_CONTEXT requestContext, const WeaveBleUUID *svcId, const WeaveBleUUID *charId)
bool
Llama cuando se recibe una solicitud de lectura GATT.
HandleSubscribeComplete(BLE_CONNECTION_OBJECT connObj, const WeaveBleUUID *svcId, const WeaveBleUUID *charId)
bool
Llama cuando se realiza correctamente una solicitud de suscripción GATT.
HandleSubscribeReceived(BLE_CONNECTION_OBJECT connObj, const WeaveBleUUID *svcId, const WeaveBleUUID *charId)
bool
HandleUnsubscribeComplete(BLE_CONNECTION_OBJECT connObj, const WeaveBleUUID *svcId, const WeaveBleUUID *charId)
bool
Llama cuando se realiza correctamente una solicitud de anulación de suscripción de GATT.
HandleUnsubscribeReceived(BLE_CONNECTION_OBJECT connObj, const WeaveBleUUID *svcId, const WeaveBleUUID *charId)
bool
HandleWriteConfirmation(BLE_CONNECTION_OBJECT connObj, const WeaveBleUUID *svcId, const WeaveBleUUID *charId)
bool
Llama cuando una solicitud de escritura GATT pendiente recibe una confirmación de recibo positiva.
HandleWriteReceived(BLE_CONNECTION_OBJECT connObj, const WeaveBleUUID *svcId, const WeaveBleUUID *charId, PacketBuffer *pBuf)
bool
Llama cuando se recibe una solicitud de escritura GATT.
Init(BlePlatformDelegate *platformDelegate, BleApplicationDelegate *appDelegate, Weave::System::Layer *systemLayer)
NewBleEndPoint(BLEEndPoint **retEndPoint, BLE_CONNECTION_OBJECT connObj, BleRole role, bool autoClose)
ScheduleWork(nl::Weave::System::Layer::TimerCompleteFunct aComplete, void *aAppState)
nl::Weave::System::Error
Funciones de la interfaz de la plataforma:
Shutdown(void)

Tipos públicos

@14

 @14

BleConnectionReceivedFunct

void(* BleConnectionReceivedFunct)(BLEEndPoint *newEndPoint)

Atributos públicos

OnWeaveBleConnectReceived

BleConnectionReceivedFunct OnWeaveBleConnectReceived

mAppState

void * mAppState

mState

enum nl::Ble::BleLayer::@14 mState

[READ-ONLY] Estado actual

Funciones públicas

BleLayer

 BleLayer(
  void
)

HandleConnectionError

void HandleConnectionError(
  BLE_CONNECTION_OBJECT connObj,
  BLE_ERROR err
)

HandleIndicationConfirmation

bool HandleIndicationConfirmation(
  BLE_CONNECTION_OBJECT connObj,
  const WeaveBleUUID *svcId,
  const WeaveBleUUID *charId
)

Llama cuando un indicador GATT pendiente reciba una confirmación de recepción positiva.

HandleIndicationReceived

bool HandleIndicationReceived(
  BLE_CONNECTION_OBJECT connObj,
  const WeaveBleUUID *svcId,
  const WeaveBleUUID *charId,
  PacketBuffer *pBuf
)

Llamada cuando se recibe un indicador GATT.

HandleReadReceived

bool HandleReadReceived(
  BLE_CONNECTION_OBJECT connObj,
  BLE_READ_REQUEST_CONTEXT requestContext,
  const WeaveBleUUID *svcId,
  const WeaveBleUUID *charId
)

Llama cuando se recibe una solicitud de lectura GATT.

La plataforma debe llamar a esta función cuando falla cualquier operación anterior realizada por BleLayer a través de BleAdapter, como una solicitud de escritura de característica o un intento de suscripción, o cuando se cierra una conexión BLE.

En la mayoría de los casos, esto hará que Weave cierre la WeaveConnection asociada y le notifique a esa plataforma que ha abandonado la conexión BLE subyacente.

NOTA: Si la aplicación cierra explícitamente una conexión BLE con una WeaveConnection asociada de manera que el cierre de la conexión BLE no generará una llamada de subida a Weave, se debe llamar a HandleConnectionError con err = BLE_ERROR_APP_CLOSED_CONNECTION para evitar la filtración de esta WeaveConnection y su objeto de punto final.

HandleSubscribeComplete

bool HandleSubscribeComplete(
  BLE_CONNECTION_OBJECT connObj,
  const WeaveBleUUID *svcId,
  const WeaveBleUUID *charId
)

Llama cuando se realiza correctamente una solicitud de suscripción GATT.

La plataforma debe llamar a esta función cuando se solicita una anulación de la suscripción de GATT en cualquier característica del servicio de Weave, es decir, cuando se cancela una suscripción GATT existente en una característica del servicio de Weave.

HandleSubscribeReceived

bool HandleSubscribeReceived(
  BLE_CONNECTION_OBJECT connObj,
  const WeaveBleUUID *svcId,
  const WeaveBleUUID *charId
)

HandleUnsubscribeComplete

bool HandleUnsubscribeComplete(
  BLE_CONNECTION_OBJECT connObj,
  const WeaveBleUUID *svcId,
  const WeaveBleUUID *charId
)

Llama cuando se realiza correctamente una solicitud de anulación de suscripción de GATT.

HandleUnsubscribeReceived

bool HandleUnsubscribeReceived(
  BLE_CONNECTION_OBJECT connObj,
  const WeaveBleUUID *svcId,
  const WeaveBleUUID *charId
)

HandleWriteConfirmation

bool HandleWriteConfirmation(
  BLE_CONNECTION_OBJECT connObj,
  const WeaveBleUUID *svcId,
  const WeaveBleUUID *charId
)

Llama cuando una solicitud de escritura GATT pendiente recibe una confirmación de recibo positiva.

HandleWriteReceived

bool HandleWriteReceived(
  BLE_CONNECTION_OBJECT connObj,
  const WeaveBleUUID *svcId,
  const WeaveBleUUID *charId,
  PacketBuffer *pBuf
)

Llama cuando se recibe una solicitud de escritura GATT.

Init

BLE_ERROR Init(
  BlePlatformDelegate *platformDelegate,
  BleApplicationDelegate *appDelegate,
  Weave::System::Layer *systemLayer
)

NewBleEndPoint

BLE_ERROR NewBleEndPoint(
  BLEEndPoint **retEndPoint,
  BLE_CONNECTION_OBJECT connObj,
  BleRole role,
  bool autoClose
)

ScheduleWork

nl::Weave::System::Error ScheduleWork(
  nl::Weave::System::Layer::TimerCompleteFunct aComplete,
  void *aAppState
)

Funciones de la interfaz de la plataforma:

Convenciones de llamada: Weave se hace cargo de los BundlesBuffers recibidos a través de estas funciones y los liberará o pasará la propiedad a la pila.

Más allá de cada llamada, no se proporcionan garantías en cuanto a la vida útil de los argumentos del UUID.

Un valor “true” El valor que devuelve significa que la pila de Weave manejó con éxito el mensaje o la indicación de estado correspondiente. 'false' [falso] significa que la pila de Weave falló o eligió no controlar esto. En caso de "false", La pila de Weave no liberará ni se apropiará de ningún argumento de packageBuffer. Este contrato permite que la plataforma pase eventos BLE a Weave sin necesidad de saber qué características le interesan a Weave.

La plataforma debe llamar a esta función cuando se establece una suscripción GATT para cualquier característica del servicio de Weave.

Si esta función muestra el valor true, Weave aceptó la conexión BLE y la unió en un objeto WeaveConnection. Si Weave acepta una conexión BLE, la plataforma DEBE notificar a Weave si se cancela la suscripción o si se cierra la conexión BLE subyacente, o si la WeaveConnection asociada nunca se cerrará ni liberará.

Cierre

BLE_ERROR Shutdown(
  void
)