Linkexpress 利用者プログラム開発ガイド
目次 索引 前ページ次ページ

第4章 利用者プログラムインタフェース> 4.1 転送API> 4.1.4 転送APIのパラメタパケット一覧> 4.1.4.2 dts_rcvfile_dcb_t

4.1.4.2.1 dts_rcvfile_dcb_tのメンバ一覧

req_ident(転送識別番号) unsigned long型

利用者が任意の値を設定します。本値は、データ転送の完了通知で通知され、データ転送要求との照合をとる際に使用します。また、突き放し型(GETINFから転送結果受信)で連続要求する場合は、必ずサービスごとに異なる値を設定する必要があります。

値を省略した場合(0を指定した場合)は、Linkexpressが転送要求に対して付与した番号を、output_dcbで指定した結果通知格納パラメタパケット内のreq_identに通知します。この番号でデータ転送要求との照合をとることができます。

転送識別番号の設定方法は、応用プログラム単位で、どちらか一方を選択する必要があります。一つの利用者プログラム内で、転送識別番号の設定方法を混在させることはできません。詳細は転送識別番号の設定方法を参照してください。

req_ident(転送識別番号) unsigned型

利用者が任意の値を設定します。本値は、データ転送の完了通知で通知され、データ転送要求との照合をとる際に使用します。また、突き放し型(GETINFから転送結果受信)で連続要求する場合は、必ずサービスごとに異なる値を設定する必要があります。

値を省略した場合(0を指定した場合)は、Linkexpressが転送要求に対して付与した番号を、output_dcbで指定した結果通知格納パラメタパケット内のreq_identに通知します。この番号でデータ転送要求との照合をとることができます。

転送識別番号の設定方法は、応用プログラム単位で、どちらか一方を選択する必要があります。一つの利用者プログラム内で、転送識別番号の設定方法を混在させることはできません。詳細は転送識別番号の設定方法を参照してください。

req_type(依頼の型) unsigned型

依頼の型を以下の定数で指定します。依頼の型を省略(NULL)した場合は、DTS_API_COMPが採用されます。

DTS_API_THROW : 突き放し型を示します

DTS_API_COMP : 完了復帰型を示します(省略値)

INITJOB,ENDJOBおよびRSPJOBでは、DTS_API_COMPを指定してください。

appl_name(利用者プログラム名) *unsigned char型

ネットワーク定義で指定した応用プログラム名を8文字以内の英数字で指定します。利用者プログラム名は、省略できません。

なお、"@_LE"および"@_DB"で始まる応用プログラム名は、Linkexpress予約語のため使用しないでください。

system_name(相手システム名) *unsigned char型

ネットワーク定義で指定した相手システム名を31文字以内の英数字で指定します。相手システム名は、省略できません。

ネットワーク定義簡易化機能を使用する場合は"ADDR=相手IPアドレス"の形式で指定してください。なおIPアドレスはIPv4形式で指定してください。

assoc_cont(コネクション継続) unsigned型

ファイル転送サービスが完了したとき、相手システムとの間のコネクションを継続するかどうかを以下の形式で指定します。値を省略した場合(NULLを指定した場合)は、DTS_API_CUTが採用されます。

DTS_API_CUT : 切断(省略値)

DTS_API_CONT : 継続

DTS_API_CONTを指定した場合に、同一コネクションを継続して転送するには、以下の条件を満たす必要があります。

DTS_API_CONTを指定してコネクション継続を行う場合の注意事項を以下に示します。

local_filename(自側ファイル名) *unsigned char型

自システムのファイル名を255文字以内の絶対パスで指定します。

なお、ネットワークドライブ上のファイルは指定できません。

UNIXサーバの場合、相対パスで指定すると自側利用者情報で指定した利用者のホームディレクトリが基準となります。

remote_filename(仮想ファイル名) *unsigned char型

相手システムのファイル名を255文字以内で指定します。仮想ファイル名は省略できません。詳細は「運用ガイド」の「1.2.3 仮想ファイル名の指定方法」を参照してください。相手システムがグローバルサーバ/PRIMEFORCEの場合は、「運用ガイド」の「1.2.4 相手システムがグローバルサーバ/PRIMEFORCEの場合の仮想ファイル名指定方法」を参照してください。

storage_form(自側格納形態) unsigned型

自側ファイルに転送データを格納する際の置換モードを以下の形式で指定します。値が省略(NULL)された場合は、DTS_API_REPが採用されます。また、DTS_API_ADDを指定した場合、途中再送はできません。なお、通信プロトコルがTCP/IP(HTTP系)の場合、省略してください。TCP/IP(HTTP系)では指定値にかかわらずDTS_API_REPが採用されます。

DTS_API_REP : ファイル置換え(省略値)

DTS_API_ADD : ファイル追加書き

access_password(相手アクセスパスワード) *password_t型

仮想ファイルへのアクセスパスワードを8文字以内で指定します。省略する場合は、NULLを指定します。

TCP/IPおよびSANの場合 : 指定しても意味を持ちません。

FNAの場合 : 4文字以内で指定します。

data_type(データタイプ) unsigned型

転送ファイルのデータタイプを以下の形式で指定します。値を省略(NULL)した場合は、DTS_API_BINARYが採用されます。なお、通信プロトコルがTCP/IP(HTTP系)の場合、省略してください。TCP/IP(HTTP系)では指定値にかかわらずDTS_API_BINARYが採用されます。

DTS_API_TEXT : テキスト

DTS_API_BINARY : バイナリ

file_attr(仮想ファイル属性) *file_attr_t型

