Range header.

The Range header is used to GET one or more sub-ranges of an entity instead of the entire entity. More...

Defines
#define	HTTP_RANGE_INIT()
	Initializer for structure http_range_t.
#define	HTTPTAG_RANGE(x)
	Tag list item for pointer to a Range header object.
#define	HTTPTAG_RANGE_STR(s)
	Tag list item for string with Range header value.
Typedefs
typedef struct http_range_s	http_range_t
	The structure http_range_t contains representation of Range header.
Enumerations
enum	{ http_range_hash }
Functions
http_range_t *	http_range_init (http_range_t x[1])
	Initialize a structure http_range_t.
int	http_is_range (http_header_t const *header)
	Test if header object is instance of http_range_t.
http_range_t *	http_range_dup (su_home_t *home, http_range_t const *hdr))
	Duplicate (deep copy) http_range_t.
http_range_t *	http_range_copy (su_home_t *home, http_range_t const *hdr))
	Copy a http_range_t header structure.
http_range_t *	http_range_make (su_home_t *home, char const *s))
	Make a header structure http_range_t.
http_range_t *	http_range_format (su_home_t *home, char const *fmt,...)))
	Make a Range header from formatting result.
Variables
msg_hclass_t	http_range_class []
	Header class for HTTP Range header.
msg_parse_f	http_range_d
	Decode (parse) a Range header.
msg_print_f	http_range_e
	Encode (print) a Range header.

---

Detailed Description

The Range header is used to GET one or more sub-ranges of an entity instead of the entire entity.

Its syntax is defined in RFC 2616 section 14.35 as follows:

    Range = "Range" ":" ranges-specifier
    ranges-specifier = byte-ranges-specifier
    byte-ranges-specifier = bytes-unit "=" byte-range-set
    byte-range-set  = 1#( byte-range-spec | suffix-byte-range-spec )
    byte-range-spec = first-byte-pos "-" [last-byte-pos]
    first-byte-pos  = 1*DIGIT
    last-byte-pos   = 1*DIGIT

---

Define Documentation

#define HTTP_RANGE_INIT

(

)

Initializer for structure http_range_t.

A static http_range_t structure must be initialized with the HTTP_RANGE_INIT() macro. For instance,

  http_range_t http_range = HTTP_RANGE_INIT;

#define HTTPTAG_RANGE

(

x

)

Tag list item for pointer to a Range header object.

The HTTPTAG_RANGE() macro is used to include a tag item with a pointer to a http_range_t object in a tag list.

Parameters:

x

pointer to a http_range_t header structure, or NULL.

#define HTTPTAG_RANGE_STR

(

s

)

Tag list item for string with Range header value.

The HTTPTAG_RANGE_STR() macro is used to include a tag item with a string containing value of a http_range_t header in a tag list.

Parameters:

s

pointer to a string containing http_range_t value, or NULL.

The HTTPTAG_RANGE_STR string can be converted to a http_range_t header structure by giving the string s has second argument to function http_range_make().

---

Typedef Documentation

typedef struct http_range_s http_range_t

The structure http_range_t contains representation of Range header.

The http_range_t is defined as follows:

 typedef struct http_range_s
 {
   msg_common_t         rng_common[1];
   msg_error_t         *rng_next;
   char const          *rng_unit;
   char const  * const *rng_specs;
 } http_range_t;

---

Enumeration Type Documentation

anonymous enum

Enumerator:

http_range_hash

Hash of Range header.

---

Function Documentation

int http_is_range

(

http_header_t const *

header

)

[inline]

Test if header object is instance of http_range_t.

The function http_is_range() returns true (nonzero) if the header class is an instance of Range header object and false (zero) otherwise.

Parameters:

header

pointer to the header structure to be tested

Returns:

The function http_is_xrange() returns true (nonzero) if the header object is an instance of header range and false (zero) otherwise.

http_range_t * http_range_copy	(	su_home_t *	home,
		http_range_t const *	hdr
	)			[inline]

Copy a http_range_t header structure.

The function http_range_copy() copies a header structure hdr. If the header structure hdr contains a reference (hdr->h_next) to a list of headers, all the headers in that list are copied, too. The function uses given memory home to allocate all the memory areas used to copy the header structure hdr.

Parameters:

	home	memory home used to allocate new structure
	hdr	pointer to the header structure to be duplicated

When copying, only the header structure and parameter lists attached to it are duplicated. The new header structure retains all the references to the strings within the old header, including the encoding of the old header, if present.

Example

   range = http_range_copy(home, http->http_range);

Returns:

The function http_range_copy() returns a pointer to newly copied header structure, or NULL upon an error.

http_range_t * http_range_dup	(	su_home_t *	home,
		http_range_t const *	hdr
	)			[inline]

Duplicate (deep copy) http_range_t.

The function http_range_dup() duplicates a header structure hdr. If the header structure hdr contains a reference (hdr->x_next) to a list of headers, all the headers in the list are duplicated, too.

Parameters:

	home	memory home used to allocate new structure
	hdr	header structure to be duplicated

When duplicating, all parameter lists and non-constant strings attached to the header are copied, too. The function uses given memory home to allocate all the memory areas used to copy the header.

Example

   range = http_range_dup(home, http->http_range);

Returns:

The function http_range_dup() returns a pointer to the newly duplicated http_range_t header structure, or NULL upon an error.

http_range_t * http_range_format	(	su_home_t *	home,
		char const *	fmt,
			...
	)			[inline]

Make a Range header from formatting result.

The function http_range_format() makes a new Range header object using formatting result as its value. The function first prints the arguments according to the format fmt specified. Then it allocates a new header structure, and uses the formatting result as the header value.

Parameters:

	home	memory home used to allocate new header structure.
	fmt	string used as a printf()-style format
	...	argument list for format

Note:

This function is usually implemented as a macro calling msg_header_format().

Returns:

The function http_range_format() returns a pointer to newly makes header structure, or NULL upon an error.

http_range_t* http_range_init

(

http_range_t

x[1]

)

[inline]

Initialize a structure http_range_t.

An http_range_t structure can be initialized with the http_range_init() function/macro. For instance,

  http_range_t http_range;

  http_range_init(&http_range);

http_range_t * http_range_make	(	su_home_t *	home,
		char const *	s
	)			[inline]

Make a header structure http_range_t.

The function http_range_make() makes a new http_range_t header structure. It allocates a new header structure, and decodes the string s as the value of the structure.

Parameters:

	home	memory home used to allocate new header structure.
	s	string to be decoded as value of the new header structure

Note:

This function is usually implemented as a macro calling http_header_make().

Returns:

The function http_range_make() returns a pointer to newly maked http_range_t header structure, or NULL upon an error.

---

Variable Documentation

msg_hclass_t http_range_class[]

Header class for HTTP Range header.

The header class http_range_class defines how a HTTP Range header is parsed and printed. It also contains methods used by HTTP parser and other functions to manipulate the http_range_t header structure.