Mbed OS Reference
Loading...
Searching...
No Matches

Namespaces

namespace  ble
 Entry namespace for all BLE API definitions.
 

Data Structures

class  GattAttribute
 Representation of a GattServer attribute. More...
 
struct  GattWriteAuthCallbackParams
 GATT write authorization request event. More...
 
struct  GattReadAuthCallbackParams
 GATT read authorization request event. More...
 
struct  GattHVXCallbackParams
 Handle Value Notification/Indication event. More...
 
struct  GattDataSentCallbackParams
 Gatt Data Sent Attribute related events. More...
 
struct  GattUpdatesChangedCallbackParams
 Gatt Updates Changed Attribute related events. More...
 
class  GattCharacteristic
 Representation of a GattServer characteristic. More...
 
class  ReadOnlyGattCharacteristic< T >
 Helper class that represents a read only GattCharacteristic. More...
 
class  WriteOnlyGattCharacteristic< T >
 Helper class that represents a write only GattCharacteristic. More...
 
class  ReadWriteGattCharacteristic< T >
 Helper class that represents a readable and writable GattCharacteristic. More...
 
class  WriteOnlyArrayGattCharacteristic< T, NUM_ELEMENTS >
 Helper class that represents a write-only GattCharacteristic with an array value. More...
 
class  ReadOnlyArrayGattCharacteristic< T, NUM_ELEMENTS >
 Helper class that represents a read-only GattCharacteristic with an array value. More...
 
class  ReadWriteArrayGattCharacteristic< T, NUM_ELEMENTS >
 Helper class that represents a readable and writable GattCharacteristic with an array value. More...
 
class  GattService
 Representation of a GattServer service. More...
 
class  GattServer
 Construct and operates a GATT server. More...
 

Enumerations

enum  GattAuthCallbackReply_t {
  AUTH_CALLBACK_REPLY_SUCCESS = 0x00 , AUTH_CALLBACK_REPLY_ATTERR_INVALID_HANDLE = 0x01 , AUTH_CALLBACK_REPLY_ATTERR_READ_NOT_PERMITTED = 0x02 , AUTH_CALLBACK_REPLY_ATTERR_WRITE_NOT_PERMITTED = 0x03 ,
  AUTH_CALLBACK_REPLY_ATTERR_INVALID_PDU = 0x04 , AUTH_CALLBACK_REPLY_ATTERR_INSUFFICIENT_AUTHENTICATION = 0x05 , AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHENTICATION = 0x05 , AUTH_CALLBACK_REPLY_ATTERR_REQUEST_NOT_SUPPORTED = 0x06 ,
  AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET = 0x07 , AUTH_CALLBACK_REPLY_ATTERR_INSUFFICIENT_AUTHORIZATION = 0x08 , AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHORIZATION = 0x08 , AUTH_CALLBACK_REPLY_ATTERR_PREPARE_QUEUE_FULL = 0x09 ,
  AUTH_CALLBACK_REPLY_ATTERR_ATTRIBUTE_NOT_FOUND = 0x0A , AUTH_CALLBACK_REPLY_ATTERR_ATTRIBUTE_NOT_LONG = 0x0B , AUTH_CALLBACK_REPLY_ATTERR_INSUFFICIENT_ENCRYPTION_KEY_SIZE = 0x0C , AUTH_CALLBACK_REPLY_ATTERR_INVALID_ATTRIBUTE_VALUE_LENGTH = 0x0D ,
  AUTH_CALLBACK_REPLY_ATTERR_INVALID_ATT_VAL_LENGTH = 0x0D , AUTH_CALLBACK_REPLY_ATTERR_UNLIKELY_ERROR = 0x0E , AUTH_CALLBACK_REPLY_ATTERR_INSUFFICIENT_ENCRYPTION = 0x0F , AUTH_CALLBACK_REPLY_ATTERR_UNSUPPORTED_GROUP_TYPE = 0x10 ,
  AUTH_CALLBACK_REPLY_ATTERR_INSUFFICIENT_RESOURCES = 0x11 , AUTH_CALLBACK_REPLY_ATTERR_INSUF_RESOURCES = 0x11 , AUTH_CALLBACK_REPLY_ATTERR_WRITE_REQUEST_REJECTED = 0xFC , AUTH_CALLBACK_REPLY_ATTERR_CLIENT_CHARACTERISTIC_CONFIGURATION_DESCRIPTOR_IMPROPERLY_CONFIGURED = 0xFD ,
  AUTH_CALLBACK_REPLY_ATTERR_PROCEDURE_ALREADY_IN_PROGRESS = 0xFE , AUTH_CALLBACK_REPLY_ATTERR_OUT_OF_RANGE = 0xFF
}
 Enumeration of allowed values returned by read or write authorization process. More...
 

