6 * Copyright (C) 2013 SIPE Project <http://sipe.sourceforge.net/>
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.
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.
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
24 * Public interface to HTTP request service
28 * Interface dependencies:
33 /* Forward declarations */
34 struct sipe_core_private
;
35 struct sipe_http_request
;
36 struct sipe_http_session
;
39 * HTTP response callback
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
47 typedef void (sipe_http_response_callback
)(struct sipe_core_private
*sipe_private
,
51 gpointer callback_data
);
53 /* HTTP response status codes */
54 #define SIPE_HTTP_STATUS_OK 200
55 #define SIPE_HTTP_STATUS_CLIENT_ERROR 400 /* - 499 */
56 #define SIPE_HTTP_STATUS_CLIENT_UNAUTHORIZED 401
61 * @param sipe_private SIPE core private data
63 void sipe_http_free(struct sipe_core_private
*sipe_private
);
68 * @return pointer to opaque HTTP session data structure
70 struct sipe_http_session
*sipe_http_session_start(void);
75 * @param session pointer to opaque HTTP session data structure
77 void sipe_http_session_close(struct sipe_http_session
*session
);
80 * Create HTTP GET request
82 * @param sipe_private SIPE core private data
84 * @param headers additional headers (may be @c NULL)
85 * @param callback callback function
86 * @param callback_data callback data
88 * @return pointer to opaque HTTP request data structure (@c NULL if failed)
90 struct sipe_http_request
*sipe_http_request_get(struct sipe_core_private
*sipe_private
,
93 sipe_http_response_callback
*callback
,
94 gpointer callback_data
);
97 * Create HTTP POST request
99 * @param sipe_private SIPE core private data
101 * @param headers additional headers (may be @c NULL)
102 * @param body body contents
103 * @param content_type body content type
104 * @param callback callback function
105 * @param callback_data callback data
107 * @return pointer to opaque HTTP request data structure (@c NULL if failed)
109 struct sipe_http_request
*sipe_http_request_post(struct sipe_core_private
*sipe_private
,
111 const gchar
*headers
,
113 const gchar
*content_type
,
114 sipe_http_response_callback
*callback
,
115 gpointer callback_data
);
118 * HTTP request is ready to be sent
120 * @param request pointer to opaque HTTP request data structure
122 void sipe_http_request_ready(struct sipe_http_request
*request
);
125 * Cancel pending HTTP request
127 * @param request pointer to opaque HTTP request data structure
129 void sipe_http_request_cancel(struct sipe_http_request
*request
);
132 * Assign request to HTTP session
134 * @param request pointer to opaque HTTP request data structure
135 * @param session pointer to opaque HTTP session data structure
137 void sipe_http_request_session(struct sipe_http_request
*request
,
138 struct sipe_http_session
*session
);
141 * Allow redirection of HTTP request
143 * @param request pointer to opaque HTTP request data structure
145 void sipe_http_request_allow_redirect(struct sipe_http_request
*request
);
148 * Provide authentication information for HTTP request
150 * @param request pointer to opaque HTTP request data structure
151 * @param domain domain name (MUST stay valid for duration of request!)
152 * @param user user name (MUST stay valid for duration of request!)
153 * @param password Password (MUST stay valid for duration of request!)
155 void sipe_http_request_authentication(struct sipe_http_request
*request
,
158 const gchar
*password
);