source: lib/http_client.h @ 0156c42

Last change on this file since 0156c42 was 5ebff60, checked in by dequis <dx@…>, at 2015-02-20T22:50:54Z

Reindent everything to K&R style with tabs

Used uncrustify, with the configuration file in ./doc/uncrustify.cfg

Commit author set to "Indent <please@…>" so that it's easier to
skip while doing git blame.

  • Property mode set to 100644
File size: 3.8 KB
Line 
1/********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2012 Wilmer van der Gaast and others                *
5  \********************************************************************/
6
7/* HTTP(S) module                                                       */
8
9/*
10  This program is free software; you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation; either version 2 of the License, or
13  (at your option) any later version.
14
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  GNU General Public License for more details.
19
20  You should have received a copy of the GNU General Public License with
21  the Debian GNU/Linux distribution in /usr/share/common-licenses/GPL;
22  if not, write to the Free Software Foundation, Inc., 51 Franklin St.,
23  Fifth Floor, Boston, MA  02110-1301  USA
24*/
25
26/* http_client allows you to talk (asynchronously, again) to HTTP servers.
27   In the "background" it will send the whole query and wait for a complete
28   response to come back. Initially written for MS Passport authentication,
29   but used for many other things now like OAuth and Twitter.
30
31   It's very useful for doing quick requests without blocking the whole
32   program. Unfortunately it doesn't support fancy stuff like HTTP keep-
33   alives. */
34
35#include <glib.h>
36#include "ssl_client.h"
37
38struct http_request;
39
40typedef enum http_client_flags {
41        HTTPC_STREAMING = 1,
42        HTTPC_EOF = 2,
43        HTTPC_CHUNKED = 4,
44
45        /* Let's reserve 0x1000000+ for lib users. */
46} http_client_flags_t;
47
48/* Your callback function should look like this: */
49typedef void (*http_input_function)(struct http_request *);
50
51/* This structure will be filled in by the http_dorequest* functions, and
52   it will be passed to the callback function. Use the data field to add
53   your own data. */
54struct http_request {
55        char *request;          /* The request to send to the server. */
56        int request_length;     /* Its size. */
57        short status_code;      /* The numeric HTTP status code. (Or -1
58                                   if something really went wrong) */
59        char *status_string;    /* The error text. */
60        char *reply_headers;
61        char *reply_body;
62        int body_size;          /* The number of bytes in reply_body. */
63        short redir_ttl;        /* You can set it to 0 if you don't want
64                                   http_client to follow them. */
65
66        http_client_flags_t flags;
67
68        http_input_function func;
69        gpointer data;
70
71        /* Please don't touch the things down here, you shouldn't need them. */
72        void *ssl;
73        int fd;
74
75        int inpa;
76        int bytes_written;
77        int bytes_read;
78        int content_length;     /* "Content-Length:" header or -1 */
79
80        /* Used in streaming mode. Caller should read from reply_body. */
81        char *sbuf;
82        size_t sblen;
83
84        /* Chunked encoding only. Raw chunked stream is decoded from here. */
85        char *cbuf;
86        size_t cblen;
87};
88
89/* The _url variant is probably more useful than the raw version. The raw
90   version is probably only useful if you want to do POST requests or if
91   you want to add some extra headers. As you can see, HTTPS connections
92   are also supported (using ssl_client). */
93struct http_request *http_dorequest(char *host, int port, int ssl, char *request, http_input_function func,
94                                    gpointer data);
95struct http_request *http_dorequest_url(char *url_string, http_input_function func, gpointer data);
96
97/* For streaming connections only; flushes len bytes at the start of the buffer. */
98void http_flush_bytes(struct http_request *req, size_t len);
99void http_close(struct http_request *req);
Note: See TracBrowser for help on using the repository browser.