Oracle Solaris Cluster リファレンスマニュアル

印刷ビューの終了

更新: 2015 年 9 月
 
 

scha_resourcetype_close(3HA)

名前

scha_resourcetype_open, scha_resourcetype_open_zone, scha_resourcetype_get, scha_resourcetype_get_zone, scha_resourcetype_close - リソースタイプ情報アクセス関数。

形式

cc [flags…] –I /usr/cluster/include file –L /usr/cluster/lib –l scha#include <scha.h>scha_err_t scha_resourcetype_open( const char *rtname, scha_resourcetype_t *handle);
scha_err_t scha_resourcetype_open_zone(const char *cluster, const char *rt_name, scha_resourcetype_t *handlep);
scha_err_t scha_resourcetype_close(scha_resourcetype_t handle);
scha_err_t scha_resourcetype_get(scha_resourcetype_t handle, const char *tag...);
scha_err_t scha_resourcetype_get_zone(const char *cluster, 
     scha_resourcetype_t handlep,const char *rt_tag, ...);

説明

scha_resourcetype_open()scha_resourcetype_get ()、およびscha_resourcetype_close() 関数を使用すると、Resource Group Manager (RGM) クラスタ機能が利用するリソースタイプの情報を入手できます。

scha_resourcetype_open() は、リソースタイプへのアクセスを初期化し、scha_resourcetype_get() が使用するアクセスハンドルを返します。

scha_resourcetype_open()rtname 引数は、アクセスされるリソースタイプを指定します。

handle 引数の値は、関数の戻り値を格納する変数のアドレスとなります。

scha_resourcetype_get() 関数は、tag 引数に指定されるリソースタイプの情報にアクセスします。tag 引数には、scha_tags.h ヘッダーファイルのマクロで定義される文字列値を指定してください。タグ以降の引数は、tag の値に依存します。

タグ以降に追加する引数は、情報を取り出すクラスタノードや、タグ固有の他の情報を指定する際に必要となることがあります。引数リストの最後の引数は、tag で指定される情報の格納に適した型にする必要があります。これは out 引数で、リソースタイプの情報を格納します。関数の実行に失敗した場合、出力引数に値は返されません。scha_resourcetype_get() で使用されたハンドルで scha_resourcetype_close() が呼び出されるまで、scha_resourcetype_get() で返される情報を保存するために割り当てられたメモリーは維持されます。

scha_resourcetype_close() には、事前に scha_resourcetype_open 関数を使って得た handle() 引数の値を指定します。この関数は、該当するハンドルを使用して得た scha_resourcegroup_get() の戻り値用割り当てメモリーを解放するとともに、このハンドルを無効化します。値を返す必要が生じると、get 呼び出しごとにメモリー割り当てが発生する点に注意してください。ある呼び出しで値を返すために割り当てられたメモリーが、以降の呼び出しによって上書きされたり、再利用されることはありません。

scha_tags.h に定義されるマクロには、scha_resourcetype_gettag() 引数に使用されるものがあります。ここでは出力引数および追加引数の型を説明します。構造体と enum 型は、scha_calls(3HA) で説明されています。

scha_resourcetype_open_zone() および scha_resourcetype_get_zone() 関数は、それぞれ scha_resourcetype_open() および scha_resourcetype_get() と同じ目的を果たしますが、リソースグループが存在する操作対象のゾーンクラスタの名前を指定する cluster 引数が追加されています。これらの関数は、大域ゾーンで実行されるコードを特定のゾーンクラスタで動作させる必要がある場合に便利です。ゾーンクラスタ内で、異なるゾーンクラスタにアクセスするために使用することはできません。

scha_resourcetype_open_zone() または scha_resourcetype_get_zone() への cluster 引数が NULL である場合、クエリーは、その呼び出しが実行されているクラスタ上で実行されます。つまり、NULL 引数での呼び出しは、それぞれ scha_resourcetype_open() または scha_resourcetype_get() と同等です。

scha_resourcetype_open_zone() から返されたハンドルを閉じるには、scha_resourcetype_close() を使用します。cluster 引数は不要です。

optag 引数

次のマクロによって、リソースタイプのプロパティーを指定します。出力は、リソースタイプの名前付きプロパティーの値です。


注 -  optag 引数 (SCHA_API_VERSIONSCHA_BOOT など) は大文字と小文字が区別されませんoptag 引数を指定するときには、大文字と小文字の任意の組み合わせを使用できます。
SCHA_API_VERSION

出力引数の型は int* です。

SCHA_BOOT

出力引数の型は char ** です。

SCHA_FAILOVER

出力引数の型は boolean_t * です。

SCHA_FINI

出力引数の型は char ** です。

SCHA_GLOBALZONE

出力引数の型は boolean_t * です。

SCHA_INIT

出力引数の型は char ** です。

SCHA_INIT_NODES

出力引数の型は scha_initnodes_flag_t * です。

SCHA_INSTALLED_NODES

出力引数の型は scha_str_array_t ** です。

SCHA_IS_LOGICAL_HOSTNAME

出力引数の型は boolean_t * です。

SCHA_IS_SHARED_ADDRESS

出力引数の型は boolean_t * です。

SCHA_MONITOR_CHECK

出力引数の型は char ** です。

SCHA_MONITOR_START

出力引数の型は char ** です。

SCHA_MONITOR_STOP

出力引数の型は char ** です。

SCHA_PER_NODE

出力引数の型は boolean_t * です。

SCHA_PKGLIST

出力引数の型は scha_str_array_t ** です。

SCHA_POSTNET_STOP

出力引数の型は char ** です。

SCHA_PRENET_START

出力引数の型は char ** です。

SCHA_PROXY

出力引数の型は boolean_t * です。

SCHA_RESOURCE_LIST

出力引数の型は scha_str_array_t ** です。

SCHA_RT_BASEDIR

出力引数の型は char ** です。

SCHA_RT_DESCRIPTION

出力引数の型は char ** です。

SCHA_RT_SYSTEM

出力引数の型は boolean_t * です。

SCHA_RT_VERSION

出力引数の型は char ** です。

SCHA_SINGLE_INSTANCE

出力引数の型は boolean_t * です。

SCHA_START

出力引数の型は char ** です。

SCHA_STOP

出力引数の型は char ** です。

SCHA_UPDATE

出力引数の型は char ** です。

SCHA_VALIDATE

出力引数の型は char ** です。

戻り値

これらの関数は、次の戻り値を返します。

0

関数の実行に成功。

0 以外

関数の実行に失敗。

エラー

SCHA_ERR_NOERR

関数の実行に成功。

その他のエラーコードについては、scha_calls(3HA) のマニュアルページを参照してください。

ファイル

/usr/cluster/include/scha.h

インクルードファイル

/usr/cluster/lib/libscha.so

ライブラリ

属性

次の属性については、attributes(5) を参照してください。

属性タイプ
属性値
使用条件
ha-cluster/developer/api
インタフェースの安定性
発展中

関連項目

scha_resource_get(1HA), scha_calls(3HA), scha_strerror(3HA), scha_strerror(3HA), attributes(5), rt_properties(5)