Zephyr API Documentation 4.5.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
opp.h File Reference

Object Push Profile header. More...

Go to the source code of this file.

Data Structures

struct  bt_opp_client_cb
 OPP Push Client callback operations structure. More...
struct  bt_opp_client
 OPP Push Client structure. More...
struct  bt_opp_server_cb
 OPP Push Server callback operations structure. More...
struct  bt_opp_server_transport
 OPP Push Server transport registration structure. More...
struct  bt_opp_server
 OPP Push Server structure. More...

Macros

#define BT_OPP_SDP_UUID   BT_UUID_DECLARE_16(BT_SDP_OBEX_OBJPUSH_SVCLASS)
 SDP service class UUID for the Object Push service.
#define BT_OPP_SDP_ATTR_SUPPORTED_FORMATS   BT_SDP_ATTR_SUPPORTED_FORMATS_LIST
 SDP attribute ID for the Supported Formats List attribute.
#define BT_OPP_TYPE_VCARD   "text/x-vcard"
 OBEX Type header value for vCard 2.1 / vCard 3.0 objects.
#define BT_OPP_TYPE_VCAL   "text/x-vcalendar"
 OBEX Type header value for vCalendar 1.0 objects.
#define BT_OPP_TYPE_ICAL   "text/calendar"
 OBEX Type header value for iCalendar 2.0 objects.
#define BT_OPP_TYPE_VNOTE   "text/x-vnote"
 OBEX Type header value for vNote objects.
#define BT_OPP_TYPE_VMESSAGE   "text/x-vmsg"
 OBEX Type header value for vMessage objects.

Enumerations

enum  bt_opp_format {
  BT_OPP_FORMAT_VCARD_2_1 = 0x01 , BT_OPP_FORMAT_VCARD_3_0 = 0x02 , BT_OPP_FORMAT_VCAL_1_0 = 0x03 , BT_OPP_FORMAT_ICAL_2_0 = 0x04 ,
  BT_OPP_FORMAT_VNOTE = 0x05 , BT_OPP_FORMAT_VMESSAGE = 0x06 , BT_OPP_FORMAT_ANY = 0xff
}
 OPP supported object format codes. More...
enum  bt_opp_rsp_code {
  BT_OPP_RSP_CODE_CONTINUE = BT_OBEX_RSP_CODE_CONTINUE , BT_OPP_RSP_CODE_OK = BT_OBEX_RSP_CODE_OK , BT_OPP_RSP_CODE_SUCCESS = BT_OBEX_RSP_CODE_SUCCESS , BT_OPP_RSP_CODE_BAD_REQ = BT_OBEX_RSP_CODE_BAD_REQ ,
  BT_OPP_RSP_CODE_FORBIDDEN = BT_OBEX_RSP_CODE_FORBIDDEN , BT_OPP_RSP_CODE_NOT_FOUND = BT_OBEX_RSP_CODE_NOT_FOUND , BT_OPP_RSP_CODE_NOT_ACCEPT = BT_OBEX_RSP_CODE_NOT_ACCEPT , BT_OPP_RSP_CODE_PRECON_FAIL = BT_OBEX_RSP_CODE_PRECON_FAIL ,
  BT_OPP_RSP_CODE_ENTITY_TOO_LARGE = BT_OBEX_RSP_CODE_ENTITY_TOO_LARGE , BT_OPP_RSP_CODE_UNSUPP_MEDIA_TYPE = BT_OBEX_RSP_CODE_UNSUPP_MEDIA_TYPE , BT_OPP_RSP_CODE_NOT_IMPL = BT_OBEX_RSP_CODE_NOT_IMPL , BT_OPP_RSP_CODE_INTER_ERROR = BT_OBEX_RSP_CODE_INTER_ERROR ,
  BT_OPP_RSP_CODE_UNAVAIL = BT_OBEX_RSP_CODE_UNAVAIL
}
 OPP response codes. More...

Functions

int bt_opp_client_transport_connect (struct bt_conn *conn, struct bt_opp_client *client, const struct bt_opp_client_cb *cb, uint8_t channel)
 Connect the Push Client to a Push Server transport.
int bt_opp_client_transport_disconnect (struct bt_opp_client *client)
 Disconnect the Push Client transport connection.
struct net_buf * bt_opp_client_create_pdu (struct bt_opp_client *client, struct net_buf_pool *pool)
 Allocate a PDU buffer with headroom reserved for OPP Push Client.
int bt_opp_client_connect (struct bt_opp_client *client, uint16_t mopl, struct net_buf *buf)
 Establish an OBEX connection with the Push Server.
int bt_opp_client_disconnect (struct bt_opp_client *client, struct net_buf *buf)
 Terminate the OBEX connection.
int bt_opp_client_push (struct bt_opp_client *client, bool final, struct net_buf *buf)
 Push an object to the Push Server (OBEX PUT).
int bt_opp_client_pull (struct bt_opp_client *client, struct net_buf *buf)
 Pull the server's default business card (OBEX GET).
int bt_opp_client_abort (struct bt_opp_client *client, struct net_buf *buf)
 Abort the current ongoing operation.
struct net_buf * bt_opp_server_create_pdu (struct bt_opp_server *server, struct net_buf_pool *pool)
 Allocate a PDU buffer with headroom reserved for OPP Push Server.
int bt_opp_server_transport_register (struct bt_opp_server_transport *server)
 Register an OPP Push Server transport listener.
int bt_opp_server_register (struct bt_opp_server *server, const struct bt_opp_server_cb *cb)
 Register a Push Server instance with the OPP subsystem.
int bt_opp_server_unregister (struct bt_opp_server *server)
 Release a Push Server instance.
int bt_opp_server_connect (struct bt_opp_server *server, uint16_t mopl, uint8_t rsp_code, struct net_buf *buf)
 Send an OBEX CONNECT response from the Push Server.
int bt_opp_server_disconnect (struct bt_opp_server *server, struct net_buf *buf)
 Send an OBEX DISCONNECT response from the Push Server.
int bt_opp_server_push (struct bt_opp_server *server, uint8_t rsp_code, struct net_buf *buf)
 Send an OBEX PUT response from the Push Server.
int bt_opp_server_pull (struct bt_opp_server *server, uint8_t rsp_code, struct net_buf *buf)
 Send an OBEX GET response from the Push Server (business card pull).
int bt_opp_server_abort (struct bt_opp_server *server, struct net_buf *buf)
 Send an OBEX ABORT response from the Push Server.

Detailed Description

Object Push Profile header.