matlab.net.http.field.ContentLengthField Class

Namespace: matlab.net.http.field
Superclasses: matlab.net.http.HeaderField, matlab.net.http.field.IntegerField

HTTP Content-Length field

Description

A ContentLengthField object is an HTTP header field in a request or a response message that specifies the length of the payload in bytes.

MATLAB^® requires all outbound messages with a payload to contain a Content-Length field. If a message contains a nonempty body, then MATLAB creates a Content-Length field based on the length of the data. However, for chunked data transfers, no field is added. For more information, see RFC 7231, section 3.3.2. Content-Length on the RFC Editor website.

Response messages might or might not contain this field.

Class Attributes

Sealed

true

For information on class attributes, see Class Attributes.

Creation

Description

obj = matlab.net.http.field.ContentLengthField(value) creates a Content-Length header field with the Value property set to value.

Properties

Name — Header field name

'Content-Length'

Header field name, specified as 'Content-Length'.

Attributes:

GetAccess	public
SetAccess	public

Value — Length of payload

nonnegative integer | string

Length of payload in bytes, specified as a nonnegative integer or a string that evaluates to a nonnegative integer.

Attributes:

GetAccess	public
SetAccess	public
Dependent	true

Methods

Public Methods

addFields	Add fields to HeaderField array
removeFields	Remove fields from header field array
changeFields	Change existing values in HeaderField array
replaceFields	Change values in or add fields to array of HeaderFields
getFields	Return header fields matching name or class
eq	Compare two HeaderField arrays
convertLike	Convert header field value like another header field
parse	Parse header field value and return as strings
displaySubclasses	Display supported HeaderField subclasses

Specialized for Subclass

convert

Return Value property of ContentLengthField as integer of type double

Specialized Operators and Functions

These methods specialize standard MATLAB operators and functions for objects in this class.

isequal	true if two header field arrays are the same size and corresponding elements are equal, as described by eq method
string	Array of header fields as string, as it appears in a message. Inserts newline characters between fields but not at the end of all fields.
char	Array of header fields as character vector, as described by string method

Examples

Display Message Payload Length

This example shows how to read the Content-Length field in a message.

import matlab.net.*;
import matlab.net.http.*;

httpsUrl = 'https://requestserver.mathworks.com';
uri = URI(strcat(httpsUrl, '/assets/computerVision.jpg'));
req = RequestMessage('GET');
response = req.send(uri);
contentLengthField = response.getFields("Content-Length");
disp(contentLengthField)

  ContentLengthField with properties:

     Name: "Content-Length"
    Value: "102297"

Version History

Introduced in R2016b