Main Content

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

matlab.net.http.io.FileProvider 类

命名空间: matlab.net.http.io
超类: matlab.net.http.io.ContentProvider, matlab.mixin.Copyable

用来发送文件的 ContentProvider

描述

使用 FileProvider 对象是向服务器发送一个或多个文件的便捷方式。

matlab.net.http.io.FileProvider 类是一个 handle 类。

创建对象

描述

providers = FileProvider(files) 构造一个 FileProviders 数组,每个提供程序对应于 files 数组中的一个文件。每个条目向服务器发送一个文件。

要在到达文件末尾之前终止文件传输,请将 FileSize 属性设置为所需的字节数。要根据正在读取的文件内容决定结束传输的位置,请编写一个子类,覆盖 getData 以检查正在读取的数据,并设置 stop 返回值以结束传输。

providers = FileProvider(files,permission,machineformat,encoding) 指定打开文件的选项。

providers = FileProvider(fileIds) 构造由文件标识符指定的 FileProviders。这些文件是从当前文件位置指示符开始读取到文件末尾。传输完成后,文件标识符不会关闭。如果文件已打开,或者您只想传输文件的结尾部分,则此方法非常有用。要实现此目的,请打开文件,将文件位置指示符设置为文件中要传输的数据的起始位置,然后将该文件标识符传递给此构造函数。您也可以设置 FileSize 来限制总字节数,或者编写一个子类来控制何时结束传输。

输入参数

全部展开

一个或多个文件名,指定为字符串、字符串数组、字符向量或字符向量元胞数组。有关文件名用法的详细信息,请参阅 fopen

数据类型: char | string

文件访问类型,指定为字符串。如果指定 permission,则它必须允许写访问。默认值为 'w+',它会打开或创建一个文件进行读取和写入,并丢弃现有内容(如果有)。

数据类型: char | string

读取或写入字节或位的顺序,指定为 fopen 函数允许的任何值。

数据类型: char | string

字符编码,指定为 fopen 函数允许的任何值。

数据类型: char | string

一个或多个文件标识符,指定为双精度值或双精度值数组。

属性

全部展开

公共属性

文件的完整路径,根据输入参数得出,指定为字符串。

属性:

GetAccess
public
SetAccess
public
Dependent
true

要传输的字节数,指定为双精度值。

属性:

GetAccess
public
SetAccess
public

要发送的请求消息,指定为 matlab.net.http.RequestMessage 对象。

此属性仅由子类编写者使用。在调用此使用程序中的其他方法之前,以及在添加其他标头字段或验证消息之前,RequestMessage.sendRequestMessage.complete 方法将此属性设置为此提供程序原来所在的 BodyRequestMessage。提供程序可以检查此消息,以查看原始请求中包含的内容。

代理与委托方看到的此属性值是相同的。ContentProviders 应该明白,如果它们是代理,则不一定提供请求消息的完整主体,因此不应该假定此 Request 中的标头字段与它们提供的数据相关。通常,代理应忽略此请求中与数据相关的标头字段,例如 Content-Type。

如果提供程序希望为此消息添加任何标头字段或修改现有标头字段,应在其 complete 方法中将这些字段添加到 Header 属性中。complete 的调用方(RequestMessage 或委托方提供程序)决定如何处理这些字段。RequestMessage.sendRequestMessage.complete 始终将这些字段复制到 RequestMessageHeader 中。委托方提供程序可将这些字段复制到自己的 Header 属性中,或者将它们插入到消息中(就像在 MultipartProvider 中那样)。有关详细信息,请参阅 Header 属性。

此属性是只读的。

属性:

GetAccesspublic
SetAccessmatlab.net.http.RequestMessage

消息或组成部分的标头字段,指定为由一个或多个 matlab.net.http.HeaderField 对象组成的向量。

此属性仅供子类编写者使用。MATLAB® 在调用提供程序的 complete 方法之前设置此属性。对于非 Multipart 消息,MATLAB 将此属性初始化为 Request.Header 的内容减去任何 matlab.net.http.field.GenericFields 或空值字段。ContentProvider 使用此属性添加对要发送数据进行描述的标头字段,或者向消息中已有的标头字段中添加参数。在 MultipartProvider 的代理中,MATLAB 将此属性初始化为委托方提供程序打算为该部分插入的标头字段。代理可以修改或更改这些字段。