仮想ファイル属性領域を指定します。ただし、通信プロトコルがTCP/IP(FTP)、TCP/IP(FTPM)、TCP/IP(HTTP系)、SANの場合は、指定しても意味がありません。値を省略(NULL)した場合は、相手システムから送信されるファイル属性データとの属性チェックは行いません。

protocol_option(プロトコルオプション) *protocol_option_t型

TCP/IP(FTP+)およびFNA(HICS)の場合に、プロトコル固有情報テーブルを指定します。省略するときは、NULLを指定します。

user_id(相手側利用者名) *unsigned char型

相手システムの利用者名を20文字以内(Linkexpress V4.0L10相当以前の場合は8文字以内)で指定します。省略するときは、NULLを指定します。FNA(HICS)の場合、8文字以内で指定します。

また、相手システムがLinkexpressサーバでLinkexpress V4.0L10相当以前の場合またはグローバルサーバ/PRIMEFORCEの場合は、8文字以内で指定してください。

本オペランドで指定したセキュリティ情報については、「導入ガイド」の「第9章 セキュリティの設定(Linkexpress サーバ)」を参照し、目的に合ったセキュリティ情報を指定してください。

password(相手側パスワード) *password_t型

相手システムの利用者パスワードを31文字以内(Linkexpress V4.0L10相当以前の場合は8文字以内)で指定します。省略するときは、NULLを指定します。FNA(HICS)の場合、8文字以内で指定します。

また、相手システムがLinkexpressサーバでLinkexpress V4.0L10相当以前の場合またはグローバルサーバ/PRIMEFORCEの場合は、8文字以内で指定してください。

本オペランドで指定したセキュリティ情報については、「導入ガイド」の「第9章 セキュリティの設定(Linkexpress サーバ)」を参照し、目的に合ったセキュリティ情報を指定してください。

group(相手側グループ名) *unsigned char型

相手システムがグローバルサーバ/PRIMEFORCEの場合に、利用者グループ名を8文字以内で指定します。相手システムがグローバルサーバ/PRIMEFORCE以外の場合、または省略するときは、NULLを指定します。

相手システムがUNIXサーバの場合には指定しないでください。

なお、通信プロトコルがTCP/IP(FTP+)およびSANかつ、相手システムがPCサーバの場合は、グループ名(ドメイン名)として扱います。

local_user(自側利用者情報) *local_user_t型

自側利用者情報を指定します。この情報は、自側ファイルアクセス時の認証に使います。値を省略(NULL)した場合の利用者認証は以下のとおりです。

PCサーバ:利用者認証を行いません。

UNIXサーバ:自側利用者名:lnkexp、自側パスワード:lnkexp0の資格で利用者認証を行います。

ret_tid(結果通知スレッド) unsigned型

PCサーバの場合、転送結果を受信するスレッドIDを指定します(ただし、突き放し型の場合だけ有効です)。

値を省略(NULL)した場合は、要求発行スレッドに対して結果が通知されます。なお、スレッドIDに0を指定すると、任意のスレッドで受信可能となります。

ret_tid(結果通知領域) *ret_id_t型

UNIXサーバの場合、結果通知プロセス情報パラメタパケットのアドレスを指定します(ただし、突き放し型の場合だけ有効です)。値を省略(NULL)した場合は、要求発行スレッドに対して結果が通知されます。

ckrtn(途中再送の有無) unsigned型

途中再送機能の利用の有無を指定します。値を省略(NULL)した場合は、ネットワーク定義の指定値が採用されます。なお、途中再送機能を利用する場合、応答側システムがネットワーク定義で途中再送機能利用ありを指定している必要があります。

DTS_API_INFO : 途中再送機能を利用する

DTS_API_NOINFO : 途中再送機能を利用しない

本指定はTCP/IP(FTP+)の場合のみ有効です。

lbsession_id(セション識別子)unsigned 型

ロードバランサを使用した環境において、複数ファイル転送で1サービスを実現する利用者プログラムを使用する場合に指定してください。本パラメタを指定することにより複数ファイル転送を同じ相手に対して行えるように保証します。本パラメタには、getinf()または各転送APIで通知されたセション識別子を指定してください。

サービスにおける初回転送の場合は、本パラメタの値にNULL指定(省略)、およびlbsession_contパラメタにDTS_API_LBSESSION_CONTを指定してください。

本指定はTCP/IP(HTTP系)の場合のみ有効です。その他の場合は指定しても意味を持ちません。

また、ネットワーク定義comdef定義命令lbsession_modeにnoを指定している場合、指定しても意味をもちません。

lbsession_cont(セション継続の有無)unsigned型

ロードバランサを使用した環境において、相手システムとの間のセションを維持するかどうかを以下の形式で指定します。値を省略した場合(NULLを指定した場合)は、DTS_API_LBSESSION_CUTが採用されます。

本指定はTCP/IP(HTTP系)の場合のみ有効です。その他の場合は指定しても意味を持ちません。

また、ネットワーク定義comdef定義命令lbsession_modeにnoを指定している場合は指定値にかかわらずDTS_API_LBSESSION_CUTで動作します。

DTS_API_LBSESSION_CUT: セション非継続(省略値)

DTS_API_LBSESSION_CONT : セション継続

exp_option(拡張機能の利用有無) *extend_option_t型

autorecovery機能を利用する場合、拡張機能情報パラメタパケットのアドレスを指定します。値を省略(NULL)した場合は、ネットワーク定義のautorecoveryおよびautorecoverymsgオペランド指定値が採用されます。


目次 索引 前ページ次ページ

All Rights Reserved, Copyright(C) 富士通株式会社 1997-2007