matlab.net.http.HeaderField クラス

名前空間: matlab.net.http

HTTP メッセージのヘッダー フィールド

説明

HeaderField クラスは、HTTP メッセージのヘッダー フィールドの実装に使用します。クラスは、ヘッダーの string と MATLAB^® オブジェクト、配列および構造体間の変換を提供します。HeaderField プロパティは任意の値に設定できますが、HTTP ヘッダー フィールドには使用できる文字に制約があります。

Name プロパティはヘッダー フィールドのタイプを定義します。MATLAB は matlab.net.http.field 名前空間でよく使用されるフィールドのサブクラスを提供します。サポートされるサブクラスのリストを表示するには、HeaderField.displaySubclasses メソッドを呼び出します。

作成

説明

obj = matlab.net.http.HeaderField(name,value) は、Name プロパティを name に、Value プロパティを value に設定してヘッダー フィールドを作成します。いずれの引数も空の double である [] にすることができます。複数の引数のペアを任意の順序で name1,value1,...,nameN,valueN のように指定できます。最後の value 引数がない場合、HeaderField はそれを空として扱います。

プロパティ

Name — ヘッダー フィールド名

string | 文字ベクトル

ヘッダー フィールド名。string または文字ベクトルとして指定します。Name はフィールドのタイプを決定し、それにより Value プロパティの有効な値が決まります。Name を [] または空の string に設定する場合、Value は [] になります。

このオブジェクトが特定のヘッダー フィールドのタイプを実装するサブクラスのインスタンスの場合、そのクラスは Name プロパティの制約を適用します。

例: 'Content-Type'

属性:

GetAccess	public
SetAccess	public

Value — ヘッダー フィールド値

string | Name に対して有効な任意のタイプ

ヘッダー フィールド値。string または Name プロパティに対して有効なタイプとして指定します。

このプロパティを読み取るときは、Value はフィールドの値を表す string となります。

このプロパティを設定するときは、Value はこのオブジェクトの Name プロパティおよびクラスの両方またはいずれかに基づく、フィールドで受け入れ可能なタイプとなります。結果は string に変換されます。フィールドのタイプに既定値がある場合は、Value を空の string ('' または string('')) に設定します。空の double である [] を指定する場合、要求メッセージの send メソッドおよび complete メソッドはこのフィールドをメッセージに追加しません。

例: 'text/html'

属性:

GetAccess	public
SetAccess	public
Dependent	true

メソッド

パブリック メソッド

convert	ヘッダー フィールド値を MATLAB タイプに変換
convertLike	ヘッダー フィールド値を別のヘッダー フィールドと同様に変換
parse	ヘッダー フィールド値を解析して string として返す
addFields	HeaderField 配列へのフィールドの追加
removeFields	ヘッダー フィールド配列からフィールドを削除
changeFields	HeaderField 配列内の既存値を変更
replaceFields	HeaderFields の配列の値を変更またはフィールドを追加
getFields	名前またはクラスが一致するヘッダー フィールドを返す
eq	2 つの HeaderField 配列の比較
displaySubclasses	サポートされる HeaderField サブクラスの表示

特殊な演算子と関数

次のメソッドは、MATLAB の標準の演算子および関数を、このクラスのオブジェクト用に特殊化したものです。

isequal	2 つのヘッダー フィールド配列が同じサイズで、eq メソッドで示されているように、対応する要素が等しい場合、true を返します。
string	メッセージに string として表示されるヘッダー フィールドの配列。改行文字はフィールドの間に挿入されますが、すべてのフィールドの最後には挿入されません。
char	string メソッドで示されているように、文字ベクトルとしてのヘッダー フィールドの配列

例

ヘッダー フィールド コンストラクターの選択

Content-Type ヘッダー フィールドを作成するには、HeaderField クラスまたは ContentTypeField クラスのコンストラクターのいずれかを使用します。

HeaderField クラスのコンストラクターを使用するときは、Name プロパティを 'Content-Type' として指定します。ただし、フィールド名にスペルミスがある場合、サーバーがメッセージを拒否するまでエラーに気付かないことがあります。不明なフィールド名を警告なしで無視するサーバーもあります。

f1 = matlab.net.http.HeaderField('Content-Type','text/plain');

フィールド名のスペルミスが発生しないため、ContentTypeField クラスのコンストラクターの使用をお勧めします。

f2 = matlab.net.http.field.ContentTypeField('text/plain');

Value プロパティが同じである場合、使用するコンストラクターに関係なく、フィールドは等価です。

f1 == f2

ans =    1

HTTP HeaderField 配列での値の検索

この例では、mathworks.com からの応答内で特定のヘッダー フィールド Cache-Control を検索する方法を説明します。

メッセージを mathworks.com に送信します。

request = matlab.net.http.RequestMessage;
uri = matlab.net.URI('https://www.mathworks.com');
response = send(request,uri);

Cache-Control を検索してその値を表示します。

field = response.getFields('Cache-Control');
value = field.Value

value = 
"max-age=14400"

ヒント

• HeaderField コンストラクターは HeaderField クラスのフィールドを作成します。matlab.net.http.field 名前空間で定義されるクラスのフィールドを作成するには、代わりにサブクラスのコンストラクターを使用します。サブクラスのリストについては、HeaderField.displaySubclasses メソッドを呼び出します。

  たとえば、matlab.net.http.field.DateField サブクラスは Date ヘッダー フィールドを作成します。HeaderField クラスを使って Date フィールドを作成する場合、HeaderField が DateField のインスタンスでない場合でも DateField クラスが値を解釈して適用します。同様に、フィールド値を MATLAB datetime 値に変換する場合は、DateField.convert メソッドが使用されます。

• HeaderField コンストラクターで Name 引数および Value 引数が拒否される場合は、代わりに GenericField クラス コンストラクターを使用します。

バージョン履歴

R2016b で導入

参考

matlab.net.http.field.GenericField