ドキュメンテーション

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

matlab.net.http.io.FileConsumer クラス

パッケージ: matlab.net.http.io
スーパークラス: matlab.net.http.io.ContentConsumer

HTTP メッセージに含まれるファイルのコンシューマー

説明

FileConsumer クラスは、ファイルを Web サービスからダウンロードしたり、Web から受信したデータをファイルに保存するのに便利な方法です。ファイルの名前を指定するか、あるいはサーバーによって送信された情報または URI で名づけられたファイルから MATLAB® によって名前を決定することもできます。

matlab.net.http.io.FileConsumer クラスは handle クラスです。

作成

説明

consumer = FileConsumer(filename,permission,machineformat,encoding) は、サーバーからの応答のペイロードでファイルを作成または上書きする FileConsumer を構築します。パラメーターは関数 fopen のパラメーターと同じ意味を持ち、すべてオプションです。

consumer = FileConsumer(FID)FileIdentifier プロパティを FID に設定し、ファイルに書き込みます。FID は書き込み用に開いたファイルの識別子でなければなりません。MATLAB では、現在の位置指定子の場所にあるファイルに書き込みが行われます。そのため、たとえば 'a+' 権限を使用して既存のファイルを開く場合は、MATLAB によってそのファイルに付加されます。転送が完了すると、MATLAB によってファイルの末尾に位置指定子が残され、ファイルは閉じられません。

入力引数

すべて展開する

絶対パスおよびオプションの拡張子を含むファイルまたはフォルダーの名前。文字ベクトルまたは string スカラーとして指定します。MATLAB によって作成されたファイルの名前を判断するには、Filename プロパティを参照してください。

filename によって既存のフォルダー内のファイルが指定された場合、MATLAB によって次のことが行われます。

  • fopen(filename,permission,...) を使用してファイルを開く。

  • permission が指定されていない場合、fopen(filename,'w+') を使用してファイルを開く。

  • filename に拡張子が含まれない場合、受信メッセージの Content-Type や Content-Disposition ヘッダー フィールド、または要求の URI に含まれるファイル名の拡張子 (存在する場合) に基づいて、MATLAB によって拡張子が追加される。

filename が既存の書き込み可能フォルダーを指定する場合、応答内の Content-Disposition ヘッダー フィールドまたは URI から派生した名前を使用して、MATLAB によってファイルがフォルダー内に作成されます。名前に拡張子が含まれていない場合は、Content-Type に基づいて拡張子が追加される可能性があります。

filename がない場合や空の場合、MATLAB によって現在のフォルダー内にファイルが作成されます。これは、filename = '.' と等価です。現在のフォルダーとは、このコンシューマーが send 要求で使用された時点ではなく、この FileConsumer が作成された時点でのフォルダーです。

例: 'myTextFile.txt'

データ型: char | string

ファイル アクセス タイプ。string として指定します。permission が指定されている場合、書き込みアクセスを許可しなければなりません。既定値は 'w+' であり、読み取りおよび書き込みのためにファイルを開くか作成し、既存のコンテンツを破棄します (存在する場合)。

permission は関数 fopen によって許可される任意の値にすることができます。次の permission の追加の値がサポートされます。

'u+''u'

'w' および 'w+' と同じです。ただし、ファイルが存在する場合は、filename 引数から派生した一意の名前を持つファイルが作成されます。新しいファイルの名前は、拡張子を除く名前部分にハイフンとシーケンス番号が付加されます。

たとえば、filename'MyFile.txt' であるが、そのファイルが存在する場合、MATLAB によってファイル MyFile-1.txt が作成されます。Filename プロパティには、新しいファイルの絶対パス名が含まれます。

'T'

権限に付加されると、テキスト モード 't' と同じように動作します。ただし、テキスト モードを使用するのは、データの Content-Type が文字ベースであることを示す場合のみです。これには、charset パラメーターを指定する任意の型、または MATLAB によって文字ベースであると認識されている型 ("application/json" など) が含まれます。

