gobex/gobex.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  *
   4  *  OBEX library with GLib integration
   5  *
   6  *  Copyright (C) 2011  Intel Corporation. All rights reserved.
   7  *
   8  */
   9
  10 #ifndef __GOBEX_H
  11 #define __GOBEX_H
  12
  13 #include <stdarg.h>
  14 #include <glib.h>
  15
  16 #include "gobex/gobex-defs.h"
  17 #include "gobex/gobex-packet.h"
  18
  19 typedef enum {
  20         G_OBEX_TRANSPORT_STREAM,
  21         G_OBEX_TRANSPORT_PACKET,
  22 } GObexTransportType;
  23
  24 typedef struct _GObex GObex;
  25
  26 typedef void (*GObexFunc) (GObex *obex, GError *err, gpointer user_data);
  27 typedef void (*GObexRequestFunc) (GObex *obex, GObexPacket *req,
  28                                                         gpointer user_data);
  29 typedef void (*GObexResponseFunc) (GObex *obex, GError *err, GObexPacket *rsp,
  30                                                         gpointer user_data);
  31
  32 gboolean g_obex_send(GObex *obex, GObexPacket *pkt, GError **err);
  33
  34 guint g_obex_send_req(GObex *obex, GObexPacket *req, int timeout,
  35                         GObexResponseFunc func, gpointer user_data,
  36                         GError **err);
  37 gboolean g_obex_cancel_req(GObex *obex, guint req_id,
  38                                                 gboolean remove_callback);
  39
  40 gboolean g_obex_send_rsp(GObex *obex, guint8 rspcode, GError **err,
  41                                                 guint first_hdr_type, ...);
  42
  43 void g_obex_set_disconnect_function(GObex *obex, GObexFunc func,
  44                                                         gpointer user_data);
  45 guint g_obex_add_request_function(GObex *obex, guint8 opcode,
  46                                                 GObexRequestFunc func,
  47                                                 gpointer user_data);
  48 gboolean g_obex_remove_request_function(GObex *obex, guint id);
  49
  50 void g_obex_suspend(GObex *obex);
  51 void g_obex_resume(GObex *obex);
  52 gboolean g_obex_srm_active(GObex *obex);
  53 void g_obex_drop_tx_queue(GObex *obex);
  54
  55 GObex *g_obex_new(GIOChannel *io, GObexTransportType transport_type,
  56                                                 gssize rx_mtu, gssize tx_mtu);
  57
  58 GObex *g_obex_ref(GObex *obex);
  59 void g_obex_unref(GObex *obex);
  60
  61 /* High level client functions */
  62
  63 guint g_obex_connect(GObex *obex, GObexResponseFunc func, gpointer user_data,
  64                                 GError **err, guint first_hdr_id, ...);
  65
  66 guint g_obex_disconnect(GObex *obex, GObexResponseFunc func, gpointer user_data,
  67                                                                 GError **err);
  68
  69 guint g_obex_setpath(GObex *obex, const char *path, GObexResponseFunc func,
  70                                         gpointer user_data, GError **err);
  71
  72 guint g_obex_mkdir(GObex *obex, const char *path, GObexResponseFunc func,
  73                                         gpointer user_data, GError **err);
  74
  75 guint g_obex_delete(GObex *obex, const char *name, GObexResponseFunc func,
  76                                         gpointer user_data, GError **err);
  77
  78 guint g_obex_copy(GObex *obex, const char *name, const char *dest,
  79                         GObexResponseFunc func, gpointer user_data,
  80                         GError **err);
  81
  82 guint g_obex_move(GObex *obex, const char *name, const char *dest,
  83                         GObexResponseFunc func, gpointer user_data,
  84                         GError **err);
  85
  86 guint g_obex_abort(GObex *obex, GObexResponseFunc func, gpointer user_data,
  87                                                                 GError **err);
  88
  89 /* Transfer related high-level functions */
  90
  91 guint g_obex_put_req(GObex *obex, GObexDataProducer data_func,
  92                         GObexFunc complete_func, gpointer user_data,
  93                         GError **err, guint first_hdr_id, ...);
  94
  95 guint g_obex_put_req_pkt(GObex *obex, GObexPacket *req,
  96                         GObexDataProducer data_func, GObexFunc complete_func,
  97                         gpointer user_data, GError **err);
  98
  99 guint g_obex_get_req(GObex *obex, GObexDataConsumer data_func,
 100                         GObexFunc complete_func, gpointer user_data,
 101                         GError **err, guint first_hdr_id, ...);
 102
 103 guint g_obex_get_req_pkt(GObex *obex, GObexPacket *req,
 104                         GObexDataConsumer data_func, GObexFunc complete_func,
 105                         gpointer user_data, GError **err);
 106
 107 guint g_obex_put_rsp(GObex *obex, GObexPacket *req,
 108                         GObexDataConsumer data_func, GObexFunc complete_func,
 109                         gpointer user_data, GError **err,
 110                         guint first_hdr_id, ...);
 111
 112 guint g_obex_get_rsp(GObex *obex, GObexDataProducer data_func,
 113                         GObexFunc complete_func, gpointer user_data,
 114                         GError **err, guint first_hdr_id, ...);
 115
 116 guint g_obex_get_rsp_pkt(GObex *obex, GObexPacket *rsp,
 117                         GObexDataProducer data_func, GObexFunc complete_func,
 118                         gpointer user_data, GError **err);
 119
 120 gboolean g_obex_cancel_transfer(guint id, GObexFunc complete_func,
 121                                                         gpointer user_data);
 122
 123 const char *g_obex_strerror(guint8 err_code);
 124 guint8 g_obex_errno_to_rsp(int err);
 125 #ifdef TIZEN_FEATURE_BLUEZ_MODIFY
 126 void g_obex_io_shutdown(GObex *obex);
 127 #endif
 128
 129 #endif /* __GOBEX_H */