ble_gap_connect() function

Initiates a connect procedure.

Syntax

Show:

Summary

Declaration

Definition

from ble_gap.h:2613

int ble_gap_connect(uint8_t own_addr_type, const ble_addr_t *peer_addr, int32_t duration_ms, const struct ble_gap_conn_params *params, ble_gap_event_fn *cb, void *cb_arg);

Implemented in ble_gap.c:7158

Arguments

Argument

Description

own_addr_type

The type of address the stack should use for itself during connection establishment. - BLE_OWN_ADDR_PUBLIC - BLE_OWN_ADDR_RANDOM - BLE_OWN_ADDR_RPA_PUBLIC_DEFAULT - BLE_OWN_ADDR_RPA_RANDOM_DEFAULT

peer_addr

The address of the peer to connect to. If this parameter is NULL, the white list is used.

duration_ms

The duration of the discovery procedure. On expiration, the procedure ends and a BLE_GAP_EVENT_DISC_COMPLETE event is reported. Units are milliseconds.

params

The callback to associate with this connect procedure. When the connect procedure completes, the result is reported through this callback. If the connect procedure succeeds, the connection inherits this callback as its event-reporting mechanism.

cb_arg

The optional argument to pass to the callback function.

Return value

0 on success; BLE_HS_EALREADY if a connection attempt is already in progress; BLE_HS_EBUSY if initiating a connection is not possible because scanning is in progress; BLE_HS_EDONE if the specified peer is already connected; Other nonzero on error.

Examples

ble_gap_connect() is referenced by 9 libraries and example projects:

References

from examples

ble_gap_connect() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle