Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Messaging Client Equipment(MCE) OBEX Server

Messaging Client Equipment(MCE) OBEX Server. More...

Data Structures

struct  bt_map_mce_mns_rfcomm_server
 MAP Client MNS RFCOMM server. More...
struct  bt_map_mce_mns_l2cap_server
 MAP Client MNS L2CAP server. More...
struct  bt_map_mce_mns_cb
 MAP Client MNS callbacks. More...
struct  bt_map_mce_mns
 MAP Client MNS instance structure. More...

Functions

int bt_map_mce_mns_cb_register (struct bt_map_mce_mns *mce_mns, const struct bt_map_mce_mns_cb *cb)
 Register callbacks for MAP Client MNS.
int bt_map_mce_mns_rfcomm_register (struct bt_map_mce_mns_rfcomm_server *server)
 Register MAP Client MNS RFCOMM server.
int bt_map_mce_mns_rfcomm_disconnect (struct bt_map_mce_mns *mce_mns)
 Disconnect MAP Client MNS over RFCOMM.
int bt_map_mce_mns_l2cap_register (struct bt_map_mce_mns_l2cap_server *server)
 Register MAP Client MNS L2CAP server.
int bt_map_mce_mns_l2cap_disconnect (struct bt_map_mce_mns *mce_mns)
 Disconnect MAP Client MNS over L2CAP.
struct net_bufbt_map_mce_mns_create_pdu (struct bt_map_mce_mns *mce_mns, struct net_buf_pool *pool)
 Create PDU for MAP Client MNS.
int bt_map_mce_mns_connect (struct bt_map_mce_mns *mce_mns, uint8_t rsp_code, struct net_buf *buf)
 Send OBEX connect response.
int bt_map_mce_mns_disconnect (struct bt_map_mce_mns *mce_mns, uint8_t rsp_code, struct net_buf *buf)
 Send OBEX disconnect response.
int bt_map_mce_mns_abort (struct bt_map_mce_mns *mce_mns, uint8_t rsp_code, struct net_buf *buf)
 Send OBEX abort response.
int bt_map_mce_mns_send_event (struct bt_map_mce_mns *mce_mns, uint8_t rsp_code, struct net_buf *buf)
 Send event response.

Detailed Description

Messaging Client Equipment(MCE) OBEX Server.

Function Documentation

◆ bt_map_mce_mns_abort()

int bt_map_mce_mns_abort ( struct bt_map_mce_mns * mce_mns,
uint8_t rsp_code,
struct net_buf * buf )

#include <zephyr/bluetooth/classic/map.h>

Send OBEX abort response.

Responds to an OBEX ABORT request from the remote MSE. Called from the abort callback bt_map_mce_mns_cb::abort.

Parameters
mce_mnsMNS server instance.
rsp_codeResponse code bt_obex_rsp_code (BT_OBEX_RSP_CODE_SUCCESS to accept).
bufBuffer containing response headers. If NULL, a default response is sent. If success returned, the function has taken the ownership of buf.
Returns
0 on success, negative error code on failure.

◆ bt_map_mce_mns_cb_register()

int bt_map_mce_mns_cb_register ( struct bt_map_mce_mns * mce_mns,
const struct bt_map_mce_mns_cb * cb )

#include <zephyr/bluetooth/classic/map.h>

Register callbacks for MAP Client MNS.

Registers callback functions to handle MNS events and requests. Must be called before accepting any MNS connections.

Parameters
mce_mnsMNS server instance.
cbPointer to callback structure (must remain valid).
Returns
0 on success, negative error code on failure.

◆ bt_map_mce_mns_connect()

int bt_map_mce_mns_connect ( struct bt_map_mce_mns * mce_mns,
uint8_t rsp_code,
struct net_buf * buf )

#include <zephyr/bluetooth/classic/map.h>

Send OBEX connect response.

Responds to an OBEX CONNECT request from the remote MSE. Called from the connect callback bt_map_mce_mns_cb::connect.

Parameters
mce_mnsMNS server instance.
rsp_codeResponse code bt_obex_rsp_code (BT_OBEX_RSP_CODE_SUCCESS to accept).
bufBuffer containing response headers (WHO, connection ID, etc.). If NULL, a default response is sent. If success returned, the function has taken the ownership of buf.
Returns
0 on success, negative error code on failure.

