Android Hardware Abstraction Layer
Data Fields
btgatt_client_interface_t Struct Reference

#include <bt_gatt_client.h>

Data Fields

bt_status_t(* register_client )(bt_uuid_t *uuid)
 
bt_status_t(* unregister_client )(int client_if)
 
bt_status_t(* scan )(int client_if, bool start)
 
bt_status_t(* connect )(int client_if, const bt_bdaddr_t *bd_addr, bool is_direct)
 
bt_status_t(* disconnect )(int client_if, const bt_bdaddr_t *bd_addr, int conn_id)
 
bt_status_t(* listen )(int client_if, bool start)
 
bt_status_t(* refresh )(int client_if, const bt_bdaddr_t *bd_addr)
 
bt_status_t(* search_service )(int conn_id, bt_uuid_t *filter_uuid)
 
bt_status_t(* get_included_service )(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_srvc_id_t *start_incl_srvc_id)
 
bt_status_t(* get_characteristic )(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *start_char_id)
 
bt_status_t(* get_descriptor )(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, btgatt_gatt_id_t *start_descr_id)
 
bt_status_t(* read_characteristic )(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, int auth_req)
 
bt_status_t(* write_characteristic )(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, int write_type, int len, int auth_req, char *p_value)
 
bt_status_t(* read_descriptor )(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, btgatt_gatt_id_t *descr_id, int auth_req)
 
bt_status_t(* write_descriptor )(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, btgatt_gatt_id_t *descr_id, int write_type, int len, int auth_req, char *p_value)
 
bt_status_t(* execute_write )(int conn_id, int execute)
 
bt_status_t(* register_for_notification )(int client_if, const bt_bdaddr_t *bd_addr, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id)
 
bt_status_t(* deregister_for_notification )(int client_if, const bt_bdaddr_t *bd_addr, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id)
 
bt_status_t(* read_remote_rssi )(int client_if, const bt_bdaddr_t *bd_addr)
 
int(* get_device_type )(const bt_bdaddr_t *bd_addr)
 
bt_status_t(* set_adv_data )(int server_if, bool set_scan_rsp, bool include_name, bool include_txpower, int min_interval, int max_interval, int appearance, uint16_t manufacturer_len, char *manufacturer_data)
 
bt_status_t(* test_command )(int command, btgatt_test_params_t *params)
 

Detailed Description

Represents the standard BT-GATT client interface.

Definition at line 182 of file bt_gatt_client.h.

Field Documentation

bt_status_t(* connect)(int client_if, const bt_bdaddr_t *bd_addr, bool is_direct)

Create a connection to a remote LE or dual-mode device

Definition at line 193 of file bt_gatt_client.h.

bt_status_t(* deregister_for_notification)(int client_if, const bt_bdaddr_t *bd_addr, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id)

Deregister a previous request for notifications/indications

Definition at line 268 of file bt_gatt_client.h.

bt_status_t(* disconnect)(int client_if, const bt_bdaddr_t *bd_addr, int conn_id)

Disconnect a remote device or cancel a pending connection

Definition at line 197 of file bt_gatt_client.h.

bt_status_t(* execute_write)(int conn_id, int execute)

Execute a prepared write operation

Definition at line 257 of file bt_gatt_client.h.

bt_status_t(* get_characteristic)(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *start_char_id)

Enumerate characteristics for a given service. Set start_char_id to NULL to get the first characteristic.

Definition at line 223 of file bt_gatt_client.h.

bt_status_t(* get_descriptor)(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, btgatt_gatt_id_t *start_descr_id)

Enumerate descriptors for a given characteristic. Set start_descr_id to NULL to get the first descriptor.

Definition at line 230 of file bt_gatt_client.h.

int(* get_device_type)(const bt_bdaddr_t *bd_addr)

Determine the type of the remote device (LE, BR/EDR, Dual-mode)

Definition at line 276 of file bt_gatt_client.h.

bt_status_t(* get_included_service)(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_srvc_id_t *start_incl_srvc_id)

Enumerate included services for a given service. Set start_incl_srvc_id to NULL to get the first included service.

Definition at line 216 of file bt_gatt_client.h.

bt_status_t(* listen)(int client_if, bool start)

Start or stop advertisements to listen for incoming connections

Definition at line 201 of file bt_gatt_client.h.

bt_status_t(* read_characteristic)(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, int auth_req)

Read a characteristic on a remote device

Definition at line 235 of file bt_gatt_client.h.

bt_status_t(* read_descriptor)(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, btgatt_gatt_id_t *descr_id, int auth_req)

Read the descriptor for a given characteristic

Definition at line 246 of file bt_gatt_client.h.

bt_status_t(* read_remote_rssi)(int client_if, const bt_bdaddr_t *bd_addr)

Request RSSI for a given remote device

Definition at line 273 of file bt_gatt_client.h.

bt_status_t(* refresh)(int client_if, const bt_bdaddr_t *bd_addr)

Clear the attribute cache for a given device

Definition at line 204 of file bt_gatt_client.h.

bt_status_t(* register_client)(bt_uuid_t *uuid)

Registers a GATT client application with the stack

Definition at line 184 of file bt_gatt_client.h.

bt_status_t(* register_for_notification)(int client_if, const bt_bdaddr_t *bd_addr, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id)

Register to receive notifications or indications for a given characteristic

Definition at line 263 of file bt_gatt_client.h.

bt_status_t(* scan)(int client_if, bool start)

Start or stop LE device scanning

Definition at line 190 of file bt_gatt_client.h.

bt_status_t(* search_service)(int conn_id, bt_uuid_t *filter_uuid)

Enumerate all GATT services on a connected device. Optionally, the results can be filtered for a given UUID.

Definition at line 210 of file bt_gatt_client.h.

bt_status_t(* set_adv_data)(int server_if, bool set_scan_rsp, bool include_name, bool include_txpower, int min_interval, int max_interval, int appearance, uint16_t manufacturer_len, char *manufacturer_data)

Set the advertising data or scan response data

Definition at line 279 of file bt_gatt_client.h.

bt_status_t(* test_command)(int command, btgatt_test_params_t *params)

Test mode interface

Definition at line 284 of file bt_gatt_client.h.

bt_status_t(* unregister_client)(int client_if)

Unregister a client application from the stack

Definition at line 187 of file bt_gatt_client.h.

bt_status_t(* write_characteristic)(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, int write_type, int len, int auth_req, char *p_value)

Write a remote characteristic

Definition at line 240 of file bt_gatt_client.h.

bt_status_t(* write_descriptor)(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, btgatt_gatt_id_t *descr_id, int write_type, int len, int auth_req, char *p_value)

Write a remote descriptor for a given characteristic

Definition at line 251 of file bt_gatt_client.h.


The documentation for this struct was generated from the following file: