MAP Server MAS callbacks. More...

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

Data Fields
void(*	rfcomm_connected )(struct bt_conn conn, struct bt_map_mse_mas mse_mas)
	RFCOMM transport connected callback.
void(*	rfcomm_disconnected )(struct bt_map_mse_mas *mse_mas)
	RFCOMM transport disconnected callback.
void(*	l2cap_connected )(struct bt_conn conn, struct bt_map_mse_mas mse_mas)
	L2CAP transport connected callback.
void(*	l2cap_disconnected )(struct bt_map_mse_mas *mse_mas)
	L2CAP transport disconnected callback.
void(*	connect )(struct bt_map_mse_mas mse_mas, uint8_t version, uint16_t mopl, struct net_buf buf)
	Connect callback.
void(*	disconnect )(struct bt_map_mse_mas mse_mas, struct net_buf buf)
	Disconnect callback.
void(*	abort )(struct bt_map_mse_mas mse_mas, struct net_buf buf)
	Abort callback.
void(*	set_ntf_reg )(struct bt_map_mse_mas mse_mas, bool final, struct net_buf buf)
	Set notification registration callback.
void(*	set_folder )(struct bt_map_mse_mas mse_mas, uint8_t flags, struct net_buf buf)
	Set folder callback.
void(*	get_folder_listing )(struct bt_map_mse_mas mse_mas, bool final, struct net_buf buf)
	Get folder listing callback.
void(*	get_msg_listing )(struct bt_map_mse_mas mse_mas, bool final, struct net_buf buf)
	Get message listing callback.
void(*	get_msg )(struct bt_map_mse_mas mse_mas, bool final, struct net_buf buf)
	Get message callback.
void(*	set_msg_status )(struct bt_map_mse_mas mse_mas, bool final, struct net_buf buf)
	Set message status callback.
void(*	push_msg )(struct bt_map_mse_mas mse_mas, bool final, struct net_buf buf)
	Push message callback.
void(*	update_inbox )(struct bt_map_mse_mas mse_mas, bool final, struct net_buf buf)
	Update inbox callback.
void(*	get_mas_inst_info )(struct bt_map_mse_mas mse_mas, bool final, struct net_buf buf)
	Get MAS instance info callback.
void(*	set_owner_status )(struct bt_map_mse_mas mse_mas, bool final, struct net_buf buf)
	Set owner status callback.
void(*	get_owner_status )(struct bt_map_mse_mas mse_mas, bool final, struct net_buf buf)
	Get owner status callback.
void(*	get_convo_listing )(struct bt_map_mse_mas mse_mas, bool final, struct net_buf buf)
	Get conversation listing callback.
void(*	set_ntf_filter )(struct bt_map_mse_mas mse_mas, bool final, struct net_buf buf)
	Set notification filter callback.

Detailed Description

MAP Server MAS callbacks.

Callbacks for MAP Server MAS events.

Field Documentation

◆ abort

void(* bt_map_mse_mas_cb::abort) (struct bt_map_mse_mas *mse_mas, struct net_buf *buf)

Abort callback.

Called when OBEX ABORT request is received. Application should respond using bt_map_mse_mas_abort().

Parameters

mse_mas	MAS server instance.
buf	Buffer containing request headers.

◆ connect

void(* bt_map_mse_mas_cb::connect) (struct bt_map_mse_mas *mse_mas, uint8_t version, uint16_t mopl, struct net_buf *buf)

Connect callback.

Called when OBEX CONNECT request is received from remote MCE. Application should respond using bt_map_mse_mas_connect().

Parameters

mse_mas	MAS server instance.
version	OBEX protocol version requested by client.
mopl	Maximum OBEX packet length requested by client.
buf	Buffer containing request headers (target UUID, supported features, etc.).

◆ disconnect

void(* bt_map_mse_mas_cb::disconnect) (struct bt_map_mse_mas *mse_mas, struct net_buf *buf)

Disconnect callback.

Called when OBEX DISCONNECT request is received. Application should respond using bt_map_mse_mas_disconnect().

Parameters

mse_mas	MAS server instance.
buf	Buffer containing request headers.

◆ get_convo_listing

void(* bt_map_mse_mas_cb::get_convo_listing) (struct bt_map_mse_mas *mse_mas, bool final, struct net_buf *buf)

Get conversation listing callback.

Called when GetConversationListing request is received. May be called multiple times if client requests continuation. Application should respond using bt_map_mse_mas_get_convo_listing().

Parameters

mse_mas	MAS server instance.
final	True if this is the final packet, false if more data follows.
buf	Buffer containing filter parameters and headers.

◆ get_folder_listing

void(* bt_map_mse_mas_cb::get_folder_listing) (struct bt_map_mse_mas *mse_mas, bool final, struct net_buf *buf)

Get folder listing callback.

Called when GetFolderListing request is received. May be called multiple times if client requests continuation. Application should respond using bt_map_mse_mas_get_folder_listing().

Parameters

mse_mas	MAS server instance.
final	True if this is the final packet, false if more data follows.
buf	Buffer containing filter parameters and headers.

◆ get_mas_inst_info

void(* bt_map_mse_mas_cb::get_mas_inst_info) (struct bt_map_mse_mas *mse_mas, bool final, struct net_buf *buf)

Get MAS instance info callback.

Called when GetMASInstanceInformation request is received. May be called multiple times if client requests continuation. Application should respond using bt_map_mse_mas_get_mas_inst_info().

Parameters

mse_mas	MAS server instance.
final	True if this is the final packet, false if more data follows.
buf	Buffer containing instance ID and headers.

◆ get_msg

void(* bt_map_mse_mas_cb::get_msg) (struct bt_map_mse_mas *mse_mas, bool final, struct net_buf *buf)

Get message callback.

Called when GetMessage request is received. May be called multiple times if client requests continuation. Application should respond using bt_map_mse_mas_get_msg().

Parameters

mse_mas	MAS server instance.
final	True if this is the final packet, false if more data follows.
buf	Buffer containing message handle, parameters, and headers.

◆ get_msg_listing

void(* bt_map_mse_mas_cb::get_msg_listing) (struct bt_map_mse_mas *mse_mas, bool final, struct net_buf *buf)

Get message listing callback.

Called when GetMessageListing request is received. May be called multiple times if client requests continuation. Application should respond using bt_map_mse_mas_get_msg_listing().

Parameters

mse_mas	MAS server instance.
final	True if this is the final packet, false if more data follows.
buf	Buffer containing folder name, filter parameters, and headers.

◆ get_owner_status

void(* bt_map_mse_mas_cb::get_owner_status) (struct bt_map_mse_mas *mse_mas, bool final, struct net_buf *buf)

Get owner status callback.

Called when GetOwnerStatus request is received. May be called multiple times if client requests continuation. Application should respond using bt_map_mse_mas_get_owner_status().

Parameters

mse_mas	MAS server instance.
final	True if this is the final packet, false if more data follows.
buf	Buffer containing headers.

◆ l2cap_connected

void(* bt_map_mse_mas_cb::l2cap_connected) (struct bt_conn *conn, struct bt_map_mse_mas *mse_mas)

L2CAP transport connected callback.

Called when the underlying transport (L2CAP) connection is established. OBEX connection has not yet been negotiated at this point.

Parameters

conn	Bluetooth connection object.
mse_mas	MAS server instance.

◆ l2cap_disconnected

void(* bt_map_mse_mas_cb::l2cap_disconnected) (struct bt_map_mse_mas *mse_mas)

L2CAP transport disconnected callback.

Called when the underlying transport (L2CAP) connection is closed.

Parameters

mse_mas MAS server instance.

◆ push_msg

void(* bt_map_mse_mas_cb::push_msg) (struct bt_map_mse_mas *mse_mas, bool final, struct net_buf *buf)

Push message callback.

Called when PushMessage request is received. May be called multiple times if request is fragmented. Application should respond using bt_map_mse_mas_push_msg().

Parameters

mse_mas	MAS server instance.
final	True if this is the final packet, false if more data follows.
buf	Buffer containing message data (bMessage format) and headers.

◆ rfcomm_connected

void(* bt_map_mse_mas_cb::rfcomm_connected) (struct bt_conn *conn, struct bt_map_mse_mas *mse_mas)

RFCOMM transport connected callback.

Called when the underlying transport (RFCOMM) connection is established. OBEX connection has not yet been negotiated at this point.

Parameters

conn	Bluetooth connection object.
mse_mas	MAS server instance.

◆ rfcomm_disconnected

void(* bt_map_mse_mas_cb::rfcomm_disconnected) (struct bt_map_mse_mas *mse_mas)

RFCOMM transport disconnected callback.

Called when the underlying transport (RFCOMM) connection is closed.

Parameters

mse_mas MAS server instance.

◆ set_folder

void(* bt_map_mse_mas_cb::set_folder) (struct bt_map_mse_mas *mse_mas, uint8_t flags, struct net_buf *buf)

Set folder callback.

Called when SetFolder request is received. Application should respond using bt_map_mse_mas_set_folder().

Parameters

mse_mas	MAS server instance.
flags	Navigation flags (see bt_map_set_folder_flags).
buf	Buffer containing folder name (for DOWN) and headers.

◆ set_msg_status

void(* bt_map_mse_mas_cb::set_msg_status) (struct bt_map_mse_mas *mse_mas, bool final, struct net_buf *buf)

Set message status callback.

Called when SetMessageStatus request is received. May be called multiple times if request is fragmented. Application should respond using bt_map_mse_mas_set_msg_status().

Parameters

mse_mas	MAS server instance.
final	True if this is the final packet, false if more data follows.
buf	Buffer containing message handle, status parameters, and headers.

◆ set_ntf_filter

void(* bt_map_mse_mas_cb::set_ntf_filter) (struct bt_map_mse_mas *mse_mas, bool final, struct net_buf *buf)

Set notification filter callback.

Called when SetNotificationFilter request is received. May be called multiple times if request is fragmented. Application should respond using bt_map_mse_mas_set_ntf_filter().

Parameters

mse_mas	MAS server instance.
final	True if this is the final packet, false if more data follows.
buf	Buffer containing filter mask and headers.

◆ set_ntf_reg

void(* bt_map_mse_mas_cb::set_ntf_reg) (struct bt_map_mse_mas *mse_mas, bool final, struct net_buf *buf)

Set notification registration callback.

Called when SetNotificationRegistration request is received. May be called multiple times if request is fragmented. Application should respond using bt_map_mse_mas_set_ntf_reg().

Parameters

mse_mas	MAS server instance.
final	True if this is the final packet, false if more data follows.
buf	Buffer containing notification status and headers.

◆ set_owner_status

void(* bt_map_mse_mas_cb::set_owner_status) (struct bt_map_mse_mas *mse_mas, bool final, struct net_buf *buf)

Set owner status callback.

Called when SetOwnerStatus request is received. May be called multiple times if request is fragmented. Application should respond using bt_map_mse_mas_set_owner_status().

Parameters

mse_mas	MAS server instance.
final	True if this is the final packet, false if more data follows.
buf	Buffer containing owner status data and headers.

◆ update_inbox

void(* bt_map_mse_mas_cb::update_inbox) (struct bt_map_mse_mas *mse_mas, bool final, struct net_buf *buf)

Update inbox callback.

Called when UpdateInbox request is received. May be called multiple times if request is fragmented. Application should respond using bt_map_mse_mas_update_inbox().

Parameters

mse_mas	MAS server instance.
final	True if this is the final packet, false if more data follows.
buf	Buffer containing headers.

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

zephyr/bluetooth/classic/map.h

Data Fields

Detailed Description

Field Documentation

◆ abort

◆ connect

◆ disconnect

◆ get_convo_listing

◆ get_folder_listing

◆ get_mas_inst_info

◆ get_msg

◆ get_msg_listing

◆ get_owner_status

◆ l2cap_connected

◆ l2cap_disconnected

◆ push_msg

◆ rfcomm_connected

◆ rfcomm_disconnected

◆ set_folder

◆ set_msg_status

◆ set_ntf_filter

◆ set_ntf_reg

◆ set_owner_status

◆ update_inbox