開発者用 SIP 透過性および正規化ガイド

Book Title

Chapter Title

トレース API

PDF - Complete Book (2.42 MB) PDF - This Chapter (436.0 KB)
View with Adobe Reader on a variety of devices

トレース API

スクリプトのトレーシングにより、スクリプト作成者がスクリプト内からトレースを生成することが可能になります。これは、スクリプトのデバッグだけに使用してください。スクリプトを稼動させ始めるときには、無効にする必要があります。スクリプトのトレーシングを有効にする方法は 2 通りあります。

設定を使用する：SIP トランクに関連した [Script Trace] チェックボックスを参照してください。

スクリプトを使用する： trace.enable() API を参照してください。

次の表に、上述の 2 つの設定のすべての組み合わせにおいて、トレースがスクリプトによって生成されるかどうかを示します。

設定	スクリプト	トレースの生成
有効	有効	あり
有効	無効	なし
無効	有効	なし
無効	無効	なし

トレースライブラリには、次の API があります。

trace.format

trace.format(format-string, p1, p2, ...)

この関数は、フォーマット文字列と一連のパラメータを受け取って、スクリプトに関連付けられているトランクのトレーシングが有効になっており、スクリプトが trace.enable() によってトレーシングを有効にしていた場合に、パラメータをフォーマット文字列に挿入し、その出力を SDI トレースファイルに書き出します。

例

M = {}

trace.enable()

function M.inbound_INVITE(msg)

local callid = msg:getHeader("Call-Id")

trace.format("Call-Id header is %s", callid)

end

return M

trace.enable

trace.enable()

この関数は、スクリプトがトレーシングをローカルに有効にすることを可能にします。

（注）トレーシングは、そのスクリプトを使用する SIP トランクの設定でも有効になっている必要があります。

例

前述の例、「trace.format」を参照してください。

trace.disable

trace.disable()

この関数は、スクリプトがトレーシングをローカルに無効にすることを可能にします。

（注）関連付けられているトランクのスクリプトトレース設定フラグがオンになっている場合は、たとえここで無効にしても、Trace.output によってスクリプトトレースが生成されます。

M = {}

trace.disable()

function M.inbound_INVITE(msg)

local callid = msg:getHeader("Call-Id")

trace.format("Call-Id header is %s", callid)

end

return M

trace.enabled

trace.enabled() turns a boolean

スクリプトのこのインスタンスに関連付けられているデバイス上でスクリプトトレーシングが有効になっているか、またはスクリプト自身でトレーシングを有効にしていた場合に、true が返されます。トレーシングが有効になっていない場合は、false が返されます。

例

M = {}

trace.enable()

function M.inbound_INVITE(msg)

if trace.enabled()

then

local callid = msg:getHeader("Call-Id")

trace.format("Call-Id header is %s", callid)

end

return M

Book Title

Chapter Title

検索結果

章のタイトル：トレース API