主要内容

matlab.net.http.io.StringConsumer类

包:matlab.net.http.io
超类:matlab.net.http.io.ContentConsumer

字符串消费者对于HTTP负载

描述

一个StringConsumer将字符数据存储在一个响应消息,根据字符集解码内容类型的基础上,在身体的反应。您可以指定这个消费者直接发送RequestMessage指定一个字符串转换为数据与某些参数。

这种消费者子类化一个例子,看到PricesStreamer显示流媒体数据在图窗口

matlab.net.http.io.StringConsumer类是一个处理类。

创建

描述

消费者= StringConsumer构造一个消费者将输入转换为一个标量字符串中指定的字符集使用消息的内容类型。

消费者= StringConsumer (名称,值)构造一个与选项指定一个或多个消费者名称,值对参数。的名字是属性名字符集TextType价值相应的价值。您可以指定名称-值对参数在任何顺序Name1 Value1, Name2 Value2

如果你不指定一个字符集属性,那么这个消费者试图推导的字符集ContentType属性,MATLAB®基于content - type字段的设置响应StringConsumer知道字符集如果ContentType有一个明确的字符集参数,或如果它是一个类型的MATLAB知道默认的字符集:

  • “text / *”- - - - - - us - ascii或utf - 8根据亚型。

  • “应用程序/ *”亚型,utf - 8: json、xml、javascript、css, x-www-form-urlencoded;否则未知。

如果消费者无法确定的字符集ContentType在消息,那么这个消费者拒绝消息并没有转换。在这种情况下,ResponseMessage.Body只包含uint8载荷。如果你想和一个未知的字符集转换消息,然后设置字符集在这个消费者之前将它应用于一个消息(或者,如果你是作家,一个子类调用之前初始化方法)。一个好的使用utf - 8,因为是us - ascii和一些其他数据集的超集。

属性

全部展开

公共属性

使用的字符集转换数据,指定为一个字符串。这个值最初是空的。如果你把它空,则设置该值,当接收到消息后,根据指定的或默认的字符集的content - type字段信息。如果你想使用不同的字符集转换,然后你可以通过指定的字符集StringConsumer构造函数,或直接设置这个属性。子类可以设置这个属性在任何时间,包括中间的一条消息。如果你改变这个值后调用putData,然后在后续的调用中使用新值putData。现有的内容Response.Body.Data是没有改变。

当收到一个响应开始,如果这个属性最初是空,然后用MATLAB将这个属性设置为基于content - type选择字符集。如果你重用这个消费者不同的消息,然后可以选择一个新的字符集。如果将此属性设置为一个非空的值,MATLAB从不改变。

属性:

GetAccess
公共
SetAccess
公共
依赖
真正的

返回的数据类型,指定为“字符串”“字符”。的值是“TextType”参数的构造函数。默认设置是“string”。如果你改变这个值后数据已经存储在Response.Body.Data,那么数据转化为新类型。

属性:

GetAccess
公共
SetAccess
公共
依赖
真正的

显示缓冲区大小,指定为uint64。MATLAB集AllocationLength预期大小的缓冲区的数据传递给putData。实际的大小可能会更小或更大。为了提高性能,消费者可以使用这个值来preallocate空间来处理数据。

MATLAB调用之前设置这个属性开始为方便子类的方法。

属性:

GetAccess
公共
SetAccess
公共

预期负载长度指定为uint64。房地产通常是价值财产的matlab.net.http.field.ContentLengthField财产。

如果ContentLength是空的,那么长度是未知的。负载结束时putData (uint8.empty)被称为。

MATLAB调用之前设置这个属性初始化,为方便子类可能受益于知道数据的长度。

如果这ContentConsumer为代表的顶级消费者,那么的价值呢ContentLength可能是不同的ContentLength顶级消费者的价值。

例子:元素个数(someData)在哪里someData是类型uint8

属性:

GetAccess
公共
SetAccess
公共

媒体类型的负载,指定为一个matlab.net.http.MediaType对象。房地产通常是价值财产的matlab.net.http.field.ContentTypeField财产。如果ContentType属性是空的,那么ContentTypeField为空或不存在。

MATLAB调用之前设置这个属性初始化为方便子类可能想检查MediaType。子类可以设置这个属性,如果他们决定从数据是不同的MediaType

的转让、MATLAB这个值复制到Response.Body.ContentType财产。

例子:的应用程序/八进制

属性:

GetAccess
公共
SetAccess
公共

头目前正在处理的有效载荷,指定为一个matlab.net.http.HeaderField对象。

消费者使用这个头来决定如何处理的有效负载发送到他们。对于一个顶级消费者,这个值是一样的Response.Header。对于一个委托,价值可能有所不同。例如,在一个多部分消息处理MultipartConsumer,它的头是这一部分委托处理。委托仍然可以检查Response.Header原始消息的标题。

MATLAB调用之前设置这个属性初始化,为方便子类。

属性:

GetAccess
公共
SetAccess
公共

完成的RequestMessage被指定为一个matlab.net.http.RequestMessage对象。这是最后的RequestMessage毕竟重定向,即completedrequest返回值的发送方法。

MATLAB调用之前设置这个属性初始化,为方便子类。

属性:

GetAccess
公共
SetAccess
公共

