matlab.net.http.Message クラス

パッケージ: matlab.net.http

HTTP 要求メッセージまたは応答メッセージ

説明

Message クラスは、HTTP メッセージを作成する基底クラスとして使用される抽象クラスです。

プロパティ

StartLine — メッセージの最初の行

matlab.net.http.StartLine オブジェクト

メッセージの最初の行。matlab.net.http.StartLine オブジェクトがある場合はこのオブジェクトとして指定します。

属性:

GetAccess	public
SetAccess	public

Header — メッセージ ヘッダー

[] (既定値) | matlab.net.http.HeaderField オブジェクト

メッセージ ヘッダー。matlab.net.http.HeaderField オブジェクトまたは HeaderField オブジェクトのベクトルとして指定します。Header プロパティを設定すると、MATLAB^® はヘッダーのフィールドをチェックしてメッセージ タイプに対して適切であることを確認します。RequestMessage の send メソッドおよび complete メソッドは、正しい形式の要求になるように必要なヘッダー フィールドを埋めます。

属性:

GetAccess	public
SetAccess	public

Body — メッセージ本文

[] (既定値) | matlab.net.http.MessageBody オブジェクト | matlab.net.http.io.ContentProvider

メッセージ本文。matlab.net.http.MessageBody オブジェクト、matlab.net.http.io.ContentProvider、または MessageBody コンストラクターで受け入れ可能なデータとして指定します。既定では、Body は空です ([] に設定されます)。Body プロパティを含む要求メッセージは通常、'PUT' または 'POST' などのメソッドを使用し、既定値 'GET' は使用しませんが、この表記は強制されません。

完了したメッセージまたは受信したメッセージで、メッセージに ContentTypeField ヘッダー フィールドがある場合、MessageBody.ContentType プロパティはその値に設定されます。それ以外の場合、ContentType は変更されないか空になります。

属性:

GetAccess	public
SetAccess	public

Completed — メッセージが完了しているかどうか

false (既定値) | true

メッセージが完了しているかどうか。true または false として指定します。true 値はメッセージが完了していることを意味します。

メッセージを検証する RequestMessage メソッド (send および complete) は、次の場合に Completed プロパティを true に設定します。

• メッセージが有効である。

• 処理が完了している。たとえば、必要なヘッダー フィールドが追加され、データが変換されている。

このプロパティが true の場合、これらのメソッドはメッセージを変更せず、send メソッドはメッセージの有効性をチェックせずにメッセージを送信します。このメッセージを後で変更すると、Completed の値が false に変更されます。

メッセージを返すメソッドは、次の場合に Completed を true に設定します。

• Body プロパティまたは Body.Data プロパティが空である。

• Body.Payload プロパティに生のデータが含まれている。

要求メッセージにデータが含まれている (Body.Data が空でない) 場合、Body.Payload に生のデータが含まれている場合にのみ、プロパティが true になります。

応答メッセージでは、HTTPOptions.SavePayload プロパティを true に設定する場合にのみ、ペイロードが設定されます。

属性:

GetAccess	public
SetAccess	public
Transient	true

データ型: logical

メソッド

パブリック メソッド

addFields	メッセージ ヘッダーへのフィールドの追加
changeFields	メッセージ ヘッダーの既存フィールドの変更
getFields	名前またはクラスが一致するメッセージ ヘッダー フィールドを返す
removeFields	メッセージ ヘッダーからのフィールドの削除
replaceFields	メッセージ ヘッダーで値を変更またはフィールドを追加
show	書式設定されたバージョンのメッセージを表示または返す

特殊な演算子と関数

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

string	string としてのメッセージ Header、Body と StartLine プロパティ。複数のメッセージの場合、string 配列が返されます。 Body に文字に変換できないバイナリ データが含まれている場合、メソッドはデータの長さをバイト数で示すメッセージを表示します。 string は送信時または受信時のメッセージ表示の近似表現です。 ログ作成、診断、デバッグに使用します。 書式設定されたバージョンのメッセージの場合、show を使用します。
char	メッセージを文字ベクトルとして返すことを除いて、string と同じです。
isequal	2 つのメッセージ配列ですべてのメッセージの表示可能なパブリック プロパティが等しい場合は、true を返します。

ヒント

• 任意のヘッダーとデータを要求メッセージで送信するには、Completed プロパティを true に設定して send メソッドでメッセージが変更されないようにします。complete メソッドを使用すればメッセージを検証できますが、send メソッドはメッセージを検証しません。

バージョン履歴

R2016b で導入

参考

RequestMessage | ResponseMessage | MessageBody | ContentTypeField | HeaderField