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

パッケージ:matlab.net.http.io
スーパークラス:处理，matlab.mixin.Heterogeneous

HTTPメッセージペイロードのContentProvider

説明

内容提供者は,メッセージの送信中にHTTPRequestMessageのデータを提供します。簡単なものとしては、データを MATLAB^®型からバイトストリームに変換するプロバイダーがあります。より複雑なプロバイダーでは,データをサーバーにストリーミングできます。この場合,データの取得や生成を送信と同時に行えるため、メッセージの開始前にすべてのデータをメモリに読み込む必要がありません。

通常,データをWebサービスに送信するときは(把要求または帖子要求が一般的),RequestMessageを作成し,データをMessageBodyオブジェクトの形式でRequestMessage。身体プロパティに挿入します。そのメッセージをRequestMessage.sendを使用して送信すると,そのデータがサーバーに送信するバイトストリームに変換されます。この変換は,メッセージの- typeと的身体。数据のデータのタイプに基づいてMATLABで行われます。この変換ルールについては,MessageBody。数据を参照してください。

MessageBodyオブジェクトをRequestMessage。身体プロパティに挿入する代わりに,内容提供者オブジェクトを作成して挿入することができます。この場合,メッセージを送信すると、MATLAB で内容提供者のメソッドが呼び出され,送信するデータのバッファーがメッセージの送信中に取得されます。

メッセージにMessageBodyまたは内容提供者のどちらを挿入した場合も,RequestMessage.sendの呼び出しはメッセージ全体が送信されて応答を受信するか,エラーが発生するまで戻りません(ブロックされます)。ただし,内容提供者の場合は,送信がブロックされている間,送信するデータのバッファーを取得するためのプロバイダーに対するコールバックがMATLABで定期的に実行されます。内容提供者では,これらのコールバックで,ファイル,MATLAB配列,ハードウェアセンサー,MATLAB関数などの任意のソースからデータを取得できます。プロバイダーの役割は,そのデータをWebに送信できるバイトストリーム(uint8形式のバッファー)に変換することです。

内容提供者は,クラスの作成者が独自のデータジェネレーターやデータコンバーターを使用してサブクラス化できるように設計された抽象クラスです。また,MATLABプロバイダーのいずれかを使用(またはサブクラス化)すれば,サブクラスを記述せずにさまざまなソースからデータを生成させることができます。これらのプロバイダーには,データをMessageBodyに直接挿入する場合に実行される自動変換に比べて,データの取得方法や変換方法をより柔軟に制御できるオプションがあります。次のいずれかの内容提供者サブクラスを使用します。

データをストリーミングする必要がない場合でも,これらのプロバイダーのいずれかを使用すると,データが内部形式からuint8ストリームに変換されるため,特定のタイプの内容を送信する処理が簡単になります。たとえば,FormProviderを使用すれば,フォームの応答をサーバーに送信し,データをQueryParameterオブジェクトの配列として表現できるので便利です。MultipartFormProviderを使用すると,マルチパートフォームの応答を送信できるため,マルチパートフォームの応答の作成が簡単になります。内容提供者を使用する場合は,サーバーへの送信が想定される内容のタイプを理解しておく必要があります。

matlab.net.http.io.ContentProviderクラスは处理クラスです。

サブクラスの作成

簡単な内容提供者であれば,MATLABから要求されたときにデータのバッファーを提供するgetDataメソッドを実装するだけで作成できます。プロバイダーを使用するには,RequestMessageの身体プロパティに挿入します。この例では,RequestMessageコンストラクターの3番目の引数でMyProviderオブジェクトを身体に挿入しています。

提供者= MyProvider;req = matlab.net.http.RequestMessage('put'， headers, provider);resp = req.send (uri);

次に,コンストラクターに引数として名前が渡されたファイルを読み取ってWebに送信するMyProviderクラスの例を示します。この例では,処理が終了するかこのプロバイダーが削除されたときにファイルを閉じます。