ResponseMessage正在处理,指定为一个matlab.net.http.ResponseMessage对象。

MATLAB设置响应财产之前调用初始化。的值是ResponseMessage头后收到了但是在接受任何负载。开始的时候响应消息处理(或多部分消息部分)的开始,ResponseMesssage.Body属性是一个MessageBody对象与空数据有效载荷属性。存储接收的数据,消费者可以修改响应MessageBody.Data在数据传输性能。通常,消费者这一过程,然后存储数据集Response.Body.Data处理负载,但这不是必需的。在完成转会,MATLAB返回响应给调用者的发送。消费者不应修改响应的属性,如状态栏,因为这些变化是返回给调用者发送

Response.Body.Payload属性是空的在转移和消费者不应该试图修改它。如果HTTPOptions.SavePayload属性设置,然后用MATLAB集有效载荷最后收到有效载荷的传递消息的或部分(后调用putData (uint8.empty))或当发生异常。

如果一个例外发生在消费者在消息处理,然后MATLAB抛出textbox对象。的历史属性包含这响应价值。

如果消费者是一个委托,处理多部分消息的一部分,Response.Header包含整个消息的标题,有效载荷数据的属性Response.Body调用前被清除ContentConsumer对于每一个部分。在每个部分的结论,一个新的ResponseMessage添加到数组的末尾的ResponseMessage在原始响应对象Body.Data包含从这个对象身体从这个属性。下一个委托看到新鲜响应空着MessageBody,而不是之前的委托MessageBody

属性:

GetAccess
公共
SetAccess
公共
依赖
真正的

目的地的请求正在处理,作为一个指定matlab.net.URI对象。这个值是由最初的目标URI发送。它不是一个代理的URI或重定向后的最终URI。

MATLAB调用之前设置这个属性初始化,为方便子类。

属性:

GetAccess
公共
SetAccess
公共

受保护的属性

处理函数,指定为一个函数,调用putData方法来添加额外的数据。的putData方法在这类调用AppendFcn函数接收的附加数据数据现有参数响应消息中的数据。函数必须有签名:

newdata AppendFcn(消费者)

在哪里newdata是要添加到数组的数据吗consumer.Response.Body.Data。这是这种方法更新的责任consumer.CurrentLength以反映新的长度数据。如果newdata结束为空,这表示流,那么函数应该更新Response.Body.Data其最终值。

默认的行为,如果这个属性为空,将使用一个内部函数数据一个数组的支持任意值万博1manbetxhorzcat函数。它有效地增加了newdata由preallocating空间,维护CurrentLength实际存储的数据的长度。最后的消息,它截断Response.Body.DataCurrentLength

子类可以更改此属性horzcat不适合添加过程。例如,当一个StringConsumer构建一个标量字符串,它将添加到字符串使用+函数来代替horzcat

不调用子类ContentConsumer.putData添加数据,或者感到满意horzcat行为附加数据时,可以忽略该属性。

例子:@customAppend在哪里@customAppend被定义为消费者

属性:

GetAccess
受保护的
SetAccess
受保护的

ContentConsumer这种消费者委托,作为指定matlab.net.http.io.ContentConsumer对象。的delegateTo方法的调用消费者(委托)设置CurrentDelegate财产。如果没有当前的代表团,值[]

MATLAB集CurrentDelegate[]在调用之前初始化

属性:

GetAccess
受保护的
SetAccess
受保护的

目前的数据长度Response.Body.Data属性,指定为uint64

此属性时使用Response.Body.Data被预先分配一个大小比实际当前存储的数据量大,显示存储的数据的长度。如果这个属性是空的,那么它意味着所有的Response.Body.Data包含,或者存储数据ContentConsumer子类是处理数据以某种方式以外的存储Response.Body.Data

使用这个属性和设置的putData在这个基类方法AppendFcn属性是空的。调用子类的好处putData和想要检查已数据,和/或任何的实现AppendFcn维护结果Response.Body.Data

子类使用putData也可以修改这个属性重置数据存储在缓冲区中的位置。例如,当默认值AppendFcn使用函数,处理所有的子类Response.Body.Data在每次调用putData可能不再有使用原始数据,所以它可以重置CurrentLength属性1,下一个putData使用新数据调用覆盖缓冲。不需要明确的元素在缓冲区的过去结束的新数据。

不调用子类putData可以使用这个属性来跟踪自己的数据,或者可以把它复原(空的)。MATLAB不发生任何限制的值可以设置和不使用它为任何目的除了确定默认AppendFcn应该存储下一个缓冲区的数据,截断数据的最后消息。将此属性设置为空之前最后的呼吁putData (uint8.empty)为了防止数据的截断。

MATLAB每次调用之前将此属性设置为空初始化

属性:

GetAccess
受保护的
SetAccess
受保护的

ContentConsumer委托给这个消费者,作为一个指定matlab.net.http.io.ContentConsumer对象。如果消费者是一个委托调用另一个消费者,例如GenericConsumerMultipartConsumer消费者,那么这就是调用。它是空的顶级消费者调用中指定发送

代表可以使用这个属性来访问属性有,例如,确定哪些消费者委托给他们。

属性:

GetAccess
受保护的
SetAccess
受保护的

方法

全部展开

更多关于

全部展开

介绍了R2018a