http_client.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 */
#ifndef __PJLIB_UTIL_HTTP_CLIENT_H__
#define __PJLIB_UTIL_HTTP_CLIENT_H__
 
#include <pj/activesock.h>
#include <pjlib-util/types.h>
 
PJ_BEGIN_DECL
 
typedef struct pj_http_req pj_http_req;
 
#define PJ_HTTP_HEADER_SIZE 32
 
typedef struct pj_http_header_elmt
{
    pj_str_t name;      
    pj_str_t value;     
} pj_http_header_elmt;
 
typedef struct pj_http_headers
{
    unsigned     count;
 
    pj_http_header_elmt header[PJ_HTTP_HEADER_SIZE];
} pj_http_headers;
 
typedef struct pj_http_auth_cred
{
    pj_str_t    scheme;
 
    pj_str_t    realm;
 
    pj_str_t    username;
 
    unsigned    data_type;
 
    pj_str_t    data;
 
} pj_http_auth_cred;
 
 
typedef struct pj_http_req_param 
{
    int             addr_family;
 
    pj_str_t        method;
 
    pj_str_t        version;
 
    pj_time_val     timeout;
 
    void            *user_data;
 
    pj_http_headers headers;
 
    struct pj_http_reqdata
    {
        void       *data;          
        pj_size_t  size;           
        pj_size_t  total_size;     
    } reqdata; 
    pj_http_auth_cred   auth_cred;
 
    pj_uint16_t         source_port_range_start;
 
    pj_uint16_t         source_port_range_size;
 
    pj_uint16_t         max_retries;
 
} pj_http_req_param;
 
typedef struct pj_http_auth_chal
{
    pj_str_t    scheme;         
    pj_str_t    realm;          
    pj_str_t    domain;         
    pj_str_t    nonce;          
    pj_str_t    opaque;         
    int         stale;          
    pj_str_t    algorithm;      
    pj_str_t    qop;            
} pj_http_auth_chal;
 
typedef struct pj_http_resp
{
    pj_str_t        version;        
    pj_uint16_t     status_code;    
    pj_str_t        reason;         
    pj_http_headers headers;        
    pj_http_auth_chal auth_chal;    
    pj_int32_t      content_length; 
    void            *data;          
    pj_size_t       size;           
} pj_http_resp;
 
typedef struct pj_http_url
{
    pj_str_t    username;           
    pj_str_t    passwd;             
    pj_str_t    protocol;           
    pj_str_t    host;               
    pj_uint16_t port;               
    pj_str_t    path;               
} pj_http_url;
 
typedef struct pj_http_req_callback
{
    void (*on_response)(pj_http_req *http_req, const pj_http_resp *resp);
 
    void (*on_send_data)(pj_http_req *http_req,
                         void **data, pj_size_t *size);
 
    void (*on_data_read)(pj_http_req *http_req,
                         void *data, pj_size_t size);
 
    void (*on_complete)(pj_http_req *http_req,
                        pj_status_t status,
                        const pj_http_resp *resp);
 
} pj_http_req_callback;
 
 
PJ_DECL(void) pj_http_req_param_default(pj_http_req_param *param);
 
PJ_DECL(pj_status_t) pj_http_headers_add_elmt(pj_http_headers *headers, 
                                              pj_str_t *name, 
                                              pj_str_t *val);
 
PJ_DECL(pj_status_t) pj_http_headers_add_elmt2(pj_http_headers *headers, 
                                               char *name, char *val);
 
PJ_DECL(pj_status_t) pj_http_req_parse_url(const pj_str_t *url, 
                                           pj_http_url *hurl);
 
PJ_DECL(pj_status_t) pj_http_req_create(pj_pool_t *pool,
                                        const pj_str_t *url,
                                        pj_timer_heap_t *timer,
                                        pj_ioqueue_t *ioqueue,
                                        const pj_http_req_param *param,
                                        const pj_http_req_callback *hcb,
                                        pj_http_req **http_req);
 
PJ_DECL(void) pj_http_req_set_timeout(pj_http_req *http_req,
                                      const pj_time_val* timeout);
 
PJ_DECL(pj_status_t) pj_http_req_start(pj_http_req *http_req);
 
PJ_DECL(pj_status_t) pj_http_req_cancel(pj_http_req *http_req,
                                        pj_bool_t notify);
 
PJ_DECL(pj_status_t) pj_http_req_destroy(pj_http_req *http_req);
 
PJ_DECL(pj_bool_t) pj_http_req_is_running(const pj_http_req *http_req);
 
PJ_DECL(void *) pj_http_req_get_user_data(pj_http_req *http_req);
 
PJ_END_DECL
 
 
#endif  /* __PJLIB_UTIL_HTTP_CLIENT_H__ */