class . MyProvider < matlab.net.http.io.ContentProvider属性FileID双端方法function obj = MyProvider(name)文件标识= fopen(名称);end function [data, stop] = getData(obj, length) [data, len] = fread(obj. length)文件标识、长度、“* uint8”);停止= len < length;如果(停止)文件关闭(obj.FileID);obj。文件标识= [];delete(obj) if ~isempty(obj. fileid) fclose(obj. fileid);obj。文件标识= [];端端端端

MATLABは,送信する新しいメッセージの作成中にプロバイダーの完整的メソッドを呼び出します。これは,プロバイダーでの新しいメッセージの準備として,必要なヘッダーフィールドをメッセージに追加できるようにするためです。MATLABは,データの送信時になると,getDataの最初の呼び出しの前にプロバイダーの开始メソッドを呼び出します。

プロパティ

すべて展開する

パブリックプロパティ

`头`- - - - - -メッセージまたはパートのヘッダーフィールド
`matlab.net.http.HeaderField.empty`(既定値) |`matlab.net.http.HeaderField`

メッセージまたはパートのヘッダーフィールド。1つ以上のmatlab.net.http.HeaderFieldオブジェクトのベクトルとして指定されます。

このプロパティはサブクラスの作成にのみ使用されます。このプロパティは,プロバイダーの完整的を呼び出す前にMATLABで設定されます。マルチパートメッセージ以外については,このプロパティは,MATLABによってmatlab.net.http.field.GenericFieldsや値が空のフィールドを除いた请求。头の内容に初期化されます。内容提供者では,送信するデータを示すヘッダーフィールドを追加したり,メッセージの既存のヘッダーフィールドにパラメーターを追加したりする場合にこのプロパティを使用します。MultipartProviderのデリゲートでは,このプロパティは,MATLABによってデリゲート元のプロバイダーが挿入するパート用のヘッダーフィールドに初期化されます。これらのフィールドはデリゲートで変更が可能です。

マルチパートメッセージ以外では,プロバイダーの完整的メソッドから戻ると,MATLABはこのプロパティを読み取って,その内容を请求のヘッダーにマージします。この头に含まれるフィールドの的名字が请求。头にない場合,请求。头の末尾に追加されます。この头に含まれるフィールドの的名字が请求。头に含まれるフィールドと同じで,どちらの值も空でない場合は,次のように処理されます。

请求。头のフィールドがGenericFieldの場合,头のフィールドは無視されます。
请求。头のフィールドがGenericFieldでない場合,头のフィールドに置き換えられます。

これらの一方または両方の价值が空の場合は,请求。头からフィールドが削除され,メッセージの正常な終了時にも追加されません。

MultipartProviderのデリゲートの場合は,この头の内容全体がパートのヘッダーとして使用されます。マルチパートデリゲートでは,请求。头にその头に付随する任意のフィールドが含まれていると想定してはなりません。プロバイダーがマルチパートデリゲートであるかどうかはMyDelegatorがMultipartProviderかどうかを確認すれば特定できますが,このテストが必要になることはほとんどありません。

このプロパティがMATLABで読み取られるのは,プロバイダーの完整的メソッドの呼び出しから戻るときだけです。MATLABで开始が呼び出された後は,この配列に対する変更は無視されます。

