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 によってファイルの末尾に位置指定子が残され、ファイルは閉じられません。
入力引数
filename
— ファイルまたはフォルダー名
文字ベクトル | string スカラー
絶対パスおよびオプションの拡張子を含むファイルまたはフォルダーの名前。文字ベクトルまたは 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
permission
— ファイル アクセス タイプ
w+
(既定値) | u+
| u
| T
| 関数 fopen
によって許可される値
ファイル アクセス タイプ。string として指定します。permission
が指定されている場合、書き込みアクセスを許可しなければなりません。既定値は 'w+'
であり、読み取りおよび書き込みのためにファイルを開くか作成し、既存のコンテンツを破棄します (存在する場合)。
permission
は関数 fopen
によって許可される任意の値にすることができます。次の permission
の追加の値がサポートされます。
|
たとえば、 |
| 権限に付加されると、テキスト モード |
'w'
および 'w+'
権限の場合 (または permission
が指定されていない場合)、すべてのケースにおいて、ファイル名が filename
と厳密に一致する場合を除いて、MATLAB によって既存のファイルが上書きされることはありません。
例: 'a'
'w+T'
データ型: char
| string
machineformat
— バイトまたはビットの読み取りまたは書き込みの順序
fopen
によって許可される任意の値
バイトまたはビットの読み取りまたは書き込みの順序。関数 fopen
によって許可される任意の値として指定します。
データ型: char
| string
encoding
— 文字エンコード
fopen
によって許可される任意の値
文字エンコード。関数 fopen
によって許可される任意の値として指定します。
データ型: char
| string
プロパティ
パブリック プロパティ
FileIdentifier
— ファイル識別子
double
書き込まれているファイルの識別子 (FID)。double として指定します。コンシューマーが FID 引数を使って構築された場合、このプロパティは識別子です。データはこの識別子に関連付けられた現在のファイルの位置指定子に書き込まれるため、サブクラスでは、この識別子を使用しているときに誤って位置を変更しないように注意する必要があります。転送の最後にファイルは開いたままになり、位置はファイルの末尾に留まります。
コンストラクターが filename
引数を使用して、または引数なしで呼び出された場合、このプロパティはそのファイルに対する読み取り専用のファイル識別子になります。これにより、書き込みに使用されている位置指定子をそのままにして、転送中にサブクラスがファイルを読み取ることができます。転送の最後に、この識別子は閉じられます。
属性:
GetAccess | public |
SetAccess | private |
Filename
— ファイル パス名
string.empty
(既定値) | string
書き込まれているファイルの絶対パス名。string として指定します。コンシューマーが FID 引数を使って構築された場合、このプロパティはファイルの名前です。そうでない場合は、応答メッセージの受信中に MATLAB によるファイルへの書き込みが開始されるまで、この値は設定されない可能性があります。これは、すべてのヘッダーが受信されるまでファイル名を決定できるとは限らないためです。このプロパティを使用して、書き込まれたファイルを判断します。Filename
は Response.Body.Data
プロパティにも格納されます。
属性:
GetAccess | public |
SetAccess | private |
AllocationLength
— 推奨されるバッファー サイズ
uint64
ContentLength
— 想定されるペイロードの長さ
uint64
| 空
想定されるペイロードの長さ。uint64
として指定されます。このプロパティは通常、Header
プロパティにおける matlab.net.http.field.ContentLengthField
の Value
プロパティになります。
ContentLength
が空の場合、長さは不明です。ペイロードは putData(uint8.empty)
が呼び出された時点で終了します。
このプロパティは、サブクラスでデータの長さを確認できるように、initialize
を呼び出す前に MATLAB で設定されます。
この ContentConsumer
が最上位のコンシューマーのデリゲートである場合、ContentLength
の値が最上位のコンシューマーの ContentLength
と異なる値になることがあります。
例: numel(someData)
。ここで、someData
は uint8
型です。
属性:
GetAccess | public |
SetAccess | public |
ContentType
— ペイロードのメディア タイプ
matlab.net.http.MediaType
| 空
ペイロードのメディア タイプ。matlab.net.http.MediaType
オブジェクトとして指定します。このプロパティは通常、Header
プロパティにおける matlab.net.http.field.ContentTypeField
の Value
プロパティになります。ContentType
プロパティが空の場合、ContentTypeField
は空または存在しません。
このプロパティは、サブクラスで MediaType
を確認できるように、initialize
を呼び出す前に MATLAB で設定されます。データから別の MediaType
であることがわかった場合は、サブクラスでこのプロパティを設定できます。
この値は、転送の終了時に MATLAB によって Response.Body.ContentType
プロパティにコピーされます。
例: 'application/octet-stream'
属性:
GetAccess | public |
SetAccess | public |
Header
— 現在処理中のペイロードのヘッダー
matlab.net.http.HeaderField
現在処理中のペイロードのヘッダー。matlab.net.http.HeaderField
オブジェクトとして指定されます。
コンシューマーは、このヘッダーを使用して、送られてくるペイロードの処理方法を決定します。最上位のコンシューマーの場合、この値は Response.Header
と同じになります。デリゲートの場合は値が異なることがあります。たとえば、MultipartConsumer
で処理されるマルチパート メッセージの場合は、そのデリゲートで処理中のパートのヘッダーになります。デリゲートは引き続き Response.Header
で元のメッセージのヘッダーを確認できます。
このプロパティは、サブクラスで利用できるように、initialize
を呼び出す前に MATLAB で設定されます。
属性:
GetAccess | public |
SetAccess | public |
Request
— 送信が完了した RequestMessage
matlab.net.http.RequestMessage
送信が完了した RequestMessage
。matlab.net.http.RequestMessage
オブジェクトとして指定します。これは、すべてのリダイレクトが完了した最終的な RequestMessage
であり、send
メソッドからの completedrequest
戻り値です。
このプロパティは、サブクラスで利用できるように、initialize
を呼び出す前に MATLAB で設定されます。
属性:
GetAccess | public |
SetAccess | public |
Response
— 処理中の ResponseMessage
matlab.net.http.ResponseMessage
処理中の ResponseMessage
。matlab.net.http.ResponseMessage
オブジェクトとして指定します。
Response
プロパティは、initialize
を呼び出す前に MATLAB で設定されます。この値は、ヘッダーの受信まで完了し、ペイロードを受信する前の ResponseMessage
になります。応答メッセージの処理の開始時 (マルチパート メッセージの場合はパートの開始時) に、ResponseMesssage.Body
プロパティは、Data
プロパティと Payload
プロパティが空の MessageBody
オブジェクトになります。受信したデータを格納するために、コンシューマーはデータ転送中に Response
プロパティと MessageBody.Data
プロパティを変更できます。通常、コンシューマーはデータセット Response.Body.Data
を処理してから処理済みのペイロードに格納しますが、これは必須ではありません。転送が完了すると、この Response
が MATLAB から send
の呼び出し元に返されます。Response
の Header
や StatusLine
などの他のプロパティは、コンシューマーで変更しないでください。これらを変更した場合、その変更が send
の呼び出し元に返されます。
Response.Body.Payload
プロパティは転送中は空であり、コンシューマーで変更してはなりません。HTTPOptions.SavePayload
プロパティが設定されると、次に MATLAB は、メッセージまたはパートの転送終了時 (putData(uint8.empty)
の呼び出し後)、または例外の発生時に、受信したペイロードに Payload
を設定します。
メッセージの処理中にコンシューマーで例外が発生した場合は、MATLAB から HTTPException
オブジェクトがスローされます。History
プロパティにはこの Response
値が含まれます。
コンシューマーがマルチパート メッセージのパートを処理するデリゲートの場合、Response.Header
にメッセージ全体のヘッダーが格納され、各パートの ContentConsumer
を呼び出す前に Response.Body
の Payload
プロパティと Data
プロパティがクリアされます。各パートの最後で、元の応答の Body.Data
にある ResponseMessage
オブジェクトの配列の末尾に、このオブジェクトの Header
およびこのプロパティの Body
を含む、新しい ResponseMessage
が追加されます。次のデリゲートでは、前のデリゲートの MessageBody
ではなく空の MessageBody
を含む新規の Response
が確認されます。
属性:
GetAccess | public |
SetAccess | public |
Dependent | true |
URI
— 処理中の要求の送信先
matlab.net.URI
処理中の要求の送信先。matlab.net.URI
オブジェクトとして指定されます。この値は、send
で決定される元の送信先 URI の値になります。プロキシの URI やリダイレクト後の最終的な URI ではありません。
このプロパティは、サブクラスで利用できるように、initialize
を呼び出す前に MATLAB で設定されます。
属性:
GetAccess | public |
SetAccess | public |
保護プロパティ
AppendFcn
— データを追加するために putData
で呼び出される関数
関数ハンドル
データを追加するために 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.Data
が CurrentLength
の値までで切り捨てられます。
horzcat
が追加処理に適さない場合は、このプロパティをサブクラスで変更できます。たとえば、StringConsumer
でスカラー string を作成する場合は、string への追加に関数 horzcat
ではなく関数 plus
を使用することがあります。
データを追加する ContentConsumer.putData
を呼び出さない場合やデータを追加する際の horzcat
の動作に問題がない場合は、サブクラスでこのプロパティを無視することができます。
例: @customAppend
。@customAppend
はコンシューマーによって定義されます。
属性:
GetAccess | protected |
SetAccess | protected |
CurrentDelegate
— このコンシューマーによるデリゲート先の ContentConsumer
matlab.net.http.io.ContentConsumer
| []
このコンシューマーによるデリゲート先の ContentConsumer
。matlab.net.http.io.ContentConsumer
オブジェクトとして指定します。呼び出し元のコンシューマー (デリゲーター) の delegateTo
メソッドによって CurrentDelegate
プロパティが設定されます。現在のデリゲーションがない場合、値は []
です。
MATLAB は initialize
を呼び出す前に CurrentDelegate
を []
に設定します。
属性:
GetAccess | protected |
SetAccess | protected |
CurrentLength
— Response.Body.Data
の現在のデータの長さ
uint64.empty
(既定値) | uint64
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 |
MyDelegator
— このコンシューマーのデリゲート元の ContentConsumer
matlab.net.http.io.ContentConsumer
| 空
このコンシューマーのデリゲート元の ContentConsumer
。matlab.net.http.io.ContentConsumer
オブジェクトとして指定されます。このコンシューマーが GenericConsumer
や MultipartConsumer
などの別のコンシューマーから呼び出されたデリゲートである場合、これは呼び出し側のコンシューマーを示します。send
の呼び出しで指定された最上位のコンシューマーの場合は空になります。
デリゲートは、このプロパティを使用してデリゲーターのプロパティにアクセスし、デリゲート元のコンシューマーなどを確認できます。
属性:
GetAccess | protected |
SetAccess | protected |
メソッド
パブリック メソッド
initialize | 新しい HTTP ペイロードのためのコンシューマーを準備 |
start | FileConsumer へのファイル転送を開始 |
putData | FileConsumer のファイルにデータの次のバッファーを保存 |
delegateTo | 別のコンシューマーへのデリゲート |
詳細
クラスの階層
バージョン履歴
R2018a で導入
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)