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