git.m6w6.name Git - m6w6/ext-http/blob - src/php_http_client.h

   1 /*
   2     +--------------------------------------------------------------------+
   3     | PECL :: http                                                       |
   4     +--------------------------------------------------------------------+
   5     | Redistribution and use in source and binary forms, with or without |
   6     | modification, are permitted provided that the conditions mentioned |
   7     | in the accompanying LICENSE file are met.                          |
   8     +--------------------------------------------------------------------+
   9     | Copyright (c) 2004-2014, Michael Wallner <mike@php.net>            |
  10     +--------------------------------------------------------------------+
  11 */
  12
  13 #ifndef PHP_HTTP_CLIENT_H
  14 #define PHP_HTTP_CLIENT_H
  15
  16 typedef enum php_http_client_setopt_opt {
  17         PHP_HTTP_CLIENT_OPT_ENABLE_PIPELINING,
  18         PHP_HTTP_CLIENT_OPT_USE_EVENTS,
  19         PHP_HTTP_CLIENT_OPT_CONFIGURATION,
  20 } php_http_client_setopt_opt_t;
  21
  22 typedef enum php_http_client_getopt_opt {
  23         PHP_HTTP_CLIENT_OPT_PROGRESS_INFO,              /* php_http_client_enqueue_t*, php_http_client_progress_state_t** */
  24         PHP_HTTP_CLIENT_OPT_TRANSFER_INFO,              /* php_http_client_enqueue_t*, HashTable* */
  25         PHP_HTTP_CLIENT_OPT_AVAILABLE_OPTIONS,          /* NULL, HashTable* */
  26         PHP_HTTP_CLIENT_OPT_AVAILABLE_CONFIGURATION,/* NULL, HashTable */
  27 } php_http_client_getopt_opt_t;
  28
  29 typedef struct php_http_client_enqueue {
  30         php_http_message_t *request; /* unique */
  31         HashTable *options;
  32         void (*dtor)(struct php_http_client_enqueue *);
  33         void *opaque;
  34         struct {
  35                 zend_fcall_info fci;
  36                 zend_fcall_info_cache fcc;
  37         } closure;
  38 } php_http_client_enqueue_t;
  39
  40 typedef struct php_http_client *(*php_http_client_init_func_t)(struct php_http_client *p, void *init_arg);
  41 typedef struct php_http_client *(*php_http_client_copy_func_t)(struct php_http_client *from, struct php_http_client *to);
  42 typedef void (*php_http_client_dtor_func_t)(struct php_http_client *p);
  43 typedef void (*php_http_client_reset_func_t)(struct php_http_client *p);
  44 typedef ZEND_RESULT_CODE (*php_http_client_exec_func_t)(struct php_http_client *p);
  45 typedef int (*php_http_client_once_func_t)(struct php_http_client *p);
  46 typedef ZEND_RESULT_CODE (*php_http_client_wait_func_t)(struct php_http_client *p, struct timeval *custom_timeout);
  47 typedef ZEND_RESULT_CODE (*php_http_client_enqueue_func_t)(struct php_http_client *p, php_http_client_enqueue_t *enqueue);
  48 typedef ZEND_RESULT_CODE (*php_http_client_dequeue_func_t)(struct php_http_client *p, php_http_client_enqueue_t *enqueue);
  49 typedef ZEND_RESULT_CODE (*php_http_client_setopt_func_t)(struct php_http_client *p, php_http_client_setopt_opt_t opt, void *arg);
  50 typedef ZEND_RESULT_CODE (*php_http_client_getopt_func_t)(struct php_http_client *h, php_http_client_getopt_opt_t opt, void *arg, void **res);
  51
  52 typedef struct php_http_client_ops {
  53         php_resource_factory_ops_t *rsrc;
  54         php_http_client_init_func_t init;
  55         php_http_client_copy_func_t copy;
  56         php_http_client_dtor_func_t dtor;
  57         php_http_client_reset_func_t reset;
  58         php_http_client_exec_func_t exec;
  59         php_http_client_wait_func_t wait;
  60         php_http_client_once_func_t once;
  61         php_http_client_enqueue_func_t enqueue;
  62         php_http_client_dequeue_func_t dequeue;
  63         php_http_client_setopt_func_t setopt;
  64         php_http_client_getopt_func_t getopt;
  65 } php_http_client_ops_t;
  66
  67 typedef struct php_http_client_driver {
  68         zend_string *driver_name;
  69         zend_string *client_name;
  70         zend_string *request_name;
  71         php_http_client_ops_t *client_ops;
  72 } php_http_client_driver_t;
  73
  74 PHP_HTTP_API ZEND_RESULT_CODE php_http_client_driver_add(php_http_client_driver_t *driver);
  75 PHP_HTTP_API php_http_client_driver_t *php_http_client_driver_get(zend_string *name);
  76
  77 typedef struct php_http_client_progress_state {
  78         struct {
  79                 double now;
  80                 double total;
  81         } ul;
  82         struct {
  83                 double now;
  84                 double total;
  85         } dl;
  86         const char *info;
  87         unsigned started:1;
  88         unsigned finished:1;
  89 } php_http_client_progress_state_t;
  90
  91 typedef ZEND_RESULT_CODE (*php_http_client_response_callback_t)(void *arg, struct php_http_client *client, php_http_client_enqueue_t *e, php_http_message_t **response);
  92 typedef void (*php_http_client_progress_callback_t)(void *arg, struct php_http_client *client, php_http_client_enqueue_t *e, php_http_client_progress_state_t *state);
  93 typedef void (*php_http_client_debug_callback_t)(void *arg, struct php_http_client *client, php_http_client_enqueue_t *e, unsigned type, const char *data, size_t size);
  94
  95 #define PHP_HTTP_CLIENT_DEBUG_INFO              0x00
  96 #define PHP_HTTP_CLIENT_DEBUG_IN                0x01
  97 #define PHP_HTTP_CLIENT_DEBUG_OUT               0x02
  98 #define PHP_HTTP_CLIENT_DEBUG_HEADER    0x10
  99 #define PHP_HTTP_CLIENT_DEBUG_BODY              0x20
 100 #define PHP_HTTP_CLIENT_DEBUG_SSL               0x40
 101
 102 typedef struct php_http_client {
 103         void *ctx;
 104         php_resource_factory_t *rf;
 105         php_http_client_ops_t *ops;
 106
 107         struct {
 108                 struct {
 109                         php_http_client_response_callback_t func;
 110                         void *arg;
 111                 } response;
 112                 struct {
 113                         php_http_client_progress_callback_t func;
 114                         void *arg;
 115                 } progress;
 116                 struct {
 117                         php_http_client_debug_callback_t func;
 118                         void *arg;
 119                 } debug;
 120                 unsigned depth;
 121         } callback;
 122
 123         zend_llist requests;
 124         zend_llist responses;
 125 } php_http_client_t;
 126
 127 PHP_HTTP_API zend_class_entry *php_http_client_get_class_entry();
 128
 129 typedef struct php_http_client_object {
 130         php_http_client_t *client;
 131         php_http_object_method_t *update;
 132         php_http_object_method_t notify;
 133         struct {
 134                 zend_fcall_info fci;
 135                 zend_fcall_info_cache fcc;
 136         } debug;
 137         long iterator;
 138         zval *gc;
 139         zend_object zo;
 140 } php_http_client_object_t;
 141
 142 PHP_HTTP_API php_http_client_t *php_http_client_init(php_http_client_t *h, php_http_client_ops_t *ops, php_resource_factory_t *rf, void *init_arg);
 143 PHP_HTTP_API php_http_client_t *php_http_client_copy(php_http_client_t *from, php_http_client_t *to);
 144 PHP_HTTP_API void php_http_client_dtor(php_http_client_t *h);
 145 PHP_HTTP_API void php_http_client_free(php_http_client_t **h);
 146
 147 PHP_HTTP_API ZEND_RESULT_CODE php_http_client_enqueue(php_http_client_t *h, php_http_client_enqueue_t *enqueue);
 148 PHP_HTTP_API ZEND_RESULT_CODE php_http_client_dequeue(php_http_client_t *h, php_http_message_t *request);
 149
 150 PHP_HTTP_API ZEND_RESULT_CODE php_http_client_wait(php_http_client_t *h, struct timeval *custom_timeout);
 151 PHP_HTTP_API int php_http_client_once(php_http_client_t *h);
 152
 153 PHP_HTTP_API ZEND_RESULT_CODE php_http_client_exec(php_http_client_t *h);
 154 PHP_HTTP_API void php_http_client_reset(php_http_client_t *h);
 155
 156 PHP_HTTP_API ZEND_RESULT_CODE php_http_client_setopt(php_http_client_t *h, php_http_client_setopt_opt_t opt, void *arg);
 157 PHP_HTTP_API ZEND_RESULT_CODE php_http_client_getopt(php_http_client_t *h, php_http_client_getopt_opt_t opt, void *arg, void *res_ptr);
 158
 159 typedef int (*php_http_client_enqueue_cmp_func_t)(php_http_client_enqueue_t *cmp, void *arg);
 160 /* compare with request message pointer if compare_func is NULL */
 161 PHP_HTTP_API php_http_client_enqueue_t *php_http_client_enqueued(php_http_client_t *h, void *compare_arg, php_http_client_enqueue_cmp_func_t compare_func);
 162
 163 PHP_MINIT_FUNCTION(http_client);
 164 PHP_MSHUTDOWN_FUNCTION(http_client);
 165
 166 #endif
 167
 168 /*
 169  * Local variables:
 170  * tab-width: 4
 171  * c-basic-offset: 4
 172  * End:
 173  * vim600: noet sw=4 ts=4 fdm=marker
 174  * vim<600: noet sw=4 ts=4
 175  */