'w' および 'w+' 権限の場合 (または permission が指定されていない場合)、すべてのケースにおいて、ファイル名が filename と厳密に一致する場合を除いて、MATLAB によって既存のファイルが上書きされることはありません。

例: 'a''w+T'

データ型: char | string

バイトまたはビットの読み取りまたは書き込みの順序。関数 fopen によって許可される任意の値として指定します。

データ型: char | string

文字エンコード。関数 fopen によって許可される任意の値として指定します。

データ型: char | string

プロパティ

すべて展開する

パブリック プロパティ

書き込まれているファイルの識別子 (FID)。double として指定します。コンシューマーが FID 引数を使って構築された場合、このプロパティは識別子です。データはこの識別子に関連付けられた現在のファイルの位置指定子に書き込まれるため、サブクラスでは、この識別子を使用しているときに誤って位置を変更しないように注意する必要があります。転送の最後にファイルは開いたままになり、位置はファイルの末尾に留まります。

コンストラクターが filename 引数を使用して、または引数なしで呼び出された場合、このプロパティはそのファイルに対する読み取り専用のファイル識別子になります。これにより、書き込みに使用されている位置指定子をそのままにして、転送中にサブクラスがファイルを読み取ることができます。転送の最後に、この識別子は閉じられます。

属性:

GetAccess
public
SetAccess
private

書き込まれているファイルの絶対パス名。string として指定します。コンシューマーが FID 引数を使って構築された場合、このプロパティはファイルの名前です。そうでない場合は、応答メッセージの受信中に MATLAB によるファイルへの書き込みが開始されるまで、この値は設定されない可能性があります。これは、すべてのヘッダーが受信されるまでファイル名を決定できるとは限らないためです。このプロパティを使用して、書き込まれたファイルを判断します。FilenameResponse.Body.Data プロパティにも格納されます。

属性:

GetAccess
public
SetAccess
private

推奨されるバッファー サイズ。uint64 として指定されます。AllocationLength は、MATLAB により、putData に渡されるデータの予測されるバッファー サイズに設定されます。実際のサイズは、これよりも小さくなることも大きくなることもあります。パフォーマンスを向上させるために、この値を使用して、コンシューマーでデータを処理するためのスペースを事前に割り当てることができます。

このプロパティは、サブクラスで利用できるように、start メソッドを呼び出す前に MATLAB で設定されます。

属性:

GetAccess
public
SetAccess
public

想定されるペイロードの長さ。uint64 として指定されます。このプロパティは通常、Header プロパティにおける matlab.net.http.field.ContentLengthFieldValue プロパティになります。

ContentLength が空の場合、長さは不明です。ペイロードは putData(uint8.empty) が呼び出された時点で終了します。

このプロパティは、サブクラスでデータの長さを確認できるように、initialize を呼び出す前に MATLAB で設定されます。

この ContentConsumer が最上位のコンシューマーのデリゲートである場合、ContentLength の値が最上位のコンシューマーの ContentLength と異なる値になることがあります。

例: numel(someData)。ここで、someDatauint8 型です。

属性:

GetAccess
public
SetAccess
public

ペイロードのメディア タイプ。matlab.net.http.MediaType オブジェクトとして指定します。このプロパティは通常、Header プロパティにおける matlab.net.http.field.ContentTypeFieldValue プロパティになります。ContentType プロパティが空の場合、ContentTypeField は空または存在しません。

このプロパティは、サブクラスで MediaType を確認できるように、initialize を呼び出す前に MATLAB で設定されます。データから別の MediaType であることがわかった場合は、サブクラスでこのプロパティを設定できます。

この値は、転送の終了時に MATLAB によって Response.Body.ContentType プロパティにコピーされます。

例: 'application/octet-stream'

属性:

GetAccess
public
SetAccess
public

現在処理中のペイロードのヘッダー。matlab.net.http.HeaderField オブジェクトとして指定されます。