◆ bt_map_mce_mns_create_pdu()

struct net_buf * bt_map_mce_mns_create_pdu ( struct bt_map_mce_mns * mce_mns,
struct net_buf_pool * pool )

#include <zephyr/bluetooth/classic/map.h>

Create PDU for MAP Client MNS.

Allocates a buffer for building MAP response packets. The buffer is sized appropriately for the negotiated MTU.

Parameters
mce_mnsMNS server instance.
poolBuffer pool to allocate from (NULL for default pool).
Returns
Allocated buffer, or NULL on failure.

◆ bt_map_mce_mns_disconnect()

int bt_map_mce_mns_disconnect ( struct bt_map_mce_mns * mce_mns,
uint8_t rsp_code,
struct net_buf * buf )

#include <zephyr/bluetooth/classic/map.h>

Send OBEX disconnect response.

Responds to an OBEX DISCONNECT request from the remote MSE. Called from the disconnect callback bt_map_mce_mns_cb::disconnect.

Parameters
mce_mnsMNS server instance.
rsp_codeResponse code bt_obex_rsp_code (BT_OBEX_RSP_CODE_SUCCESS to accept).
bufBuffer containing response headers. If NULL, a default response is sent. If success returned, the function has taken the ownership of buf.
Returns
0 on success, negative error code on failure.

◆ bt_map_mce_mns_l2cap_disconnect()

int bt_map_mce_mns_l2cap_disconnect ( struct bt_map_mce_mns * mce_mns)

#include <zephyr/bluetooth/classic/map.h>

Disconnect MAP Client MNS over L2CAP.

Closes the L2CAP transport connection. On success, the l2cap_disconnected callback bt_map_mce_mns_cb::l2cap_disconnected will be called.

Parameters
mce_mnsMNS server instance.
Returns
0 on success, negative error code on failure.

◆ bt_map_mce_mns_l2cap_register()

int bt_map_mce_mns_l2cap_register ( struct bt_map_mce_mns_l2cap_server * server)

#include <zephyr/bluetooth/classic/map.h>

Register MAP Client MNS L2CAP server.

Registers an L2CAP server to accept incoming MNS connections. The PSM is allocated automatically or can be specified.

Parameters
serverL2CAP server structure with accept callback configured.
Returns
0 on success, negative error code on failure.

◆ bt_map_mce_mns_rfcomm_disconnect()

int bt_map_mce_mns_rfcomm_disconnect ( struct bt_map_mce_mns * mce_mns)

#include <zephyr/bluetooth/classic/map.h>

Disconnect MAP Client MNS over RFCOMM.

Closes the RFCOMM transport connection. On success, the rfcomm_disconnected callback bt_map_mce_mns_cb::rfcomm_disconnected will be called.

Parameters
mce_mnsMNS server instance.
Returns
0 on success, negative error code on failure.

◆ bt_map_mce_mns_rfcomm_register()

int bt_map_mce_mns_rfcomm_register ( struct bt_map_mce_mns_rfcomm_server * server)

#include <zephyr/bluetooth/classic/map.h>

Register MAP Client MNS RFCOMM server.

Registers an RFCOMM server to accept incoming MNS connections. The server channel is allocated automatically or can be specified.

Parameters
serverRFCOMM server structure with accept callback configured.
Returns
0 on success, negative error code on failure.

◆ bt_map_mce_mns_send_event()

int bt_map_mce_mns_send_event ( struct bt_map_mce_mns * mce_mns,
uint8_t rsp_code,
struct net_buf * buf )

#include <zephyr/bluetooth/classic/map.h>

Send event response.

Responds to a SendEvent request from the remote MSE. Called from the send_event callback bt_map_mce_mns_cb::send_event.

Parameters
mce_mnsMNS server instance.
rsp_codeResponse code bt_obex_rsp_code (BT_OBEX_RSP_CODE_CONTINUE for partial, BT_OBEX_RSP_CODE_SUCCESS for complete).
bufBuffer containing response headers. If NULL, a default response is sent. If success returned, the function has taken the ownership of buf.
Returns
0 on success, negative error code on failure.