lib/src/http/NyLPC_cHttpBasicHeaderParser.h

   1 /*********************************************************************************\r
   2  * PROJECT: MiMic\r
   3  * --------------------------------------------------------------------------------\r
   4  *\r
   5  * This file is part of MiMic\r
   6  * Copyright (C)2011 Ryo Iizuka\r
   7  *\r
   8  * MiMic is free software: you can redistribute it and/or modify\r
   9  * it under the terms of the GNU Lesser General Public License as published\r
  10  * by　the Free Software Foundation, either version 3 of the　License, or\r
  11  * (at your option) any later version.\r
  12  *\r
  13  * This program is distributed in the hope that it will be useful,\r
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  16  * GNU General Public License for more details.\r
  17  *\r
  18  * You should have received a copy of the GNU Lesser General Public License\r
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.\r
  20  *\r
  21  * For further information please contact.\r
  22  *      http://nyatla.jp/\r
  23  *      <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>\r
  24  *\r
  25  *********************************************************************************/\r
  26 \r
  27 #ifndef NyLPC_TcHttpBasicHeader_H\r
  28 #define NyLPC_TcHttpBasicHeader_H\r
  29 #include "NyLPC_stdlib.h"\r
  30 #include "NyLPC_cHttpStream.h"\r
  31 \r
  32 #ifdef __cplusplus\r
  33 extern "C" {\r
  34 #endif /* __cplusplus */\r
  35 /**\r
  36  * このクラスは、Httpヘッダのパーサを定義します。\r
  37  */\r
  38 typedef struct NyLPC_TcHttpBasicHeaderParser NyLPC_TcHttpBasicHeaderParser_t;\r
  39 \r
  40 \r
  41 /**\r
  42  * HTTPメソッドの定義値。\r
  43  */\r
  44 typedef NyLPC_TUInt8 NyLPC_THttpMethodType;\r
  45 #define NyLPC_THttpMethodType_GET                       ((NyLPC_THttpMethodType)0x01)\r
  46 #define NyLPC_THttpMethodType_POST                      ((NyLPC_THttpMethodType)0x02)\r
  47 #define NyLPC_THttpMethodType_HEAD                      ((NyLPC_THttpMethodType)0x03)\r
  48 \r
  49 /**\r
  50  * HTTPバージョンの定義値\r
  51  */\r
  52 typedef NyLPC_TUInt8 NyLPC_THttpVersion;\r
  53 #define NyLPC_THttpVersion_09           ((NyLPC_THttpVersion)0x01)\r
  54 #define NyLPC_THttpVersion_10           ((NyLPC_THttpVersion)0x02)\r
  55 #define NyLPC_THttpVersion_11           ((NyLPC_THttpVersion)0x03)\r
  56 #define NyLPC_THttpVersion_UNKNOWN      ((NyLPC_THttpVersion)0x04)\r
  57 \r
  58 \r
  59 typedef NyLPC_TUInt8 NyLPC_THttpHeaderType;\r
  60 #define NyLPC_THttpHeaderType_REQUEST  ((NyLPC_THttpHeaderType)0x01)\r
  61 #define NyLPC_THttpHeaderType_RESPONSE ((NyLPC_THttpHeaderType)0x02)\r
  62 \r
  63 \r
  64 typedef NyLPC_TUInt8 NyLPC_THttpMessgeHeader_Connection;\r
  65 #define NyLPC_THttpMessgeHeader_Connection_NONE  ((NyLPC_THttpMessgeHeader_Connection)0x01)\r
  66 #define NyLPC_THttpMessgeHeader_Connection_CLOSE ((NyLPC_THttpMessgeHeader_Connection)0x02)\r
  67 #define NyLPC_THttpMessgeHeader_Connection_KEEPALIVE ((NyLPC_THttpMessgeHeader_Connection)0x03)\r
  68 #define NyLPC_THttpMessgeHeader_Connection_UNKNOWN ((NyLPC_THttpMessgeHeader_Connection)0x10)\r
  69 \r
  70 typedef NyLPC_TUInt8 NyLPC_THttpMessgeHeader_TransferEncoding;\r
  71 #define NyLPC_THttpMessgeHeader_TransferEncoding_NONE    ((NyLPC_THttpMessgeHeader_TransferEncoding)0x01)       //TEはない\r
  72 #define NyLPC_THttpMessgeHeader_TransferEncoding_CHUNKED ((NyLPC_THttpMessgeHeader_TransferEncoding)0x02)\r
  73 #define NyLPC_THttpMessgeHeader_TransferEncoding_UNKNOWN ((NyLPC_THttpMessgeHeader_TransferEncoding)0x10)\r
  74 \r
  75 #define NyLPC_THttpContentLength_INVALID_LENGTH 0xFFFFFFFF\r
  76 \r
  77 \r
  78 \r
  79 \r
  80 \r
  81 /**\r
  82  * この構造体は、NyLPC_cHttpBasicHeaderParserの結果を格納します。\r
  83  */\r
  84 struct NyLPC_THttpBasicHeader\r
  85 {\r
  86         NyLPC_THttpHeaderType type;\r
  87         union{\r
  88                 struct{\r
  89                         NyLPC_THttpVersion version;\r
  90                         NyLPC_THttpMethodType method;\r
  91                 }req;\r
  92                 struct{\r
  93                         NyLPC_THttpVersion version;\r
  94                         NyLPC_TUInt32 status;\r
  95                 }res;\r
  96         }startline;\r
  97         NyLPC_THttpMessgeHeader_TransferEncoding transfer_encoding;\r
  98         NyLPC_TUInt32 content_length;\r
  99         NyLPC_THttpMessgeHeader_Connection connection;\r
 100 };\r
 101 \r
 102 /**\r
 103  * このヘッダが持続性接続を求めているか判定します。\r
 104  */\r
 105 NyLPC_TBool NyLPC_THttpBasicHeader_isPersistent(const struct NyLPC_THttpBasicHeader* i_struct);\r
 106 \r
 107 \r
 108 \r
 109 \r
 110 \r
 111 \r
 112 /**\r
 113  * コンフィギュレーション値。\r
 114  * ショートパラメータ解析バッファのサイズ\r
 115  */\r
 116 #define NyLPC_cHttpBasicHeaderParser_SIZE_OF_WBS 32\r
 117 \r
 118 \r
 119 \r
 120 #define NyLPC_TcHttpBasicHeaderParser_ST_isError(i_v) ((i_v)==NyLPC_TcHttpBasicHeaderParser_ST_ERROR)\r
 121 \r
 122 /**\r
 123  * 独自のメッセージフィールドを受け取るイベントハンドラです。\r
 124  * メッセージハンドラはNyLPC_cHttpBasicHeaderParserから３種類のメッセージを受け取ります。\r
 125  * ハンドラは、NyLPC_TcHttpBasicHeaderParserが処理しないメッセージヘッダをパース中に、次の順番で呼び出されます。\r
 126  * <ol>\r
 127  * <li>開始メッセージ - i_nameに有効な文字列を指定して、そのフィールド値が入力される事を伝えます。i_cはnullです。\r
 128  * <li>フィールドメッセージ - i_nameにNULL,i_cに\0以外の文字を指定して、フィールド値が入力されている事を指示します。\r
 129  * <li>フィールドエンド - i_nameにNULL,i_cに0を指定して、フィールドが完了した事を指示します。\r
 130  * </ol>\r
 131 */\r
 132 typedef NyLPC_TBool (*NyLPC_cHttpBasicHeaderParser_messageHandler) (NyLPC_TcHttpBasicHeaderParser_t* i_inst,const NyLPC_TChar* i_name,NyLPC_TChar i_c,struct NyLPC_THttpBasicHeader* o_out);\r
 133 /**\r
 134  * リクエストのURL文字列を受け取るイベントハンドラです。\r
 135  * メッセージハンドラはNyLPC_cHttpBasicHeaderParserから３種類のメッセージを受け取ります。\r
 136  * ハンドラは、NyLPC_TcHttpBasicHeaderParserが処理しないメッセージヘッダをパース中に、次の順番で呼び出されます。\r
 137  * <ol>\r
 138  * <li>URLメッセージ - i_cに\0以外の文字を指定して、URL値が入力されている事を指示します。\r
 139  * <li>URLエンド - i_cに0を指定して、URLが完了した事を指示します。\r
 140  * </ol>\r
 141 */\r
 142 /**\r
 143 メッセージハンドラはNyLPC_cHttpBasicHeaderParserから３種類のメッセージを受け取ります。\r
 144         1.URLメッセージ - i_cに\0以外の文字を指定して、URL値が入力されている事を指示します。\r
 145         2.URLエンド - i_cに0を指定して、URLが完了した事を指示します。\r
 146 */\r
 147 typedef NyLPC_TBool (*NyLPC_cHttpBasicHeaderParser_urlHandler) (NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TChar i_c,struct NyLPC_THttpBasicHeader* o_out);\r
 148 \r
 149 \r
 150 \r
 151 struct NyLPC_TcHttpBasicHeaderParser_Handler\r
 152 {\r
 153         NyLPC_cHttpBasicHeaderParser_messageHandler messageHandler;\r
 154         NyLPC_cHttpBasicHeaderParser_urlHandler urlHandler;\r
 155 };\r
 156 \r
 157 \r
 158 \r
 159 /**\r
 160 クラス構造体\r
 161 */\r
 162 struct NyLPC_TcHttpBasicHeaderParser\r
 163 {\r
 164         /**継承クラスで実装すべきインタフェイス*/\r
 165         const struct NyLPC_TcHttpBasicHeaderParser_Handler* _handler;\r
 166         NyLPC_TUInt16 _rcode;//_stがERRORの時にエラーコードを格納する。\r
 167         /**ワーク文字列*/\r
 168         NyLPC_TcStr_t _wsb;\r
 169         /**ワーク文字列のバッファ*/\r
 170         char _wsb_buf[NyLPC_cHttpBasicHeaderParser_SIZE_OF_WBS];\r
 171 };\r
 172 \r
 173 \r
 174 void NyLPC_cHttpBasicHeaderParser_initialize(NyLPC_TcHttpBasicHeaderParser_t* i_inst);\r
 175 #define NyLPC_cHttpBasicHeaderParser_finalize(i_inst)\r
 176 \r
 177 NyLPC_TBool NyLPC_cHttpBasicHeaderParser_parse(NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TcHttpStream_t* i_stream,struct NyLPC_THttpBasicHeader* o_out);\r
 178 /**\r
 179  * parse関数がエラーの場合に、\r
 180  * 候補のエラーのステータスコードを返す。\r
 181  */\r
 182 #define NyLPC_cHttpBasicHeaderParser_getStatusCode(inst) ((inst)->_rcode)\r
 183 \r
 184 #ifdef __cplusplus\r
 185 }\r
 186 #endif /* __cplusplus */\r
 187 \r
 188 #endif\r