michaelh/zephyr
1
0
Fork 0
Code Releases Activity

bluetooth: Updated comment in conn.h to clarify CB PoV

Browse source 
In conn.h the comments on src/dst in bt_conn_le_info and
bt_conn_br_info does not clearly state the point of view.
src could both be perceived as the connections point of view
(src = local address) or the call-back where the structs are
used point of view (src = remote address).
The comments about src/dst has been made more clear.

Signed-off-by: Theis Blickfeldt <ttjo@oticon.com>
This commit is contained in:
Theis Blickfeldt 2018-11-27 08:47:39 +01:00 • committed by Johan Hedberg
commit bb68ac6c0b
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/bluetooth/conn.h
View file

@ -124,8 +124,8 @@ enum {
/** LE Connection Info Structure */ /** LE Connection Info Structure */
struct bt_conn_le_info { struct bt_conn_le_info {
const bt_addr_le_t *src; /** Source Address */ const bt_addr_le_t *src; /** Source (Local) Address */
const bt_addr_le_t *dst; /** Destination Address */ const bt_addr_le_t *dst; /** Destination (Remote) Address */
u16_t interval; /** Connection interval */ u16_t interval; /** Connection interval */
u16_t latency; /** Connection slave latency */ u16_t latency; /** Connection slave latency */
u16_t timeout; /** Connection supervision timeout */ u16_t timeout; /** Connection supervision timeout */
@ -133,7 +133,7 @@ struct bt_conn_le_info {
/** BR/EDR Connection Info Structure */ /** BR/EDR Connection Info Structure */
struct bt_conn_br_info { struct bt_conn_br_info {
const bt_addr_t *dst; /** Destination BR/EDR address */ const bt_addr_t *dst; /** Destination (Remote) BR/EDR address */
}; };
/** Connection role (master or slave) */ /** Connection role (master or slave) */