本页翻译不是最新的。点击此处可查看最新英文版本。

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	消息的 Header、Body 和 StartLine 属性，以字符串形式返回。对于多条消息，返回一个字符串数组。 如果 Body 包含不能转换为字符的二进制数据，此方法将显示指示数据长度（以字节为单位）的消息。 字符串近似表示了消息在发送或接收时的形式。 用于日志记录、诊断或调试。 要获取格式化版本的消息，请使用 show。
char	与 string 基本相同，只是以字符向量形式返回消息。
isequal	如果两个消息数组中所有消息的可见公共属性相等，则返回 true。

提示

• 要在请求消息中发送任意标头和数据，请将 Completed 属性设置为 true，以防止 send 方法修改消息。您仍然可以使用 complete 方法来验证消息，但 send 方法不会验证消息。

版本历史记录

在 R2016b 中推出

另请参阅

RequestMessage | ResponseMessage | MessageBody | ContentTypeField | HeaderField