Zephyr API Documentation 4.5.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches

Bluetooth File Transfer Profile handling. More...

Go to the source code of this file.

Data Structures

struct  bt_ftp_client_cb
 FTP client callback structure. More...
struct  bt_ftp_client
 FTP client structure. More...
struct  bt_ftp_server_cb
 FTP server callback structure. More...
struct  bt_ftp_server
 FTP server structure. More...
struct  bt_ftp_server_rfcomm
 FTP server RFCOMM registration structure. More...
struct  bt_ftp_server_l2cap
 FTP server L2CAP registration structure. More...

Macros

#define BT_FTP_UUID
 FTP service target UUID (F9EC7BC4-953C-11D2-984E-525400DC9E09).
#define BT_FTP_FOLDER_LISTING_TYPE   "x-obex/folder-listing"
 OBEX type header for folder listing operation.

Enumerations

enum  bt_ftp_set_folder_flags { BT_FTP_SET_FOLDER_FLAGS_ROOT = BT_OBEX_SETPATH_FLAG_NO_CREATE , BT_FTP_SET_FOLDER_FLAGS_DOWN = BT_OBEX_SETPATH_FLAG_NO_CREATE , BT_FTP_SET_FOLDER_FLAGS_UP = BT_OBEX_SETPATH_FLAG_BACKUP | BT_OBEX_SETPATH_FLAG_NO_CREATE , BT_FTP_SET_FOLDER_FLAGS_NEW = 0 }
 FTP set folder operation flags. More...
enum  bt_ftp_rsp_code {
  BT_FTP_RSP_CODE_CONTINUE = BT_OBEX_RSP_CODE_CONTINUE , BT_FTP_RSP_CODE_SUCCESS = BT_OBEX_RSP_CODE_SUCCESS , BT_FTP_RSP_CODE_BAD_REQ = BT_OBEX_RSP_CODE_BAD_REQ , BT_FTP_RSP_CODE_UNAUTH = BT_OBEX_RSP_CODE_UNAUTH ,
  BT_FTP_RSP_CODE_FORBIDDEN = BT_OBEX_RSP_CODE_FORBIDDEN , BT_FTP_RSP_CODE_NOT_FOUND = BT_OBEX_RSP_CODE_NOT_FOUND , BT_FTP_RSP_CODE_NOT_ACCEPT = BT_OBEX_RSP_CODE_NOT_ACCEPT , BT_FTP_RSP_CODE_PRECON_FAIL = BT_OBEX_RSP_CODE_PRECON_FAIL ,
  BT_FTP_RSP_CODE_NOT_IMPL = BT_OBEX_RSP_CODE_NOT_IMPL , BT_FTP_RSP_CODE_UNAVAIL = BT_OBEX_RSP_CODE_UNAVAIL
}
 FTP response codes. More...

Functions

int bt_ftp_client_rfcomm_connect (struct bt_conn *conn, struct bt_ftp_client *client, const struct bt_ftp_client_cb *cb, uint8_t channel)
 Connect FTP client over RFCOMM (GOEP v1.1).
int bt_ftp_client_rfcomm_disconnect (struct bt_ftp_client *client)
 Disconnect FTP client RFCOMM transport.
int bt_ftp_client_l2cap_connect (struct bt_conn *conn, struct bt_ftp_client *client, const struct bt_ftp_client_cb *cb, uint16_t psm)
 Connect FTP client over L2CAP (GOEP v2).
int bt_ftp_client_l2cap_disconnect (struct bt_ftp_client *client)
 Disconnect FTP client L2CAP transport.
int bt_ftp_client_connect (struct bt_ftp_client *client, struct net_buf *buf)
 Send an OBEX CONNECT request to the FTP server.
int bt_ftp_client_disconnect (struct bt_ftp_client *client, struct net_buf *buf)
 Send an OBEX DISCONNECT request to the FTP server.
int bt_ftp_client_abort (struct bt_ftp_client *client, struct net_buf *buf)
 Send an OBEX ABORT request to the FTP server.
int bt_ftp_client_set_folder (struct bt_ftp_client *client, uint8_t flags, struct net_buf *buf)
 Send a SetPath (set folder) request to the FTP server.
