src/core/sipe-http.h

   1 /**
   2  * @file sipe-http.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2013 SIPE Project <http://sipe.sourceforge.net/>
   7  *
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 /* Public interface to HTTP request service */
  25
  26 /*
  27  * Interface dependencies:
  28  *
  29  * <glib.h>
  30  */
  31
  32 /* Forward declarations */
  33 struct sipe_core_private;
  34 struct sipe_http_request;
  35 struct sipe_http_session;
  36
  37 /**
  38  * HTTP response callback
  39  *
  40  * @param sipe_private  SIPE core private data
  41  * @param status        status code
  42  * @param body          response body (@c NULL if request aborted)
  43  * @param callback_data callback data
  44  */
  45 typedef void (sipe_http_response_callback)(struct sipe_core_private *sipe_private,
  46                                            guint status,
  47                                            const gchar *body,
  48                                            gpointer callback_data);
  49
  50 /* HTTP status codes */
  51 #define SIPE_HTTP_STATUS_OK 200
  52
  53 /**
  54  * Free HTTP data
  55  *
  56  * @param sipe_private SIPE core private data
  57  */
  58 void sipe_http_free(struct sipe_core_private *sipe_private);
  59
  60 /**
  61  * Start HTTP session
  62  *
  63  * @return pointer to opaque HTTP session data structure
  64  */
  65 struct sipe_http_session *sipe_http_session_start(void);
  66
  67 /**
  68  * Close HTTP session
  69  *
  70  * @param session pointer to opaque HTTP session data structure
  71  */
  72 void sipe_http_session_close(struct sipe_http_session *session);
  73
  74 /**
  75  * Create HTTP GET request
  76  *
  77  * @param sipe_private SIPE core private data
  78  * @param uri          URI
  79  * @param headers      additional headers (may be @c NULL)
  80  *
  81  * @return pointer to opaque HTTP request data structure (@c NULL if failed)
  82  */
  83 struct sipe_http_request *sipe_http_request_get(struct sipe_core_private *sipe_private,
  84                                                 const gchar *uri,
  85                                                 const gchar *headers,
  86                                                 sipe_http_response_callback *callback,
  87                                                 gpointer callback_data);
  88
  89 /**
  90  * Create HTTP POST request
  91  *
  92  * @param sipe_private SIPE core private data
  93  * @param uri          URI
  94  * @param headers      additional headers (may be @c NULL)
  95  * @param body         body contents
  96  * @param content_type body content type
  97  *
  98  * @return pointer to opaque HTTP request data structure (@c NULL if failed)
  99  */
 100 struct sipe_http_request *sipe_http_request_post(struct sipe_core_private *sipe_private,
 101                                                  const gchar *uri,
 102                                                  const gchar *headers,
 103                                                  const gchar *body,
 104                                                  const gchar *content_type,
 105                                                  sipe_http_response_callback *callback,
 106                                                  gpointer callback_data);
 107
 108 /**
 109  * Cancel pending HTTP request
 110  *
 111  * @param pointer to opaque HTTP request data structure
 112  */
 113 void sipe_http_request_cancel(struct sipe_http_request *request);
 114
 115 /**
 116  * Assign request to HTTP session
 117  *
 118  * @param request pointer to opaque HTTP request data structure
 119  * @param session pointer to opaque HTTP session data structure
 120  */
 121 void sipe_http_request_session(struct sipe_http_request *request,
 122                                const struct sipe_http_session *session);