カートリッジ・サービス — メモリー・サービス

表20-2は、この項で説明しているメモリー・サービス関数を示しています。

表20-2 メモリー・サービス関数

関数	用途
「OCIDurationBegin()」	ユーザー期間を開始します。
「OCIDurationEnd()」	ユーザー期間を終了します。
「OCIMemoryAlloc()」	指定の継続時間から指定サイズのメモリーを割り当てます。
「OCIMemoryFree()」	メモリー・チャンクを解放します。
「OCIMemoryResize()」	メモリー・チャンクをサイズ変更します。

関連項目: これらの関数の使用方法の詳細は、『Oracle Database データ・カートリッジ開発者ガイド』を参照してください。

OCIDurationBegin()

用途

ユーザー期間を開始します。

構文

sword OCIDurationBegin ( OCIEnv              *env,
                         OCIError            *err,
                         const OCISvcCtx     *svc, 
                         OCIDuration         parent,
                         OCIDuration         *duration );

パラメータ

env (IN/OUT)

OCI環境ハンドルです。これは、カートリッジ・サービスに対してNULLとして渡されます。

err (IN/OUT)

OCIエラー・ハンドルです。エラーがある場合は、errに記録され、OCI_ERRORが戻されます。OCIErrorGet()のコールによって診断情報を取得できます。

svc (IN)

OCIサービス・コンテキスト・ハンドルです。

parent (IN)

親の継続時間の時間番号です。次のいずれかです。

• 以前に作成されたユーザー期間

• OCI_DURATION_STATEMENT

• OCI_DURATION_SESSION

duration (OUT)

新しく作成されたユーザー期間固有の識別子です。

コメント

この関数によってユーザー期間が開始されます。ユーザーは複数のアクティブなユーザー期間を同時に利用できます。ユーザー期間をネストする必要はありません。durationパラメータは、このコールによって作成された期間を識別するための一意の番号を戻すために使用します。

環境パラメータとサービス・コンテキスト・パラメータの両方をNULLにすることはできません。

関連関数

OCIDurationEnd()

OCIDurationEnd()

用途

ユーザー期間を終了します。

構文

sword OCIDurationEnd ( OCIEnv             *env, 
                       OCIError           *err, 
                       const OCISvcCtx    *svc,
                       OCIDuration        duration );

パラメータ

env (IN/OUT)

OCI環境ハンドルです。

err (IN/OUT)

OCIエラー・ハンドルです。エラーがある場合は、errに記録され、OCI_ERRORが戻されます。OCIErrorGet()のコールによって診断情報を取得できます。

svc (IN)

OCIサービス・コンテキストです(カートリッジ・サービスの場合はNULLとして渡しますが、それ以外の場合は非NULLとして渡します)。

duration (IN)

OCIDurationBegin()によって以前作成されたユーザー期間です。

コメント

この関数によってユーザー期間が終了します。

環境パラメータとサービス・コンテキスト・パラメータの両方をNULLにすることはできません。

関連関数

OCIDurationBegin()

OCIMemoryAlloc()

用途

指定の継続時間から指定サイズのメモリーを割り当てます。

構文

sword OCIMemoryAlloc( void         *hndl, 
                      OCIError     *err, 
                      void         **mem, 
                      OCIDuration  dur, 
                      ub4          size, 
                      ub4          flags );

パラメータ

hndl (IN)

durがOCI_DURATION_PROCESSの場合、OCI環境ハンドル(OCIEnv *)で、それ以外の場合はユーザー・セッション・ハンドル(OCISession *)です。

err (IN)

エラー・ハンドルです。

mem (OUT)

割り当てられたメモリーです。

dur (IN)

以前に作成されたユーザー期間または次の値のいずれかです。

OCI_DURATION_CALLOUT

OCI_DURATION_STATEMENT

OCI_DURATION_SESSION

OCI_DURATION_PROCESS

size (IN)

割り当てられるメモリーのサイズです。

flags (IN)

OCI_MEMORY_CLEAREDビットを設定して、消去されたメモリーを取得します。

コメント

エージェントのコールアウトの継続時間(外部プロシージャ継続時間)にメモリーを割り当てるには、OCIExtProcAllocCallMemory()またはdurをOCI_DURATION_CALLOUTとして指定するOCIMemoryAlloc()を使用します。

戻り値

エラー・コードを戻します。

OCIMemoryFree()

用途

メモリー・チャンクを解放します。

構文

sword OCIMemoryFree ( void     *hndl, 
                      OCIError *err, 
                      void     *mem );

パラメータ

hndl (IN)

OCI環境ハンドルまたはユーザー・セッション・ハンドルです。

err (IN)

エラー・ハンドルです。

mem (IN/OUT)

OCIMemoryAlloc()を使用して以前割り当てたメモリーへのポインタです。

戻り値

エラー・コードを戻します。

OCIMemoryResize()

用途

メモリー・チャンクを新規サイズに変更します。

構文

sword OCIMemoryResize( void         *hndl, 
                       OCIError     *err, 
                       void         **mem, 
                       ub4          newsize, 
                       ub4          flags );

パラメータ

hndl (IN)

OCI環境ハンドルまたはユーザー・セッション・ハンドルです。

err (IN)

エラー・ハンドルです。

mem (IN/OUT)

OCIMemoryAlloc()を使用して以前割り当てたメモリーへのポインタです。

newsize (IN)

要求されたメモリーのサイズです。

flags (IN)

OCI_MEMORY_CLEAREDビットを設定して、消去されたメモリーを取得します。

コメント

メモリーを割り当ててからこの関数をコールしてサイズ変更する必要があります。

戻り値

エラー・コードを戻します。