Detailed Description

Enumeration Type Documentation

◆ GattAuthCallbackReply_t

Enumeration of allowed values returned by read or write authorization process.

Enumerator
AUTH_CALLBACK_REPLY_SUCCESS 

Success.

AUTH_CALLBACK_REPLY_ATTERR_INVALID_HANDLE 

The attribute handle given was not valid on this server.

AUTH_CALLBACK_REPLY_ATTERR_READ_NOT_PERMITTED 

The attribute cannot be read.

AUTH_CALLBACK_REPLY_ATTERR_WRITE_NOT_PERMITTED 

The attribute cannot be written.

AUTH_CALLBACK_REPLY_ATTERR_INVALID_PDU 

The attribute PDU was invalid.

AUTH_CALLBACK_REPLY_ATTERR_INSUFFICIENT_AUTHENTICATION 

The attribute requires authentication before it can be read or written.

AUTH_CALLBACK_REPLY_ATTERR_REQUEST_NOT_SUPPORTED 

Attribute server does not support the request received from the client.

AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET 

Offset specified was past the end of the attribute.

AUTH_CALLBACK_REPLY_ATTERR_INSUFFICIENT_AUTHORIZATION 

The attribute requires authorization before it can be read or written.

AUTH_CALLBACK_REPLY_ATTERR_PREPARE_QUEUE_FULL 

Too many prepare writes have been queued.

AUTH_CALLBACK_REPLY_ATTERR_ATTRIBUTE_NOT_FOUND 

No attribute found within the given attribute handle range.

AUTH_CALLBACK_REPLY_ATTERR_ATTRIBUTE_NOT_LONG 

The attribute cannot be read using the Read Blob Request.

AUTH_CALLBACK_REPLY_ATTERR_INSUFFICIENT_ENCRYPTION_KEY_SIZE 

The Encryption Key Size used for encrypting this link is insufficient.

AUTH_CALLBACK_REPLY_ATTERR_INVALID_ATTRIBUTE_VALUE_LENGTH 

The attribute value length is invalid for the operation.

AUTH_CALLBACK_REPLY_ATTERR_UNLIKELY_ERROR 

The attribute request that was requested has encountered an error that was unlikely, and therefore could not be completed as requested.

AUTH_CALLBACK_REPLY_ATTERR_INSUFFICIENT_ENCRYPTION 

The attribute requires encryption before it can be read or written.

AUTH_CALLBACK_REPLY_ATTERR_UNSUPPORTED_GROUP_TYPE 

The attribute type is not a supported grouping attribute as defined by a higher layer specification.

AUTH_CALLBACK_REPLY_ATTERR_INSUFFICIENT_RESOURCES 

Insufficient Resources to complete the request.

AUTH_CALLBACK_REPLY_ATTERR_WRITE_REQUEST_REJECTED 

The Write Request Rejected error code is used when a requested write operation cannot be fulfilled for reasons other than permissions.

AUTH_CALLBACK_REPLY_ATTERR_CLIENT_CHARACTERISTIC_CONFIGURATION_DESCRIPTOR_IMPROPERLY_CONFIGURED 

The Client Characteristic Configuration Descriptor Improperly Configured error code is used when a Client Characteristic Configuration descriptor is not configured according to the requirements of the profile or service.

AUTH_CALLBACK_REPLY_ATTERR_PROCEDURE_ALREADY_IN_PROGRESS 

The Procedure Already in Progress error code is used when a profile or service request cannot be serviced because an operation that has been previously triggered is still in progress.

AUTH_CALLBACK_REPLY_ATTERR_OUT_OF_RANGE 

The Out of Range error code is used when an attribute value is out of range as defined by a profile or service specification.

Definition at line 210 of file gatt/GattCallbackParamTypes.h.