从提供程序的 complete 方法返回时,如果这不是 Multipart 消息,则 MATLAB 会读取此属性并将其内容与 Request 的标头合并。此 HeaderNames 未出现在 Request.Header 中的字段将被添加到 Request.Header 的末尾。如果此 Header 中的某个字段与 Request.Header 中的某个字段具有相同的 Name,而且都具有非空 Values,则:

  • 如果 Request.Header 中的字段是 GenericField,则忽略 Header 中的字段。

  • 如果 Request.Header 中的字段不是 GenericField,则将其替换为 Header 中的字段。

如果两个字段或其中之一具有空 Value,则将该字段从 Request.Header 中删除,且不会添加为正常的完整消息的一部分。

如果这是 MultipartProvider 的代理,则将此 Header 的全部内容用作该部分的标头。Multipart 代理绝不能假定 Request.Header 包含的任何字段与自己的 Header 相关。提供程序可以通过检查 MyDelegator 是否为 MultipartProvider 来确定它是否为 Multipart 代理,尽管需要进行这种检验的可能性并不大。

MATLAB 仅在调用提供程序的 complete 方法返回时读取此属性。一旦 MATLAB 调用 start,对此数组所做的更改将被忽略。

类编写者应该明白,在超类中调用 complete 之前,子类可能已经向此 Header 中添加字段(在子类的 complete 方法中)。最好保留这些字段,而且不要添加同名字段。但是,为字段添加参数是可以的。例如,超类可以为没有字符集参数的现有 Content-Type 字段添加一个字符集参数。

属性:

GetAccess
public
SetAccess
public

指示是否强制进行分块传输编码,指定为布尔值。此属性仅对子类编写者有用,并且仅适用于不是作为 Multipart 代理的提供程序。子类通过设置 ForceChunked 来控制是否应使用分块传输编码发送内容。如果为 false(默认值),MATLAB 将根据消息待发送时是否了解消息的内容长度来决定是否发送分块内容:

  • 如果 MATLAB 知道内容长度(例如,消息中包含 Content-Length 字段,或者此提供程序的 expectedContentLength 方法返回一个数字),则由 MATLAB 决定是否发送分块消息。

  • 如果 MATLAB 不知道内容长度(标头中没有 Content-Length 字段而且 expectedContentLength 返回空),则 MATLAB 始终发送分块消息。

如果 ForceChunkedtrue,则无论 MATLAB 是否知道内容长度都会发送分块消息,除非已知长度小于块大小。如果此属性为 true,则消息中不能包含 Content-Length 字段,因为 HTTP 不允许分块消息具有 Content-Length 字段。但是,如果您希望 MATLAB 验证您返回的是预期的数据长度,则仍可以在 expectedContentLength 方法中返回非零值。

当 MATLAB 选择发送分块消息时,每个块的大小等于 getData 返回的数据长度。

MATLAB 在调用 complete 方法之后、调用 start 之前读取此值。它不会设置此字段。

属性:

GetAccess
public
SetAccess
public

受保护的属性

接受此提供程序委托的 ContentProvider,指定为 matlab.net.http.io.ContentProvider 对象。此属性在调用方提供程序(委托方)中由 delegateTo 方法设置,以指示当前接受委托的提供程序。如果当前没有委托,则此值为空。

complete 方法将此属性设置为空。

属性:

GetAccess
protected
SetAccess
protected

向此提供程序进行委托的 ContentProvider,指定为 matlab.net.http.io.ContentProvider 对象。

如果 ContentProvider 将发送全部或部分消息数据的责任委托给另一个提供程序,则此属性向代理标识委托方提供程序。例如,MultipartProvider 将消息的各个部分委托给其他提供程序,因此它会在每个代理中插入自己的句柄。否则,MyDelegator 为空。delegateTo 方法在代理中设置此属性。

属性:

GetAccess
protected
SetAccess
protected

方法

全部展开

详细信息

全部展开

版本历史记录

在 R2018a 中推出