クラスを作成するときは,スーパークラスで完整的を呼び出す前に,この(完整的メソッド内の)头にサブクラスがフィールドを追加済みの場合があることを認識しておく必要があります。それらのフィールドは残しておいて,同じ名前のフィールドを追加しないようにすることを推奨します。ただし,フィールドへのパラメーターの追加は可能です。たとえば,既存の Content-Type フィールドに charset パラメーターがない場合、スーパークラスで追加できます。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`

`ForceChunked`- - - - - -チャンク転送コーディングを強制するかどうかを示す
`假`(既定値) |`真正的`

チャンク転送コーディングを強制するかどうかを示します。布尔として指定されます。これはサブクラスの作成にのみ関係するプロパティで,マルチパートデリゲート以外のプロバイダーにのみ該当します。サブクラスでは,ForceChunkedを設定することで,内容の送信にチャンク転送コーディングを使用するかどうかを制御します。假(既定)の場合,MATLABは,メッセージの送信準備ができた時点で内容の長さがわかっているかどうかに基づいて,内容をチャンク化して送信するかどうかを決定します。

MATLABで内容の長さがわかっている場合(メッセージに内容长度フィールドがあるか,このプロバイダーのexpectedContentLengthメソッドから数値が返された場合),チャンク化して送信するかどうかをMATLABで決定します。
MATLABで内容の長さがわからない場合(ヘッダーに内容长度フィールドがないか,expectedContentLengthの戻り値が空の場合),MATLABはメッセージを常にチャンク化して送信します。

ForceChunkedが真正的の場合,内容の長さがわかっているかどうかに関係なく,既知の長さがチャンクサイズに満たない場合を除き,MATLABはメッセージをチャンク化して送信します。このプロパティが真正的の場合は,メッセージに内容长度フィールドを含めてはなりません。HTTPではチャンクされたメッセージに内容长度フィールドを含めることが許可されないためです。ただし,想定されるデータの長さを返しているかをMATLABで検証する場合は,expectedContentLengthメソッドで非ゼロの値を返すことができます。

MATLABでメッセージをチャンク化して送信する場合,各チャンクのサイズはgetDataで返されたデータの長さと等しくなります。

MATLABは,完整的メソッドを呼び出してから开始を呼び出すまでの間にこの値を読み取ります。このフィールドの設定は行いません。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`

`请求`- - - - - -送信する要求メッセージ
`matlab.net.http.RequestMessage`

送信する要求メッセージ。matlab.net.http.RequestMessageオブジェクトとして指定されます。

このプロパティはサブクラスの作成にのみ使用されます。このプロパティは,このプロバイダーで他のメソッドを呼び出す前であり、かつヘッダーフィールドを追加したりメッセージを検証したりする前に、このプロバイダーが身体に配置されたRequestMessageにRequestMessage.sendメソッドとRequestMessage.completeメソッドで設定されます。プロバイダーは、このメッセージを調べて元の要求の内容を確認できます。

デリゲートの場合,このプロパティの値はデリゲーターと同じになります。内容提供者がデリゲートである場合は,必ずしも要求メッセージの本文全体を提供するわけではないため,この请求のヘッダーフィールドがそのプロバイダーで提供するデータに関連するものであるとは限らないことに注意が必要です。通常,デリゲートでは,この要求のデータ関連のヘッダーフィールド(内容类型など)は無視します。

このメッセージへのヘッダーフィールドの追加や既存のヘッダーフィールドの変更をプロバイダーで行う場合は,完整的メソッドで头プロパティにそれらのフィールドを追加します。それらのフィールドに対する処理は,完整的の呼び出し元(RequestMessageまたはデリゲート元のプロバイダー)で決定されます。RequestMessage.sendとRequestMessage.completeは,それらのフィールドをRequestMessageの头に常にコピーします。デリゲート元のプロバイダーでは,フィールドをそれぞれの头プロパティにコピーしたりメッセージに挿入したりできます(MultipartProviderの場合と同様)。詳細については,头プロパティを参照してください。

このプロパティは読み取り専用です。

属性:

`GetAccess`	`公共`
`SetAccess`	`matlab.net.http.RequestMessage`

保護プロパティ

`CurrentDelegate`- - - - - -このプロバイダーのデリゲート先の`内容提供者`
`matlab.net.http.io.ContentProvider`|空

このプロバイダーのデリゲート先の内容提供者。matlab.net.http.io.ContentProviderオブジェクトとして指定されます。このプロパティは,現在のデリゲート先のプロバイダーを示すために呼び出し元のプロバイダー (デリゲーター) のdelegateToメソッドで設定されます。現在のデリゲーションがない場合,値は空です。

このプロパティは完整的メソッドで空に設定されます。

