Http - stingray.Http ネームスペース リファレンス - Stingray Lua API リファレンス

stingray.Http ネームスペース リファレンス

説明

単純な HTTP クライアントを実装します。

この単純なクライアントでは SSL などの高度な機能はサポートされないことに注意してください。高度な機能が必要な場合は、プラグイン システムを使用してさらに高度な HTTP クライアント(Curl など)にリンクする必要があります。

Http オブジェクトはグローバル シングルトンであり、すべての関数はこのグローバル シングルトンに対して動作します。

列挙

HTTP 操作のステータスです。

関数

パラメータ

id :

integer

操作の ID。

戻り値
この関数は値を返しません。

close() を呼び出すと、その要求に関する情報を取得できなくなります。

パラメータ

id :

integer

操作の ID。

戻り値

string?

HTTP 操作のエラーです。

? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

ステータスが ERROR でない場合は、nil が返されます。

パラメータ

url :

string

GET するリソースの URL です。

timeout :

number?

要求が自動的に失敗するまでの秒単位でのタイムアウトです(既定値は 10s)。

? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
戻り値

integer

この要求を識別する ID です。

返された ID を使用して、操作の進行状況をモニタすることができます。指定されたタイムアウトが経過すると要求は自動的に閉じられますが、メモリを節約するために、作業が終了したら手動で要求を閉じてください。

パラメータ

url :

string

POST 先のエンドポイントの URL です。

content_type :

string

POST 要求のコンテンツ タイプ

body :

string

POST 要求の本文

timeout :

number?

要求が自動的に失敗するまでの秒単位でのタイムアウトです(既定値は 10s)。

? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
戻り値

integer

この要求を識別する ID です。

返された ID を使用して、操作の進行状況をモニタすることができます。指定されたタイムアウトが経過すると要求は自動的に閉じられますが、メモリを節約するために、作業が終了したら手動で要求を閉じてください。

パラメータ

id :

integer

操作の ID。

戻り値

table?

HTTP 操作の結果です。

? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

操作が FINISHED になっていない場合は、nil が返されます。

結果は、次のフィールドがあるテーブルとして返されます。

  • status_code: 整数としての HTTP ステータス コード
  • reason_phrase: ステータス コードに関連付けられている HTTP 理由フレーズです。
  • headers: HTTP ヘッダのキーと値があるテーブルです。
  • body: HTTP データの本文です。
パラメータ

id :

integer

操作の ID。

戻り値

stingray.Http.Status

HTTP 操作のステータスです。