gobex/gobex.h

   1 /*
   2  *
   3  *  OBEX library with GLib integration
   4  *
   5  *  Copyright (C) 2011  Intel Corporation. All rights reserved.
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License version 2 as
   9  *  published by the Free Software Foundation.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  */
  21
  22 #ifndef __GOBEX_H
  23 #define __GOBEX_H
  24
  25 #include <stdarg.h>
  26 #include <glib.h>
  27
  28 #include <gobex/gobex-defs.h>
  29 #include <gobex/gobex-packet.h>
  30
  31 typedef enum {
  32         G_OBEX_TRANSPORT_STREAM,
  33         G_OBEX_TRANSPORT_PACKET,
  34 } GObexTransportType;
  35
  36 typedef struct _GObex GObex;
  37
  38 typedef void (*GObexFunc) (GObex *obex, GError *err, gpointer user_data);
  39 typedef void (*GObexRequestFunc) (GObex *obex, GObexPacket *req,
  40                                                         gpointer user_data);
  41 typedef void (*GObexResponseFunc) (GObex *obex, GError *err, GObexPacket *rsp,
  42                                                         gpointer user_data);
  43
  44 gboolean g_obex_send(GObex *obex, GObexPacket *pkt, GError **err);
  45
  46 guint g_obex_send_req(GObex *obex, GObexPacket *req, gint timeout,
  47                         GObexResponseFunc func, gpointer user_data,
  48                         GError **err);
  49 gboolean g_obex_cancel_req(GObex *obex, guint req_id,
  50                                                 gboolean remove_callback);
  51
  52 gboolean g_obex_pending_req_abort(GObex *obex, GError **err);
  53
  54 gboolean g_obex_send_rsp(GObex *obex, guint8 rspcode, GError **err,
  55                                                 guint8 first_hdr_type, ...);
  56
  57 void g_obex_set_disconnect_function(GObex *obex, GObexFunc func,
  58                                                         gpointer user_data);
  59 guint g_obex_add_request_function(GObex *obex, guint8 opcode,
  60                                                 GObexRequestFunc func,
  61                                                 gpointer user_data);
  62 gboolean g_obex_remove_request_function(GObex *obex, guint id);
  63
  64 void g_obex_suspend(GObex *obex);
  65 void g_obex_resume(GObex *obex);
  66 gboolean g_obex_srm_active(GObex *obex);
  67
  68 GObex *g_obex_new(GIOChannel *io, GObexTransportType transport_type,
  69                                                 gssize rx_mtu, gssize tx_mtu);
  70
  71 GObex *g_obex_ref(GObex *obex);
  72 void g_obex_unref(GObex *obex);
  73
  74 /* High level client functions */
  75
  76 guint g_obex_connect(GObex *obex, GObexResponseFunc func, gpointer user_data,
  77                                 GError **err, guint8 first_hdr_id, ...);
  78
  79 guint g_obex_setpath(GObex *obex, const char *path, GObexResponseFunc func,
  80                                         gpointer user_data, GError **err);
  81
  82 guint g_obex_mkdir(GObex *obex, const char *path, GObexResponseFunc func,
  83                                         gpointer user_data, GError **err);
  84
  85 guint g_obex_delete(GObex *obex, const char *name, GObexResponseFunc func,
  86                                         gpointer user_data, GError **err);
  87
  88 guint g_obex_copy(GObex *obex, const char *name, const char *dest,
  89                         GObexResponseFunc func, gpointer user_data,
  90                         GError **err);
  91
  92 guint g_obex_move(GObex *obex, const char *name, const char *dest,
  93                         GObexResponseFunc func, gpointer user_data,
  94                         GError **err);
  95
  96 /* Transfer related high-level functions */
  97
  98 guint g_obex_put_req(GObex *obex, GObexDataProducer data_func,
  99                         GObexFunc complete_func, gpointer user_data,
 100                         GError **err, guint8 first_hdr_id, ...);
 101
 102 guint g_obex_put_req_pkt(GObex *obex, GObexPacket *req,
 103                         GObexDataProducer data_func, GObexFunc complete_func,
 104                         gpointer user_data, GError **err);
 105
 106 guint g_obex_get_req(GObex *obex, GObexDataConsumer data_func,
 107                         GObexFunc complete_func, gpointer user_data,
 108                         GError **err, guint8 first_hdr_id, ...);
 109
 110 guint g_obex_get_req_pkt(GObex *obex, GObexPacket *req,
 111                         GObexDataConsumer data_func, GObexFunc complete_func,
 112                         gpointer user_data, GError **err);
 113
 114 guint g_obex_put_rsp(GObex *obex, GObexPacket *req,
 115                         GObexDataConsumer data_func, GObexFunc complete_func,
 116                         gpointer user_data, GError **err,
 117                         guint8 first_hdr_id, ...);
 118
 119 guint g_obex_get_rsp(GObex *obex, GObexDataProducer data_func,
 120                         GObexFunc complete_func, gpointer user_data,
 121                         GError **err, guint8 first_hdr_id, ...);
 122
 123 guint g_obex_get_rsp_pkt(GObex *obex, GObexPacket *rsp,
 124                         GObexDataProducer data_func, GObexFunc complete_func,
 125                         gpointer user_data, GError **err);
 126
 127 gboolean g_obex_cancel_transfer(guint id, GObexFunc complete_func,
 128                                                         gpointer user_data);
 129
 130 const char *g_obex_strerror(guint8 err_code);
 131 guint8 g_obex_errno_to_rsp(int err);
 132
 133 #endif /* __GOBEX_H */