コンシューマーは、このヘッダーを使用して、送られてくるペイロードの処理方法を決定します。最上位のコンシューマーの場合、この値は Response.Header と同じになります。デリゲートの場合は値が異なることがあります。たとえば、MultipartConsumer で処理されるマルチパート メッセージの場合は、そのデリゲートで処理中のパートのヘッダーになります。デリゲートは引き続き Response.Header で元のメッセージのヘッダーを確認できます。

このプロパティは、サブクラスで利用できるように、initialize を呼び出す前に MATLAB で設定されます。

属性:

GetAccess
public
SetAccess
public

送信が完了した RequestMessagematlab.net.http.RequestMessage オブジェクトとして指定されます。これは、すべてのリダイレクトが完了した最終的な RequestMessage であり、send メソッドからの completedrequest 戻り値です。

このプロパティは、サブクラスで利用できるように、initialize を呼び出す前に MATLAB で設定されます。

属性:

GetAccess
public
SetAccess
public

処理中の ResponseMessagematlab.net.http.ResponseMessage オブジェクトとして指定されます。

Response プロパティは、initialize を呼び出す前に MATLAB で設定されます。この値は、ヘッダーの受信まで完了し、ペイロードを受信する前の ResponseMessage になります。応答メッセージの処理の開始時 (マルチパート メッセージの場合はパートの開始時) に、ResponseMesssage.Body プロパティは、Data プロパティと Payload プロパティが空の MessageBody オブジェクトになります。受信したデータを格納するために、コンシューマーはデータ転送中に Response プロパティと MessageBody.Data プロパティを変更できます。通常、コンシューマーはデータセット Response.Body.Data を処理してから処理済みのペイロードに格納しますが、これは必須ではありません。転送が完了すると、この Response が MATLAB から send の呼び出し元に返されます。ResponseHeaderStatusLine などの他のプロパティは、コンシューマーで変更しないでください。これらを変更した場合、その変更が send の呼び出し元に返されます。

Response.Body.Payload プロパティは転送中は空であり、コンシューマーで変更してはなりません。HTTPOptions.SavePayload プロパティが設定されると、次に MATLAB は、メッセージまたはパートの転送終了時 (putData(uint8.empty) の呼び出し後)、または例外の発生時に、受信したペイロードに Payload を設定します。

メッセージの処理中にコンシューマーで例外が発生した場合は、MATLAB から HTTPException オブジェクトがスローされます。History プロパティにはこの Response 値が含まれます。

コンシューマーがマルチパート メッセージのパートを処理するデリゲートの場合、Response.Header にメッセージ全体のヘッダーが格納され、各パートの ContentConsumer を呼び出す前に Response.BodyPayload プロパティと Data プロパティがクリアされます。各パートの最後で、元の応答の Body.Data にある ResponseMessage オブジェクトの配列の末尾に、このオブジェクトの Header およびこのプロパティの Body を含む、新しい ResponseMessage が追加されます。次のデリゲートでは、前のデリゲートの MessageBody ではなく空の MessageBody を含む新規の Response が確認されます。

属性:

GetAccess
public
SetAccess
public
Dependent
true

処理中の要求の送信先。matlab.net.URI オブジェクトとして指定されます。この値は、send で決定される元の送信先 URI の値になります。プロキシの URI やリダイレクト後の最終的な URI ではありません。

このプロパティは、サブクラスで利用できるように、initialize を呼び出す前に MATLAB で設定されます。

属性:

GetAccess
public
SetAccess
public

保護プロパティ

データを追加するために putData メソッドで呼び出される関数。関数ハンドルとして指定されます。このクラスの putData メソッドは、data 引数で受け取ったデータを応答メッセージの既存のデータに追加するために関数 AppendFcn を呼び出します。この関数のシグネチャは次のとおりでなければなりません。

AppendFcn(consumer,newdata)

newdata は、consumer.Response.Body.Data の配列に追加されるデータです。このメソッドは、Data の新しい長さに合わせて consumer.CurrentLength を更新する必要があります。newdata が空の場合はストリームの末尾を示し、関数により Response.Body.Data が最終的な値に更新されます。

