afterburner

afterburnerとは？

afterburner は HTTPサーバーへのリクエスト時に関係する情報をキューイングし、
レスポンス後に時間のかかる処理を行うためのLuaスクリプティング環境です。 ISAPI Filterとして提供されます。

以下のようなことが可能です。

• Lua言語によるカスタマイズ。
• Lua言語からサーバー変数にアクセス。
• Lua言語からUUIDを生成。
• Lua言語からファイルシステムにアクセス。
• Lua言語から標準デバッガに出力。
• スクリプトエンジン数のチューニング。
• など。。。

動作環境

IIS 5.1, 6.0, 7.0, 7.5 and later

パッケージ内容

bin/afterburner.dll

ISAPI Filter 本体

bin/afterburner.setting

設定ファイル

bin/sample.lua

サンプルスクリプト

注意事項

1. 本ソフトウェアの利用は良識の範囲内でお願い致します。
2. 本ソフトウェアの利用による損害の保証はお受けできません。
3. 本ソフトウェアの利用は楽しんで行っていただきますようお願い致します。

インストール方法

1. "afterburner.setting" を目的の設定に編集。
2. "afterburner.dll" を目的のWebサイトのISAPIフィルタに設定。

設定リファレンス

<setting/>

afterburner設定のルート要素。

子要素

• <queue/> キューの設定。
• <script/> スクリプトエンジンの設定。

<queue/>

キューに関する設定。

属性

process_interval

キューを処理する間隔（ミリ秒）。デフォルト値/下限値:0。

<script/>

スクリプトエンジンに関する設定。

属性

pool_size

起動時に生成するLuaスクリプトエンジンの数。デフォルト値:5。下限値:1。

path

使用するLuaスクリプトファイルの絶対パス。必須。

スクリプト APIリファレンス

※スクリプトの具体的な記述方法は、同梱のsample.luaを参照してください。

エントリポイント関数

on_init()

フィルタのロード時に行いたい処理を記述します。

戻り値:

true 以外のとき、フィルタのロードを中止します。

on_term()

フィルタのアンロード時に行いたい処理を記述します。

戻り値:

true 以外のとき、アンロードの失敗をサーバーに通知します。

on_enqueue( pec )

サーバーへのリクエスト時、レスポンス送信後、アクセスログの書込みと通信切断の直前に呼ばれます。

パラメータ pec:

リクエストの情報が入った enqueue_context のハンドル。

戻り値:

2値を戻します。最初の戻り値がtrue のとき、二番目に指定した任意のテーブルをキューに入れます。

on_dequeue( data, seq_num )

キューからデータが取り出されると呼ばれます。

パラメータ data:

キューから取り出したデータを保持しているテーブル。

パラメータ seq_num:

キュー内での連番(重複の可能性あり)。

戻り値:

[なし]

ユーティリティ関数

uuid()

ユニークな文字列(UUID)を返します。

戻り値:

UUID文字列。

ndebug( msg )

cdb や ntsd などの標準デバッガに出力します。

パラメータ msg:

出力する文字列。

戻り値:

[なし]

enqueue_context.new( pec )

enqueue_context のハンドルからインスタンスを生成します。

パラメータ pec:

enqueue_context のハンドル。

戻り値:

enqueue_context のインスタンス。

[enqueue_context]:server_variable( key )

HTTPサーバー変数を取得します。

パラメータ key:

変数名。

戻り値:

変数値。

[enqueue_context]:http_status()

このリクエストで返されたHTTPステータスを取得します。

[enqueue_context]:win32_status()

このリクエストのwin32ステータスを取得します。

[enqueue_context]:bytes_send()

このリクエストで送信されたバイト数を取得します。

[enqueue_context]:bytes_recvd()

このリクエストで受信したバイト数を取得します。

[enqueue_context]:process_time()

このリクエストの処理時間を取得します。

更新履歴

2011/08/29

• Version: 1.0.0.0

2011/08/31

• Version: 1.0.0.1
• process_interval のデフォルト値/下限値を100から0に変更

2012/02/10

• Version: 1.1.0.0
• キューに入れるデータを独自の連想配列からLua標準のテーブルに変更。
• 関数名の変更。debug -> ndebug
• LuaFileSystemの関数が利用可能に。
• スタックリーク対応。

2014/06/10

• Version: 1.1.1.0
• Lua 5.1.5

クレジット

Lua (http://www.lua.org)

Copyright © 1994–2011 Lua.org, PUC-Rio.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Expat (http://expat.sourceforge.net)

Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center Ltd and Clark Cooper
Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006 Expat maintainers.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LuaFileSystem (http://keplerproject.github.com/luafilesystem/)

Copyright © 1994–2011 Lua.org, PUC-Rio.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.