NHTTP_CreateConnection

構文


#include <nitroWiFi/nhttp.h>

NHTTPConnectionHandle NHTTP_CreateConnection(const char* url,
                                            NHTTP_ReqMethod method,
                                            char* bodyBuffer, u32 bodyLength,
                                            NHTTPConnectionCallback callback,
                                            void* userParam);

引数

url 接続先URL(NULL終端ASCII文字列)へのポインタ
method NHTTP_ReqMethod列挙型で指定する以下のいずれかのHTTPリクエストメソッド
NHTTP_REQMETHOD_GET HTTP GETメソッド
NHTTP_REQMETHOD_POST HTTP POSTメソッド
NHTTP_REQMETHOD_HEAD HTTP HEADメソッド
bodyBuffer 受信したHTTPボディを格納するバッファへのポインタ
このバッファにはNULLを指定することも可能で、NHTTP_EVENT_BODY_RECV_FULLイベントコールバック内から argを上書きすることによって再設定することもできます。
bodyLength bodyBufferの長さ
callback HTTP通信中に発生する各種イベントを通知するNHTTPConnectionCallback型のコールバック
通知が不要であればNULLを指定することも可能です。通知されるイベントの詳細については NHTTPConnectionCallbackの説明をご参照ください。
userParam この接続ハンドルに関連付けることのできる任意のユーザ定義パラメータ
設定した値はNHTTP_GetUserParam()で取得することができます。

返り値

成功すれば新規に生成された接続ハンドルを返し、
メモリ確保に失敗した場合、
NHTTP_ReqMethod列挙型以外のメソッドを設定した場合、
接続先URLがhttp://あるいはhttps://で始まらない場合、
URLで指定したポート番号が65535を超える場合はNULLを返します。

説明

指定されたパラメータに基づいてHTTP通信用の接続ハンドルを新規に1個生成します。
この関数によって得られた接続ハンドルを使用して各種の設定用関数を呼び出した後、 NHTTP_StartConnection()の呼び出しによって通信を開始します。

生成した接続ハンドルは、必ずNHTTP_DeleteConnection()を呼び出して解放する必要があります。

参照

NHTTPConnectionCallback, NHTTP_DeleteConnection, NHTTP_StartConnection, NHTTP_GetUserParam,

履歴

2007/06/07 返り値の説明を追加。
2006/10/14 初版