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 /*
  28  * Interface dependencies:
  29  *
  30  * <glib.h>
  31  */
  32
  33 /* Forward declarations */
  34 struct sipe_core_private;
  35 struct sipe_http_request;
  36 struct sipe_http_session;
  37
  38 /**
  39  * HTTP response callback
  40  *
  41  * @param sipe_private  SIPE core private data
  42  * @param status        status code
  43  * @param headers       response headers (@c NULL if request aborted)
  44  * @param body          response body    (@c NULL if request aborted)
  45  * @param callback_data callback data
  46  */
  47 typedef void (sipe_http_response_callback)(struct sipe_core_private *sipe_private,
  48                                            guint status,
  49                                            GSList *headers,
  50                                            const gchar *body,
  51                                            gpointer callback_data);
  52
  53 /* HTTP response status codes */
  54 #define SIPE_HTTP_STATUS_OK           200
  55 #define SIPE_HTTP_STATUS_CLIENT_ERROR 400 /* - 499 */
  56
  57 /**
  58  * Free HTTP data
  59  *
  60  * @param sipe_private SIPE core private data
  61  */
  62 void sipe_http_free(struct sipe_core_private *sipe_private);
  63
  64 /**
  65  * Start HTTP session
  66  *
  67  * @return pointer to opaque HTTP session data structure
  68  */
  69 struct sipe_http_session *sipe_http_session_start(void);
  70
  71 /**
  72  * Close HTTP session
  73  *
  74  * @param session pointer to opaque HTTP session data structure
  75  */
  76 void sipe_http_session_close(struct sipe_http_session *session);
  77
  78 /**
  79  * Create HTTP GET request
  80  *
  81  * @param sipe_private  SIPE core private data
  82  * @param uri           URI
  83  * @param headers       additional headers (may be @c NULL)
  84  * @param callback      callback function
  85  * @param callback_data callback data
  86  *
  87  * @return pointer to opaque HTTP request data structure (@c NULL if failed)
  88  */
  89 struct sipe_http_request *sipe_http_request_get(struct sipe_core_private *sipe_private,
  90                                                 const gchar *uri,
  91                                                 const gchar *headers,
  92                                                 sipe_http_response_callback *callback,
  93                                                 gpointer callback_data);
  94
  95 /**
  96  * Create HTTP POST request
  97  *
  98  * @param sipe_private  SIPE core private data
  99  * @param uri           URI
 100  * @param headers       additional headers (may be @c NULL)
 101  * @param body          body contents
 102  * @param content_type  body content type
 103  * @param callback      callback function
 104  * @param callback_data callback data
 105  *
 106  * @return pointer to opaque HTTP request data structure (@c NULL if failed)
 107  */
 108 struct sipe_http_request *sipe_http_request_post(struct sipe_core_private *sipe_private,
 109                                                  const gchar *uri,
 110                                                  const gchar *headers,
 111                                                  const gchar *body,
 112                                                  const gchar *content_type,
 113                                                  sipe_http_response_callback *callback,
 114                                                  gpointer callback_data);
 115
 116 /**
 117  * HTTP request is ready to be sent
 118  *
 119  * @param request pointer to opaque HTTP request data structure
 120  */
 121 void sipe_http_request_ready(struct sipe_http_request *request);
 122
 123 /**
 124  * Cancel pending HTTP request
 125  *
 126  * @param request pointer to opaque HTTP request data structure
 127  */
 128 void sipe_http_request_cancel(struct sipe_http_request *request);
 129
 130 /**
 131  * Assign request to HTTP session
 132  *
 133  * @param request pointer to opaque HTTP request data structure
 134  * @param session pointer to opaque HTTP session data structure
 135  */
 136 void sipe_http_request_session(struct sipe_http_request *request,
 137                                struct sipe_http_session *session);
 138
 139 /**
 140  * Allow redirection of HTTP request
 141  *
 142  * @param request pointer to opaque HTTP request data structure
 143  */
 144 void sipe_http_request_allow_redirect(struct sipe_http_request *request);
 145
 146 /**
 147  * Provide authentication information for HTTP request
 148  *
 149  * @param request  pointer to opaque HTTP request data structure
 150  * @param domain   domain name (MUST stay valid for duration of request!)
 151  * @param user     user name   (MUST stay valid for duration of request!)
 152  * @param password Password    (MUST stay valid for duration of request!)
 153  */
 154 void sipe_http_request_authentication(struct sipe_http_request *request,
 155                                       const gchar *domain,
 156                                       const gchar *user,
 157                                       const gchar *password);