XDR(3)

名称
xdr - 外部データ表現のライブラリルーチン

書式および解説

これらのルーチンによって、C プログラマは任意のデータ構造をマシン独立 に記述することができます。リモートプロシージャコール用の データは、これらのルーチンを使って送信されます。

xdr_array(xdrs, arrp, sizep, maxsize, elsize, elproc)
XDR *xdrs;
char **arrp;
u_int *sizep, maxsize, elsize;
xdrproc_t elproc;

    可変長配列とそれに対応する外部表現とを相互に変換する フィルタプリミティブです。パラメータ arrp は配列へのポインタのアドレス、 sizep は配列の要素カウントのアドレスであり、この要素カウントは maxsize を超えることはできません。パラメータ elsize は各配列要素の sizeof の値であり、 elproc は配列要素の C 形式と外部表現とを相互に変換する XDR フィルタです。このルーチンは、成功すれば 1 を、失敗すれば 0 を返します。

xdr_bool(xdrs, bp)
XDR *xdrs;
bool_t *bp;

    ブール値 (C 言語整数) とその外部表現とを相互に変換する フィルタプリミティブです。データをコード化するときは、このフィルタは 1 または 0 の値を作り出します。このルーチンは、成功すれば 1 を、失敗すれば 0 を返します。

xdr_bytes(xdrs, sp, sizep, maxsize)
XDR *xdrs;
char **sp;
u_int *sizep, maxsize;

    カウントしたバイトストリングとその外部表現とを相互に変換する フィルタプリミティブです。パラメータ sp はストリングポインタのアドレス です。ストリングの長さはアドレス sizep に置かれ、ストリングの長さは maxsize よりも長くなることはできません。このルーチンは、成功すれば 1 を、 失敗すれば 0 を返します。

xdr_char(xdrs, cp)
XDR *xdrs;
char *cp;

    C 言語のキャラクタとその外部表現とを相互に変換するフィルタプリミティブ です。このルーチンは、成功すれば 1 を、失敗すれば 0 を返します。 注：コード化されたキャラクタは圧縮されず、それぞれは 4 バイトを 占有します。キャラクタの配列については、 xdr_bytes(), xdr_opaque(), xdr_string() を使うことを考える価値があります。

void
xdr_destroy(xdrs)
XDR *xdrs;

    XDR ストリーム xdrs に結合された破壊ルーチンを呼び出すマクロです。破壊とは、通常は そのストリームに結合されたプライベートデータ構造を解放することを 意味します。 xdr_destroy() を呼び出した後で xdrs を使うことは、未定義です。

xdr_double(xdrs, dp)
XDR *xdrs;
double *dp;

    C 言語の倍精度数 ( double ) とその外部表現とを相互に変換する フィルタプリミティブです。このルーチンは、成功すれば 1 を、 失敗すれば 0 を返します。

xdr_enum(xdrs, ep)
XDR *xdrs;
enum_t *ep;

    C 言語の enum (実際は整数) とその外部表現とを相互に変換する フィルタプリミティブです。このルーチンは、成功すれば 1 を、 失敗すれば 0 を返します。

xdr_float(xdrs, fp)
XDR *xdrs;
float *fp;

    C 言語の float とその外部表現とを相互に変換する フィルタプリミティブです。このルーチンは、成功すれば 1 を、 失敗すれば 0 を返します。

void
xdr_free(proc, objp)
xdrproc_t proc;
char *objp;

    ジェネリックな解放ルーチンです。最初の引数は、解放するオブジェクトの XDR ルーチンです。2 番目の引数は、そのオブジェクト自体への ポインタです。注：このルーチンに渡されるポインタは解放されませんが、それが 指すものは解放 (反復的に) されます。

u_int
xdr_getpos(xdrs)
XDR *xdrs;

    XDR ストリーム xdrs に結合された位置検索ルーチンを呼び出すマクロです。このルーチンは、 XDR バイトストリームの位置を示す符号なしの整数を返します。 XDR ストリームのよいところは、 XDR ストリームインスタンスがそれを保証しているとは限らない場合であっても、 この数字に対して簡単な算術計算が使えることです。

long *
xdr_inline(xdrs, len)
XDR *xdrs;
int len;

    XDR ストリーム xdrs に結合されたインラインルーチンを呼び出すマクロです。このルーチンは、 ストリームのバッファの連続した部分へのポインタを返します。 len は、希望するバッファのバイト長です。注：ポインタは long * にキャストされます。

    警告: xdr_inline() は、連続するバッファの部分を割り当てられない場合は、 NULL (0) を返すことがあります。従って、ストリームインスタンスによって 挙動が異なる場合があります。このルーチンは、効率を上げるために 用意されています。

xdr_int(xdrs, ip)
XDR *xdrs;
int *ip;

    C 言語の整数とその外部表現とを相互に変換するフィルタプリミティブ です。このルーチンは、成功すれば 1 を、失敗すれば 0 を返します。