int bt_ftp_client_pull_folder_listing (struct bt_ftp_client *client, bool final, struct net_buf *buf)
 Send a GET folder listing request to the FTP server.
int bt_ftp_client_push_file (struct bt_ftp_client *client, bool final, struct net_buf *buf)
 Send a PUT request to push a file to the FTP server.
int bt_ftp_client_pull_file (struct bt_ftp_client *client, bool final, struct net_buf *buf)
 Send a GET request to pull a file from the FTP server.
int bt_ftp_client_remove (struct bt_ftp_client *client, struct net_buf *buf)
 Send a remove request to the FTP server.
int bt_ftp_client_rename (struct bt_ftp_client *client, struct net_buf *buf)
 Send a RENAME/MOVE action request to the FTP server.
int bt_ftp_client_copy (struct bt_ftp_client *client, struct net_buf *buf)
 Send a COPY action request to the FTP server.
int bt_ftp_client_set_permission (struct bt_ftp_client *client, struct net_buf *buf)
 Send a SET PERMISSIONS action request to the FTP server.
struct net_buf * bt_ftp_client_create_pdu (struct bt_ftp_client *client, struct net_buf_pool *pool)
 Allocate a PDU buffer for an FTP client operation.
int bt_ftp_server_register (struct bt_ftp_server *server, const struct bt_ftp_server_cb *cb)
 Register an FTP server instance with the OBEX layer.
int bt_ftp_server_rfcomm_register (struct bt_ftp_server_rfcomm *server)
 Register an FTP RFCOMM server.
int bt_ftp_server_l2cap_register (struct bt_ftp_server_l2cap *server)
 Register an FTP L2CAP server.
int bt_ftp_server_rfcomm_disconnect (struct bt_ftp_server *server)
 Disconnect the FTP server RFCOMM transport.
int bt_ftp_server_l2cap_disconnect (struct bt_ftp_server *server)
 Disconnect the FTP server L2CAP transport.
int bt_ftp_server_connect (struct bt_ftp_server *server, uint8_t rsp_code, struct net_buf *buf)
 Send an OBEX CONNECT response from the FTP server.
int bt_ftp_server_disconnect (struct bt_ftp_server *server, uint8_t rsp_code, struct net_buf *buf)
 Send an OBEX DISCONNECT response from the FTP server.
int bt_ftp_server_abort (struct bt_ftp_server *server, uint8_t rsp_code, struct net_buf *buf)
 Send an OBEX ABORT response from the FTP server.
int bt_ftp_server_set_folder (struct bt_ftp_server *server, uint8_t rsp_code, struct net_buf *buf)
 Send a set folder response from the FTP server.
int bt_ftp_server_pull_folder_listing (struct bt_ftp_server *server, uint8_t rsp_code, struct net_buf *buf)
 Send a pull folder listing response from the FTP server.
int bt_ftp_server_push_file (struct bt_ftp_server *server, uint8_t rsp_code, struct net_buf *buf)
 Send a push file response from the FTP server.
int bt_ftp_server_pull_file (struct bt_ftp_server *server, uint8_t rsp_code, struct net_buf *buf)
 Send a pull file response from the FTP server.
int bt_ftp_server_remove (struct bt_ftp_server *server, uint8_t rsp_code, struct net_buf *buf)
 Send a remove response from the FTP server.
int bt_ftp_server_rename (struct bt_ftp_server *server, uint8_t rsp_code, struct net_buf *buf)
 Send a rename/move response from the FTP server.
int bt_ftp_server_copy (struct bt_ftp_server *server, uint8_t rsp_code, struct net_buf *buf)
 Send a copy response from the FTP server.
int bt_ftp_server_set_permission (struct bt_ftp_server *server, uint8_t rsp_code, struct net_buf *buf)
 Send a set permission response from the FTP server.
struct net_buf * bt_ftp_server_create_pdu (struct bt_ftp_server *server, struct net_buf_pool *pool)
 Allocate a PDU buffer for an FTP server response.

Detailed Description

Bluetooth File Transfer Profile handling.