属性:

`GetAccess`	`受保护的`
`SetAccess`	`受保护的`

`MyDelegator`- - - - - -このプロバイダーのデリゲート元の`内容提供者`
`matlab.net.http.io.ContentProvider.empty`(既定値) |`matlab.net.http.io.ContentProvider`

このプロバイダーのデリゲート元の内容提供者。matlab.net.http.io.ContentProviderオブジェクトとして指定されます。

このプロパティは,内容提供者から別のプロバイダーにメッセージのすべてまたは一部のデータの送信がデリゲートされている場合に,デリゲート元のプロバイダーを示します。たとえば,MultipartProviderはメッセージのパートを他のプロバイダーにデリゲートするため,各デリゲートに自身のハンドルを挿入します。それ以外の場合,MyDelegatorは空です。このプロパティは、デリゲートのdelegateToメソッドで設定されます。

属性:

`GetAccess`	`受保护的`
`SetAccess`	`受保护的`

メソッド

すべて展開する

パブリックメソッド

`字符串`	ContentProviderを字符串として表示する
`显示`	ContentProviderの情報を表示する

保護されたメソッド

`完整的`	ContentProviderの完全なHTTPヘッダー
`preferredBufferSize`	ContentProviderの推奨されるバッファーサイズ
`expectedContentLength`	ContentProviderの内容の長さ
`开始`	ContentProviderからのデータ転送を開始する
`可重新开始的`	ContentProviderが再起動可能かどうか
`可重用的`	ContentProviderが再利用可能かどうか
`delegateTo`	別のプロバイダーにデリゲートする

抽象メソッド

getData ContentProviderからHTTP要求メッセージで送信するデータの次のバッファー

詳細

すべて展開する

再起動可能性と再利用可能性

プロバイダーには再起動可能なものや再利用可能なものがあります。再起動可能とは,MATLABで开始が呼び出されるたびに,前回の処理が正常に完了していない場合でも,プロバイダーから同じメッセージを同じデータストリームで繰り返し再送信できることを意味します。この動作が必要なのは,サーバーから別のサーバーへのメッセージのリダイレクトが可能なため,その際にデータを再送信する必要があるからです。MATLABはその場合,完整的を再度呼び出さずに开始を呼び出します。プロバイダーが再起動可能かどうかを判定するために,MATLABは可重新开始的メソッドを呼び出します。假の場合に、既に開始されているプロバイダーで开始を呼び出す必要があり,完整的への割り込み呼び出し(新しいメッセージでのみ発生)がなければ,MATLABは例外をスローします。

再利用可能とは,MATLABで完整的メソッドが呼び出されるたびに,別の(または同じ)メッセージにプロバイダーを再利用できることを意味します。プロバイダーが再利用可能かどうかを判定するために,MATLABは可重用的メソッドを呼び出します。假が返され,既に開始されているプロバイダーで完整的を呼び出す必要がある場合,MATLABは例外をスローします。プロバイダーが再利用可能な場合は,プロバイダーが再起動可能であっても,次の开始の呼び出しが成功すると仮定されます。

内容提供者は可重新开始的と可重用的の両方に対して假を返すため,この基底クラスを再起動可能または再利用可能なプロバイダーで直接拡張する場合は,それらの一方または両方のメソッドを真正的を返すようにオーバーライドします。matlab.net.http.ioパッケージの内容提供者の具象サブクラスは,いずれも再起動と再利用の両方が可能であるため,それらのメソッドに対して真正を返します。それらのサブクラスのいずれかを再利用可能または再起動可能でないプロバイダーで拡張する場合は,それらの一方または両方のメソッドを假を返すようにオーバーライドします。

この例のMyProviderクラスは,メッセージの最後にプロバイダーでファイルを閉じているため,再起動可能でも再利用可能でもありません。再利用可能にするには,コンストラクターではなく完整的メソッドで打开外部文件を呼び出して,プロバイダーの状態をメッセージに使用する前の状態に戻します。