xdr_long(xdrs, lp)
XDR *xdrs;
long *lp;

    C 言語 の長整数 ( long ) とその外部表現とを相互に変換するフィルタプリミティブです。 このルーチンは、成功すれば 1 を、失敗すれば 0 を返します。

void
xdrmem_create(xdrs, addr, size, op)
XDR *xdrs;
char *addr;
u_int size;
enum xdr_op op;

    このルーチンは、 xdrs によって指される XDR ストリームオブジェクトを初期化します。ストリームのデータは、長さが size バイトを超えない addr の位置にあるメモリに書込まれるか、またはそこから読み出されます。 op は、 XDR ストリームの方向 ( XDR_ENCODE, XDR_DECODE, XDR_FREE のいずれか) を決定します。

xdr_opaque(xdrs, cp, cnt)
XDR *xdrs;
char *cp;
u_int cnt;

    固定サイズの不透明 (opaque) データとその外部表現とを相互に変換する フィルタプリミティブです。パラメータ cp は不透明データのアドレスであり、 cnt はそのサイズをバイトで表したものです。このルーチンは、 成功すれば 1 を、失敗すれば 0 を返します。

xdr_pointer(xdrs, objpp, objsize, xdrobj)
XDR *xdrs;
char **objpp;
u_int objsize;
xdrproc_t xdrobj;

    xdr_reference() と同じ働きをします。但し、このルーチンが NULL ポインタをシリアル化するのに対して、 xdr_reference() はシリアル化しません。 従って、 xdr_pointer() はバイナリツリーやリンクリストのような反復的データ構造を 表すことができます。

void
xdrrec_create(xdrs, sendsize, recvsize, handle, readit, writeit)
XDR *xdrs;
u_int sendsize, recvsize;
char *handle;
int (*readit) (), (*writeit) ();

    このルーチンは、 xdrs によって指される XDR ストリームオブジェクトを初期化します。ストリームのデータはサイズ sendsize のバッファに書込まれ、値 0 はシステムが適切なデフォルトを使う 必要があることを示します。ストリームのデータは、サイズ recvsize のバッファから読み込まれ、このルーチンも値 0 を渡すことによって 適切なデフォルトを設定することができます。ストリームの出力バッファが 一杯のときは、 writeit が呼ばれます。同様に、ストリームの入力バッファが空のときは、 readit が呼ばれます。これらの 2 つのルーチンの挙動は、システムコール read, write と似ています。但し、 read には最初のパラメータとして handle が渡されることが異なります。注: XDR ストリームの op フィールドは、呼び出し元が設定しなければなりません。

    警告: この XDR ストリームは、中間レコードストリームを実装しています。 従って、ストリームにはレコードの境界情報を与える追加バイトが入っています。

xdrrec_endofrecord(xdrs, sendnow)
XDR *xdrs;
int sendnow;

    このルーチンは、 xdrrec_create() によって作成されたストリームについてのみ呼び出すことができます。 出力バッファにあるデータは完全なレコードとしてマークされ、 出力バッファは sendnow が 0 でない場合はオプションで書き出されます。 このルーチンは、成功すれば 1 を、失敗すれば 0 を返します。

xdrrec_eof(xdrs)
XDR *xdrs;
int empty;

    このルーチンは、 xdrrec_create() によって作成されたストリームについてのみ呼び出すことができます。 ストリーム中の現在のレコードの残りの部分を処理した後に、 このルーチンはストリームにそれ以上の入力がない場合は 1 を返し、 ある場合は 0 を返します。

xdrrec_skiprecord(xdrs)
XDR *xdrs;

    このルーチンは、 xdrrec_create() によって作成されたストリームについてのみ呼び出すことができます。 これは、 XDR のインプリメンテーションに対して、 ストリームの入力バッファにある現在のレコードの残りの部分を 廃棄するように指示します。 このルーチンは、成功すれば 1 を、失敗すれば 0 を返します。

xdr_reference(xdrs, pp, size, proc)
XDR *xdrs;
char **pp;
u_int size;
xdrproc_t proc;

    構造体の中を追いかけるポインタを与えるプリミティブです。 パラメータ pp はポインタのアドレス、 size は *pp が指す構造体のサイズ、 proc は構造体をその C 言語形式と外部表現との間でフィルタする XDR プロシージャです。 このルーチンは、成功すれば 1 を、失敗すれば 0 を返します。

    警告: このルーチンは NULL ポインタを理解しません。代りに xdr_pointer() を使ってください。

xdr_setpos(xdrs, pos)
XDR *xdrs;
u_int pos;

    XDR ストリーム xdrs に結合された位置設定ルーチンを呼び出すマクロです。 パラメータ pos は、 xdr_getpos() から取得した位置を示す値です。このルーチンは、 XDR ストリームの位置を再設定できる場合は 1 を、そうでない 場合は 0 を返します。

    警告: XDR ストリームの種類によっては、再設定は困難です。 従って、このルーチンはある種類のストリームには成功し、別の種類のストリーム には失敗する場合があります。

