Bluetooth: Host: Add note about recycled for BT_LE_ADV_OPT_CONN

Thalley · kartben · commit 7d8315574f97 · 2025-10-01T08:20:54.000+02:00
When a connectable advertising set is stopped, the
preallocated connection object is free by calling
bt_conn_unref which triggers a call to the recycled
callback.

Signed-off-by: Emil Gydesen &lt;emil.gydesen@nordicsemi.no&gt;
diff --git a/include/zephyr/bluetooth/bluetooth.h b/include/zephyr/bluetooth/bluetooth.h
@@ -756,6 +756,8 @@ enum bt_le_adv_opt {
 	 *
 	 * Starting connectable advertising preallocates a connection
 	 * object. If this fails, the API returns @c -ENOMEM.
+	 * Stopping connectable advertising will free the connection object,
+	 * and will trigger a call to @ref bt_conn_cb.recycled.
 	 *
 	 * The advertising set stops immediately after it creates a
 	 * connection. This happens automatically in the controller.

Original file line number	Diff line number	Diff line change
`@@ -756,6 +756,8 @@ enum bt_le_adv_opt {`
`756`	`756`	`*`
`757`	`757`	`* Starting connectable advertising preallocates a connection`
`758`	`758`	`* object. If this fails, the API returns @c -ENOMEM.`
	`759`	`+ * Stopping connectable advertising will free the connection object,`
	`760`	`+ * and will trigger a call to @ref bt_conn_cb.recycled.`
`759`	`761`	`*`
`760`	`762`	`* The advertising set stops immediately after it creates a`
`761`	`763`	`* connection. This happens automatically in the controller.`