git.m6w6.name Git - m6w6/ext-http/blob - php_http_message.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-2011, Michael Wallner <mike@php.net>            |
  10     +--------------------------------------------------------------------+
  11 */
  12
  13 #ifndef PHP_HTTP_MESSAGE_H
  14 #define PHP_HTTP_MESSAGE_H
  15
  16 #include "php_http_message_body.h"
  17
  18 /* required minimum length of an HTTP message "HTTP/1.1" */
  19 #define PHP_HTTP_MESSAGE_MIN_SIZE 8
  20 #define PHP_HTTP_MESSAGE_TYPE(TYPE, msg) ((msg) && ((msg)->type == PHP_HTTP_ ##TYPE))
  21 #define PHP_HTTP_MESSAGE_TYPE_CHECK(type, msg, action) \
  22                 if (!PHP_HTTP_MESSAGE_TYPE(type, (msg))) { \
  23                         php_http_error(HE_NOTICE, PHP_HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type "#type); \
  24                         action; \
  25                 }
  26
  27 typedef php_http_info_type_t php_http_message_type_t;
  28 typedef struct php_http_message php_http_message_t;
  29
  30 struct php_http_message {
  31         PHP_HTTP_INFO_IMPL(http, type)
  32         HashTable hdrs;
  33         php_http_message_body_t body;
  34         php_http_message_t *parent;
  35         void *opaque;
  36 #ifdef ZTS
  37         void ***ts;
  38 #endif
  39 };
  40
  41 PHP_HTTP_API zend_bool php_http_message_info_callback(php_http_message_t **message, HashTable **headers, php_http_info_t *info TSRMLS_DC);
  42
  43 PHP_HTTP_API php_http_message_t *php_http_message_init(php_http_message_t *m, php_http_message_type_t t TSRMLS_DC);
  44 PHP_HTTP_API php_http_message_t *php_http_message_init_env(php_http_message_t *m, php_http_message_type_t t TSRMLS_DC);
  45 PHP_HTTP_API php_http_message_t *php_http_message_copy(php_http_message_t *from, php_http_message_t *to);
  46 PHP_HTTP_API php_http_message_t *php_http_message_copy_ex(php_http_message_t *from, php_http_message_t *to, zend_bool parents);
  47 PHP_HTTP_API void php_http_message_dtor(php_http_message_t *message);
  48 PHP_HTTP_API void php_http_message_free(php_http_message_t **message);
  49
  50 PHP_HTTP_API void php_http_message_set_type(php_http_message_t *m, php_http_message_type_t t);
  51 PHP_HTTP_API void php_http_message_set_info(php_http_message_t *message, php_http_info_t *info);
  52
  53 PHP_HTTP_API void php_http_message_update_headers(php_http_message_t *msg);
  54
  55 PHP_HTTP_API zval *php_http_message_header(php_http_message_t *msg, char *key_str, size_t key_len, int join);
  56 PHP_HTTP_API zend_bool php_http_message_is_multipart(php_http_message_t *msg, char **boundary);
  57
  58 PHP_HTTP_API void php_http_message_to_string(php_http_message_t *msg, char **string, size_t *length);
  59 PHP_HTTP_API void php_http_message_to_struct(php_http_message_t *msg, zval *strct);
  60 PHP_HTTP_API void php_http_message_to_callback(php_http_message_t *msg, php_http_pass_callback_t cb, void *cb_arg);
  61
  62 PHP_HTTP_API void php_http_message_serialize(php_http_message_t *message, char **string, size_t *length);
  63 PHP_HTTP_API php_http_message_t *php_http_message_reverse(php_http_message_t *msg);
  64 PHP_HTTP_API php_http_message_t *php_http_message_zip(php_http_message_t *one, php_http_message_t *two);
  65
  66 #define php_http_message_count(c, m) \
  67 { \
  68         php_http_message_t *__tmp_msg = (m); \
  69         for (c = 0; __tmp_msg; __tmp_msg = __tmp_msg->parent, ++(c)); \
  70 }
  71
  72 PHP_HTTP_API php_http_message_t *php_http_message_parse(php_http_message_t *msg, const char *str, size_t len, zend_bool greedy TSRMLS_DC);
  73
  74 /* PHP */
  75
  76 typedef struct php_http_message_object {
  77         zend_object zo;
  78         php_http_message_t *message;
  79         zend_object_value parent, body;
  80         zval *iterator;
  81 } php_http_message_object_t;
  82
  83 zend_class_entry *php_http_message_get_class_entry(void);
  84
  85 PHP_MINIT_FUNCTION(http_message);
  86 PHP_MSHUTDOWN_FUNCTION(http_message);
  87
  88 void php_http_message_object_prepend(zval *this_ptr, zval *prepend, zend_bool top /* = 1 */ TSRMLS_DC);
  89 void php_http_message_object_reverse(zval *this_ptr, zval *return_value TSRMLS_DC);
  90 STATUS php_http_message_object_set_body(php_http_message_object_t *obj, zval *zbody TSRMLS_DC);
  91
  92 zend_object_value php_http_message_object_new(zend_class_entry *ce TSRMLS_DC);
  93 zend_object_value php_http_message_object_new_ex(zend_class_entry *ce, php_http_message_t *msg, php_http_message_object_t **ptr TSRMLS_DC);
  94 zend_object_value php_http_message_object_clone(zval *object TSRMLS_DC);
  95 void php_http_message_object_free(void *object TSRMLS_DC);
  96
  97 PHP_METHOD(HttpMessage, __construct);
  98 PHP_METHOD(HttpMessage, getBody);
  99 PHP_METHOD(HttpMessage, setBody);
 100 PHP_METHOD(HttpMessage, addBody);
 101 PHP_METHOD(HttpMessage, getHeader);
 102 PHP_METHOD(HttpMessage, setHeader);
 103 PHP_METHOD(HttpMessage, addHeader);
 104 PHP_METHOD(HttpMessage, getHeaders);
 105 PHP_METHOD(HttpMessage, setHeaders);
 106 PHP_METHOD(HttpMessage, addHeaders);
 107 PHP_METHOD(HttpMessage, getType);
 108 PHP_METHOD(HttpMessage, setType);
 109 PHP_METHOD(HttpMessage, getInfo);
 110 PHP_METHOD(HttpMessage, setInfo);
 111 PHP_METHOD(HttpMessage, getResponseCode);
 112 PHP_METHOD(HttpMessage, setResponseCode);
 113 PHP_METHOD(HttpMessage, getResponseStatus);
 114 PHP_METHOD(HttpMessage, setResponseStatus);
 115 PHP_METHOD(HttpMessage, getRequestMethod);
 116 PHP_METHOD(HttpMessage, setRequestMethod);
 117 PHP_METHOD(HttpMessage, getRequestUrl);
 118 PHP_METHOD(HttpMessage, setRequestUrl);
 119 PHP_METHOD(HttpMessage, getHttpVersion);
 120 PHP_METHOD(HttpMessage, setHttpVersion);
 121 PHP_METHOD(HttpMessage, guessContentType);
 122 PHP_METHOD(HttpMessage, getParentMessage);
 123 PHP_METHOD(HttpMessage, send);
 124 PHP_METHOD(HttpMessage, toString);
 125 PHP_METHOD(HttpMessage, toStream);
 126 PHP_METHOD(HttpMessage, toCallback);
 127
 128 PHP_METHOD(HttpMessage, count);
 129 PHP_METHOD(HttpMessage, serialize);
 130 PHP_METHOD(HttpMessage, unserialize);
 131 PHP_METHOD(HttpMessage, rewind);
 132 PHP_METHOD(HttpMessage, valid);
 133 PHP_METHOD(HttpMessage, current);
 134 PHP_METHOD(HttpMessage, key);
 135 PHP_METHOD(HttpMessage, next);
 136
 137 PHP_METHOD(HttpMessage, factory);
 138
 139 PHP_METHOD(HttpMessage, detach);
 140 PHP_METHOD(HttpMessage, prepend);
 141 PHP_METHOD(HttpMessage, reverse);
 142
 143 PHP_METHOD(HttpMessage, isMultipart);
 144 PHP_METHOD(HttpMessage, splitMultipartBody);
 145 #endif
 146
 147 /*
 148  * Local variables:
 149  * tab-width: 4
 150  * c-basic-offset: 4
 151  * End:
 152  * vim600: noet sw=4 ts=4 fdm=marker
 153  * vim<600: noet sw=4 ts=4
 154  */
 155