xdr_short(xdrs, sp)
XDR *xdrs;
short *sp;

    C 言語の短整数 ( short ) とその外部表現とを相互に変換するフィルタプリミティブです。 このルーチンは、成功すれば 1 を、失敗すれば 0 を返します。

void
xdrstdio_create(xdrs, file, op)
XDR *xdrs;
FILE *file;
enum xdr_op op;

    このルーチンは、 xdrs によって指される XDR ストリームオブジェクトを初期化します。 XDR ストリームデータは、標準 I/O ストリーム file に書込まれるか、またはそこから読み出されれます。パラメータ op は、 XDR ストリームの方向 ( XDR_ENCODE, XDR_DECODE, XDR_FREE か) を決定します。

    警告: このような XDR ストリームに結合された破壊ルーチンは、 file ストリームについて fflush() は呼び出しますが、 fclose() は決して呼び出しません。

xdr_string(xdrs, sp, maxsize)
XDR
*xdrs;
char **sp;
u_int maxsize;

    C 言語の文字列とそれに対応する外部表現とを相互に変換する フィルタプリミティブです。文字列の長さは maxsize を超えることはできません。注: sp は、ストリングのポインタのアドレスです。 このルーチンは、成功すれば 1 を、失敗すれば 0 を返します。

xdr_u_char(xdrs, ucp)
XDR *xdrs;
unsigned char *ucp;

    符号なしの C 言語のキャラクタとその外部表現とを相互に変換する フィルタプリミティブです。このルーチンは、成功すれば 1 を、 失敗すれば 0 を返します。

xdr_u_int(xdrs, up)
XDR *xdrs;
unsigned *up;

    C 言語の符号なし整数 ( unsigned ) とその外部表現とを相互に変換するフィルタプリミティブです。 このルーチンは成功すれば 1 を、失敗すれば 0 を返します。

xdr_u_long(xdrs, ulp)
XDR *xdrs;
unsigned long *ulp;

    C 言語の符号なし長整数 ( unsigned long ) とその外部表現とを相互に変換するフィルタプリミティブです。 このルーチンは、成功すれば 1 を、失敗すれば 0 を返します。

xdr_u_short(xdrs, usp)
XDR *xdrs;
unsigned short *usp;

    C 言語の符号なし短整数 ( unsigned short ) とその外部表現とを相互に変換するフィルタプリミティブです。 このルーチンは、成功すれば 1 を、失敗すれば 0 を返します。

xdr_union(xdrs, dscmp, unp, choices, dfault)
XDR *xdrs;
int *dscmp;
char *unp;
struct xdr_discrim *choices;
bool_t (*defaultarm) ();  /* may equal NULL */

    ディスクリミナントで識別された C 言語の共用体 ( union ) とそれに対応する外部表現とを相互に変換する フィルタプリミティブです。まず最初に dscmp に位置するその共用体のディスクリミナントを翻訳します。 このディスクリミナントは、常に enum_t です。次に、 unp に位置する共用体が翻訳されます。パラメータ choices は、 xdr_discrim() 構造体の配列へのポインタです。各構造には、順序付きペアの [value,proc] が入っています。共用体のディスクリミナントが結合された value に等しい場合は、 proc が呼び出されてその共用体を翻訳します。 xdr_discrim() 構造体配列の最後は、値 NULL のルーチンによって印がつけられます。 配列 choices にディスクリミナントが見つからない場合は、 defaultarm プロシージャが呼び出されます (このプロシージャが NULL でないならば)。それに成功すれば 1 を、失敗すれば 0 を返します。

xdr_vector(xdrs, arrp, size, elsize, elproc)
XDR *xdrs;
char *arrp;
u_int size, elsize;
xdrproc_t elproc;

    固定長配列とそれに対応する外部表現とを相互に変換する フィルタプリミティブです。パラメータ arrp は、その配列へのポインタのアドレス、 size は配列の要素数です。パラメータ elsize は配列の各要素のサイズ、 elproc は配列要素の C 言語形式とその外部表現とを相互に翻訳する XDR フィルタです。このルーチンは、成功すれば 1 を、失敗すれば 0 を返します。

xdr_void()

    このルーチンは常に 1 を返します。これは、関数パラメータを 必要とするが何もしない RPC ルーチンに渡すことができます。

xdr_wrapstring(xdrs, sp)
XDR *xdrs;
char **sp;

    xdr_string(xdrs, sp, MAXUN.UNSIGNED ); を呼び出すプリミティブで、 MAXUN.UNSIGNED は符号なし整数の最大値です。 RPC パッケージが最大で 2 つの XDR ルーチンをパラメータとして渡しますが、 最も頻繁に使用されるプリミティブであるにもかかわらず xdr_string() は 3 つのルーチンを必要とするため、 xdr_wrapstring() は大変便利です。成功すれば 1 を、失敗すれば 0 を返します。

参照
rpc(3)

次のマニュアルを参照してください。
    eXternal Data Representation Standard: Protocol Specification
    eXternal Data Representation: Sun Technical Notes
    XDR: External Data Representation Standard, RFC1014, Sun Microsystems, Inc., USC-ISI