class . MyProvider < matlab.net.http.io.ContentProvider属性FileID double Name string结束方法function obj = MyProvider(Name) obj. class . MyProvider < matlab.net.http.io.ContentProviderName =名称;end function [data, stop] = getData(obj, length)…如上…结束函数complete(obj, uri)文件标识= fopen(名称);obj.complete@matlab.net.http.io.ContentProvider ();End函数tf = reusable(~) tf = true;delete(obj)…如上…结束结束结束

このプロバイダーを再起動可能にするには,可重新开始的メソッドと开始メソッドを追加し,开始メソッドでfseekを発行してファイルの先頭に戻ります。

函数开始(obj) obj.start@matlab.net.http.io.ContentProvider ();fseek (obj。文件标识,0,1);结束函数tf = restartable(~) tf = true;结束

本文に内容提供者を含むRequestMessageで完整的または发送MATLABはを呼び出すと,自動フィールドの追加前に,プロバイダーの请求プロパティをプロバイダーが配置されたRequestMessageに設定し,头プロパティを请求のヘッダーに設定します。その後,プロバイダーの次のメソッドを以下の順序で呼び出します。

完整的-RequestMessage.sendまたはRequestMessage.completeを呼び出したときに,メッセージの最後に呼び出されます(通常はメッセージごとに1回)。プロバイダーの头プロパティがプロバイダー固有のメッセージに追加するいずれかのヘッダーフィールドに設定されている必要があります。このメソッドが以降に MATLAB で呼び出された場合、プロバイダーでは新しいメッセージに使用されているものと仮定します。ほとんどのプロバイダーでは、このメソッドを実装してヘッダーを追加する必要があります。さらに、この抽象クラスの直接のサブクラスでない場合は、他の既定の動作を呼び出すためにスーパークラスも呼び出します。プロバイダーの reusable メソッドで true が返された場合を除き、MATLAB でプロバイダーの完整的が複数回呼び出されることはありません。この抽象クラスは既定では再利用可能でありませんが、matlab.net.http.ioパッケージの具象プロバイダーはすべて再利用可能です。
preferredBufferSize/expectedContentLength-完整的の後,开始が呼び出されるまでの間にRequestMessage.sendから呼び出されます。ほとんどのプロバイダーでは,既定の動作で問題がないため,これらのメソッドを実装する必要はありません。ただし,力引数をサポートするようにオーバーライドすることができます。

これらのメソッドから戻った後,MATLABはRequestMessageのヘッダーをサーバーに送信します。本文の送信時になると,MATLABは次のメソッドを呼び出します。

开始——前のメソッドの呼び出し後,サーバーで要求メッセージの本文を受信する準備ができたとMATLABで判断された時点でRequestMessage.sendから呼び出されます。これが以降にMATLABで呼び出された場合,間に完成がなければ,プロバイダーでは(同じヘッダーをもつ)同じメッセージの本文をもう一度送信するように求められているものと仮定します。プロバイダーの可重新开始的メソッドで真正的が返された場合を除き,前回の完整的の呼び出し以降にMATLABで开始が複数回呼び出されることはありません。この抽象クラスは既定では再起動可能でありませんが,matlab.net.http.ioパッケージの具象プロバイダーはすべて再起動可能です。
getData-开始の呼び出し後,RequestMessage.sendがブロックされている間,サーバーでデータの新しいバッファーを受信する準備ができたとMATLABで判断されるたびに呼び出されます。このメソッドはデータのuint8ベクトルを返さなければなりません。プロバイダーは停止インジケーターを返すことでデータの末尾を示します。このメソッドはすべてのプロバイダーで実装しなければなりません。

getDataから停止インジケーターが返された後,MATLABは要求メッセージを終了し,サーバーからの応答を待ちます。

デリゲーション

