1 /*********************************************************************************
\r
3 * --------------------------------------------------------------------------------
\r
5 * This file is part of MiMic
\r
6 * Copyright (C)2011 Ryo Iizuka
\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
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
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
21 * For further information please contact.
\r
23 * <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
\r
25 *********************************************************************************/
\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
33 * このクラスは、Httpヘッダのパーサを定義します。
\r
35 typedef struct NyLPC_TcHttpBasicHeaderParser NyLPC_TcHttpBasicHeaderParser_t;
\r
41 typedef NyLPC_TUInt8 NyLPC_THttpMethodType;
\r
42 #define NyLPC_THttpMethodType_GET ((NyLPC_THttpMethodType)0x01)
\r
43 #define NyLPC_THttpMethodType_POST ((NyLPC_THttpMethodType)0x02)
\r
44 #define NyLPC_THttpMethodType_HEAD ((NyLPC_THttpMethodType)0x03)
\r
49 typedef NyLPC_TUInt8 NyLPC_THttpVersion;
\r
50 #define NyLPC_THttpVersion_09 ((NyLPC_THttpVersion)0x01)
\r
51 #define NyLPC_THttpVersion_10 ((NyLPC_THttpVersion)0x02)
\r
52 #define NyLPC_THttpVersion_11 ((NyLPC_THttpVersion)0x03)
\r
53 #define NyLPC_THttpVersion_UNKNOWN ((NyLPC_THttpVersion)0x04)
\r
56 typedef NyLPC_TUInt8 NyLPC_THttpHeaderType;
\r
57 #define NyLPC_THttpHeaderType_REQUEST ((NyLPC_THttpHeaderType)0x01)
\r
58 #define NyLPC_THttpHeaderType_RESPONSE ((NyLPC_THttpHeaderType)0x02)
\r
61 typedef NyLPC_TUInt8 NyLPC_THttpMessgeHeader_Connection;
\r
62 #define NyLPC_THttpMessgeHeader_Connection_NONE ((NyLPC_THttpMessgeHeader_Connection)0x01)
\r
63 #define NyLPC_THttpMessgeHeader_Connection_CLOSE ((NyLPC_THttpMessgeHeader_Connection)0x02)
\r
64 #define NyLPC_THttpMessgeHeader_Connection_KEEPALIVE ((NyLPC_THttpMessgeHeader_Connection)0x03)
\r
65 #define NyLPC_THttpMessgeHeader_Connection_UNKNOWN ((NyLPC_THttpMessgeHeader_Connection)0x10)
\r
67 typedef NyLPC_TUInt8 NyLPC_THttpMessgeHeader_TransferEncoding;
\r
68 #define NyLPC_THttpMessgeHeader_TransferEncoding_NONE ((NyLPC_THttpMessgeHeader_TransferEncoding)0x01) //TEはない
\r
69 #define NyLPC_THttpMessgeHeader_TransferEncoding_CHUNKED ((NyLPC_THttpMessgeHeader_TransferEncoding)0x02)
\r
70 #define NyLPC_THttpMessgeHeader_TransferEncoding_UNKNOWN ((NyLPC_THttpMessgeHeader_TransferEncoding)0x10)
\r
72 #define NyLPC_THttpContentLength_INVALID_LENGTH 0xFFFFFFFF
\r
79 * この構造体は、NyLPC_cHttpBasicHeaderParserの結果を格納します。
\r
81 struct NyLPC_THttpBasicHeader
\r
83 NyLPC_THttpHeaderType type;
\r
86 NyLPC_THttpVersion version;
\r
87 NyLPC_THttpMethodType method;
\r
90 NyLPC_THttpVersion version;
\r
91 NyLPC_TUInt32 status;
\r
94 NyLPC_THttpMessgeHeader_TransferEncoding transfer_encoding;
\r
95 NyLPC_TUInt32 content_length;
\r
96 NyLPC_THttpMessgeHeader_Connection connection;
\r
100 * このヘッダが持続性接続を求めているか判定します。
\r
102 NyLPC_TBool NyLPC_THttpBasicHeader_isPersistent(const struct NyLPC_THttpBasicHeader* i_struct);
\r
111 * ショートパラメータ解析バッファのサイズ
\r
113 #define NyLPC_cHttpBasicHeaderParser_SIZE_OF_WBS 32
\r
117 #define NyLPC_TcHttpBasicHeaderParser_ST_isError(i_v) ((i_v)==NyLPC_TcHttpBasicHeaderParser_ST_ERROR)
\r
120 * 独自のメッセージフィールドを受け取るイベントハンドラです。
\r
121 * メッセージハンドラはNyLPC_cHttpBasicHeaderParserから3種類のメッセージを受け取ります。
\r
122 * ハンドラは、NyLPC_TcHttpBasicHeaderParserが処理しないメッセージヘッダをパース中に、次の順番で呼び出されます。
\r
124 * <li>開始メッセージ - i_nameに有効な文字列を指定して、そのフィールド値が入力される事を伝えます。i_cはnullです。
\r
125 * <li>フィールドメッセージ - i_nameにNULL,i_cに\0以外の文字を指定して、フィールド値が入力されている事を指示します。
\r
126 * <li>フィールドエンド - i_nameにNULL,i_cに0を指定して、フィールドが完了した事を指示します。
\r
129 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
131 * リクエストのURL文字列を受け取るイベントハンドラです。
\r
132 * メッセージハンドラはNyLPC_cHttpBasicHeaderParserから3種類のメッセージを受け取ります。
\r
133 * ハンドラは、NyLPC_TcHttpBasicHeaderParserが処理しないメッセージヘッダをパース中に、次の順番で呼び出されます。
\r
135 * <li>URLメッセージ - i_cに\0以外の文字を指定して、URL値が入力されている事を指示します。
\r
136 * <li>URLエンド - i_cに0を指定して、URLが完了した事を指示します。
\r
140 メッセージハンドラはNyLPC_cHttpBasicHeaderParserから3種類のメッセージを受け取ります。
\r
141 1.URLメッセージ - i_cに\0以外の文字を指定して、URL値が入力されている事を指示します。
\r
142 2.URLエンド - i_cに0を指定して、URLが完了した事を指示します。
\r
144 typedef NyLPC_TBool (*NyLPC_cHttpBasicHeaderParser_urlHandler) (NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TChar i_c,struct NyLPC_THttpBasicHeader* o_out);
\r
148 struct NyLPC_TcHttpBasicHeaderParser_Handler
\r
150 NyLPC_cHttpBasicHeaderParser_messageHandler messageHandler;
\r
151 NyLPC_cHttpBasicHeaderParser_urlHandler urlHandler;
\r
159 struct NyLPC_TcHttpBasicHeaderParser
\r
161 /**継承クラスで実装すべきインタフェイス*/
\r
162 const struct NyLPC_TcHttpBasicHeaderParser_Handler* _handler;
\r
163 NyLPC_TUInt16 _rcode;//_stがERRORの時にエラーコードを格納する。
\r
165 NyLPC_TcStr_t _wsb;
\r
167 char _wsb_buf[NyLPC_cHttpBasicHeaderParser_SIZE_OF_WBS];
\r
171 void NyLPC_cHttpBasicHeaderParser_initialize(NyLPC_TcHttpBasicHeaderParser_t* i_inst);
\r
172 #define NyLPC_cHttpBasicHeaderParser_finalize(i_inst)
\r
174 NyLPC_TBool NyLPC_cHttpBasicHeaderParser_parse(NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TcHttpStream_t* i_stream,struct NyLPC_THttpBasicHeader* o_out);
\r
177 * 候補のエラーのステータスコードを返す。
\r
179 #define NyLPC_cHttpBasicHeaderParser_getStatusCode(inst) ((inst)->_rcode)
\r