src/core/sipe-http-request.h

   1 /**
   2  * @file sipe-http-request.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 /* Private interface between HTTP Public <-> Request <-> Transport layers */
  25 #ifndef _SIPE_HTTP_PRIVATE_IF_REQUEST
  26 #error "you are not allowed to include sipe-http-request.h!"
  27 #endif
  28
  29 /*
  30  * Interface dependencies:
  31  *
  32  * <glib.h>
  33  */
  34
  35 /* Forward declarations */
  36 struct sipmsg;
  37 struct sipe_core_private;
  38 struct sipe_http_connection_public;
  39 struct sipe_http_request;
  40
  41 /**
  42  * Is there pending request for HTTP connection?
  43  *
  44  * @param conn_public HTTP connection public data
  45  */
  46 gboolean sipe_http_request_pending(struct sipe_http_connection_public *conn_public);
  47
  48 /**
  49  * HTTP connection is ready for next request
  50  *
  51  * @param conn_public HTTP connection public data
  52  */
  53 void sipe_http_request_next(struct sipe_http_connection_public *conn_public);
  54
  55 /**
  56  * HTTP response received
  57  *
  58  * @param conn_public HTTP connection public data
  59  * @param msg         parsed message
  60  */
  61 void sipe_http_request_response(struct sipe_http_connection_public *conn_public,
  62                                 struct sipmsg *msg);
  63
  64 /**
  65  * HTTP connection shutdown
  66  *
  67  * @param conn_public HTTP connection public data
  68  */
  69 void sipe_http_request_shutdown(struct sipe_http_connection_public *conn_public);
  70
  71 /**
  72  * Create new HTTP request (internal raw version)
  73  *
  74  * @param sipe_private  SIPE core private data
  75  * @param host          name of the host to connect to
  76  * @param port          port number to connect to
  77  * @param path          relative path
  78  * @param headers       additional headers to add (may be @c NULL)
  79  * @param body          body                      (may be @c NULL)
  80  * @param content_type  MIME type for body (may be @c NULL if body is @c NULL)
  81  * @param callback      callback function
  82  * @param callback_data callback data
  83  *
  84  * @return pointer to opaque HTTP request data structure
  85  */
  86 struct sipe_http_request *sipe_http_request_new(struct sipe_core_private *sipe_private,
  87                                                 const gchar *host,
  88                                                 guint32 port,
  89                                                 const gchar *path,
  90                                                 const gchar *headers,
  91                                                 const gchar *body,
  92                                                 const gchar *content_type,
  93                                                 sipe_http_response_callback *callback,
  94                                                 gpointer callback_data);