RequestMessage。身体に挿入された内容提供者では,メッセージのすべてまたは一部のデータの提供を1つ以上の他のプロバイダーにデリゲートできます。たとえば,MultipartProviderは複数のパートで構成されるメッセージを作成し,各パートをMultipartProviderコンストラクターに指定された他のさまざまなプロバイダーから提供します。この場合,MultipartProviderがデリゲーターで,他のプロバイダーがデリゲートです。各デリゲートが順番に呼び出されて,それぞれのヘッダーフィールドとデータの位置を提供します。

あるプロバイダーから別のプロバイダーにデリゲートするには,delegateToを呼び出してCurrentDelegateをデリゲートに設定し,デリゲートのMyDelegatorを現在のプロバイダー(デリゲーター)に設定してから,デリゲートの完整的メソッドと开始メソッドを呼び出して,関数ハンドルGetDataFcnを返します。これにより,デリゲーターのgetDataメソッドでデリゲートのGetDataFcnが呼び出されてデータが取得されます。MATLABに返す前に、データが変更されることもあります。一般に、プロバイダーでデリゲートであるかどうかを確認したり、そのデリゲート元を特定したりする必要はありません。

クラスの階層

参考

R2018aで導入

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

説明

サブクラスの作成

プロパティ

パブリックプロパティ

`头`- - - - - -メッセージまたはパートのヘッダーフィールド
`matlab.net.http.HeaderField.empty`(既定値) |`matlab.net.http.HeaderField`

属性:

`ForceChunked`- - - - - -チャンク転送コーディングを強制するかどうかを示す
`假`(既定値) |`真正的`

属性:

`请求`- - - - - -送信する要求メッセージ
`matlab.net.http.RequestMessage`

保護プロパティ

`CurrentDelegate`- - - - - -このプロバイダーのデリゲート先の`内容提供者`
`matlab.net.http.io.ContentProvider`|空

属性:

`MyDelegator`- - - - - -このプロバイダーのデリゲート元の`内容提供者`
`matlab.net.http.io.ContentProvider.empty`(既定値) |`matlab.net.http.io.ContentProvider`

属性:

メソッド

パブリックメソッド

保護されたメソッド

抽象メソッド

詳細

再起動可能性と再利用可能性

デリゲーション

クラスの階層

参考

MATLABドキュメンテーション

サポート

MATLABで始めるディープラーニング

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

説明

サブクラスの作成

プロパティ

パブリックプロパティ

头- - - - - -メッセージまたはパートのヘッダーフィールドmatlab.net.http.HeaderField.empty(既定値) |matlab.net.http.HeaderField

属性:

ForceChunked- - - - - -チャンク転送コーディングを強制するかどうかを示す假(既定値) |真正的

属性:

请求- - - - - -送信する要求メッセージmatlab.net.http.RequestMessage

保護プロパティ

CurrentDelegate- - - - - -このプロバイダーのデリゲート先の内容提供者matlab.net.http.io.ContentProvider|空

属性:

MyDelegator- - - - - -このプロバイダーのデリゲート元の内容提供者matlab.net.http.io.ContentProvider.empty(既定値) |matlab.net.http.io.ContentProvider

属性:

メソッド

パブリックメソッド

保護されたメソッド

抽象メソッド

詳細

再起動可能性と再利用可能性

デリゲーション

クラスの階層

参考

MATLABドキュメンテーション

サポート

MATLABで始めるディープラーニング

`头`- - - - - -メッセージまたはパートのヘッダーフィールド
`matlab.net.http.HeaderField.empty`(既定値) |`matlab.net.http.HeaderField`

`ForceChunked`- - - - - -チャンク転送コーディングを強制するかどうかを示す
`假`(既定値) |`真正的`

`请求`- - - - - -送信する要求メッセージ
`matlab.net.http.RequestMessage`

`CurrentDelegate`- - - - - -このプロバイダーのデリゲート先の`内容提供者`
`matlab.net.http.io.ContentProvider`|空

`MyDelegator`- - - - - -このプロバイダーのデリゲート元の`内容提供者`
`matlab.net.http.io.ContentProvider.empty`(既定値) |`matlab.net.http.io.ContentProvider`