既定の動作では、このプロパティが空の場合、Data を任意の値の配列として扱う、関数 horzcat に対応した内部関数が使用されます。この関数では、スペースを事前に割り当てることで効率的に newdata が追加され、格納されたデータの実際の長さが CurrentLength に反映されます。メッセージの最後に、Response.Body.DataCurrentLength の値までで切り捨てられます。

horzcat が追加処理に適さない場合は、このプロパティをサブクラスで変更できます。たとえば、StringConsumer でスカラー string を作成する場合は、string への追加に関数 horzcat ではなく関数 plus を使用することがあります。

データを追加する ContentConsumer.putData を呼び出さない場合やデータを追加する際の horzcat の動作に問題がない場合は、サブクラスでこのプロパティを無視することができます。

例: @customAppend@customAppend はコンシューマーによって定義されます。

属性:

GetAccess
protected
SetAccess
protected

このコンシューマーによるデリゲート先の ContentConsumermatlab.net.http.io.ContentConsumer オブジェクトとして指定します。呼び出し元のコンシューマー (デリゲーター) の delegateTo メソッドによって CurrentDelegate プロパティが設定されます。現在のデリゲーションがない場合、値は [] です。

MATLAB は initialize を呼び出す前に CurrentDelegate[] に設定します。

属性:

GetAccess
protected
SetAccess
protected

Response.Body.Data プロパティの現在のデータの長さ。uint64 として指定されます。

このプロパティは、Response.Body.Data に事前に割り当てられたサイズが現在格納されている実際のデータの量よりも大きい場合に、格納されているデータの長さを示すために使用されます。このプロパティが空の場合は、すべての Response.Body.Data にデータが格納されているか、ContentConsumer サブクラスで Response.Body.Data に格納する以外の何らかの方法でデータが破棄されていることを示します。

このプロパティは、この基底クラスの putData メソッドで、AppendFcn プロパティが空の場合に使用および設定されます。putData を呼び出すサブクラスで既に格納されているデータを確認したり、AppendFcn の任意の実装で Response.Body.Data に結果を反映したりするのに使用できます。

putData を使用するサブクラスでは、このプロパティを変更してデータが格納されるバッファーの位置をリセットすることもできます。たとえば、既定の関数 AppendFcn を使用している場合、putData の呼び出しごとにすべての Response.Body.Data を処理するサブクラスで元のデータが不要になったときは、CurrentLength プロパティを 1 にリセットすることで次の putData の呼び出し時に新しいデータでバッファーを上書きできます。新しいデータの末尾を越えてバッファーの要素をクリアする必要はありません。

putData を呼び出さないサブクラスでは、このプロパティを独自のデータの追跡に使用できます。使用しない場合は未設定 (空) のままにしておいてかまいません。ここで設定できる値に関して、MATLAB にはいかなる制約もありません。また、この値は、既定の AppendFcn でデータの次のバッファーを格納する位置とメッセージの末尾のデータを切り捨てる位置を特定するためにのみ使用され、それ以外の目的には使用されません。データが切り捨てられないようにするには、putData(uint8.empty) の最後の呼び出しの前にこのプロパティを空に設定します。

このプロパティは、initialize の各呼び出しの前に MATLAB で空に設定されます。

属性:

GetAccess
protected
SetAccess
protected

このコンシューマーのデリゲート元の ContentConsumermatlab.net.http.io.ContentConsumer オブジェクトとして指定されます。このコンシューマーが GenericConsumerMultipartConsumer などの別のコンシューマーから呼び出されたデリゲートである場合、これは呼び出し側のコンシューマーを示します。send の呼び出しで指定された最上位のコンシューマーの場合は空になります。

デリゲートは、このプロパティを使用してデリゲーターのプロパティにアクセスし、デリゲート元のコンシューマーなどを確認できます。

属性:

GetAccess
protected
SetAccess
protected

メソッド

すべて展開する

詳細

すべて展開する

R2018a で導入