matlab.net.http.Message クラス

名前空間: matlab.net.http

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

このページをすべて展開する

説明

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

プロパティ

すべて展開する

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

属性:

GetAccess
public
SetAccess
public

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

属性:

GetAccess
public
SetAccess
public

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

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

属性:

GetAccess
public
SetAccess
public

メッセージが完了しているかどうか。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

メソッド

すべて展開する

ヒント

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

バージョン履歴

R2016b で導入

参考

| | | |