HttpHeader Class Reference

In a http request and reply we need to process header information. With this API we can define and query the header information. The individual header lines are stored in a vector. This is the common functionality for the HttpRequest and HttpReplyHeader subclasses. More...

#include <HttpHeader.h>

Inheritance diagram for HttpHeader:

Public Member Functions
	HttpHeader ()
	~HttpHeader ()
HttpHeader &	clear ()
	clears the data
void	end ()
	release static temp buffer
const char *	get (const char *key)
List< HttpHeaderLine * > &	getHeaderLines ()
	Provides the http parameter lines.
bool	isChunked ()
bool	isRedirectStatus ()
	returns true if the status code is >=300 and < 400
bool	isValidStatus ()
	returns true if status code >=200 and < 300
MethodID	method ()
const char *	protocol ()
	Provide the protocol.
HttpHeader &	put (const char *key, const char *value)
HttpHeader &	put (const char *key, int value)
	adds a new line to the header - e.g. for content size
HttpHeader &	put (const char *line)
	adds a received new line to the header
bool	read (Client &in)
	reads the full header from the request (stream)
int	readLine (Client &in, char *str, int len)
bool	resize (size_t bufferSize)
	Resizes the internal read buffer.
void	setAutoCreateLines (bool is_auto_line)
	automatically create new lines
void	setProcessed ()
void	setProtocol (const char *protocal)
	Defines the protocol: e.g. HTTP/1.1.
void	setTimeout (int timeoutMs)
	Set the timout.
int	statusCode ()
const char *	statusMessage ()
const char *	urlPath ()
bool	write (Client &out)
	writes the full header to the indicated HttpStreamedMultiOutput stream
void	writeHeaderLine (Client &out, HttpHeaderLine &header)

Protected Member Functions
void	crlf (Client &out)
MethodID	getMethod (const char *line)
HttpHeaderLine *	headerLine (const char *key)
virtual void	parse1stLine (const char *line)=0
char *	tempBuffer ()
virtual bool	write1stLine (Client &out)=0

Protected Attributes
bool	create_new_lines = true
const char *	CRLF = "\r\n"
bool	is_chunked = false
bool	is_written = false
List< HttpHeaderLine * >	lines
MethodID	method_id
Str	protocol_str {10}
HttpLineReader	reader
int	status_code = HTTP_STATUS_UNDEFINED
Str	status_msg {20}
Vector< char >	temp_buffer {HTTP_MAX_LEN}
int	timeout_ms = URL_CLIENT_TIMEOUT
Str	url_path {70}

Detailed Description

In a http request and reply we need to process header information. With this API we can define and query the header information. The individual header lines are stored in a vector. This is the common functionality for the HttpRequest and HttpReplyHeader subclasses.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

HttpHeader()

HttpHeader ( )

inline

~HttpHeader()

~HttpHeader ( )

inline

Member Function Documentation

clear()

HttpHeader & clear ( )

inline

clears the data

crlf()

void crlf ( Client &  out )

inlineprotected

end()

void end ( )

inline

release static temp buffer

get()

const char * get ( const char *  key )

inline

getHeaderLines()

List< HttpHeaderLine * > & getHeaderLines ( )

inline

Provides the http parameter lines.

getMethod()

MethodID getMethod ( const char *  line )

inlineprotected

headerLine()

HttpHeaderLine * headerLine ( const char *  key )

inlineprotected

isChunked()

bool isChunked ( )

inline

isRedirectStatus()

bool isRedirectStatus ( )

inline

returns true if the status code is >=300 and < 400

isValidStatus()

bool isValidStatus ( )

inline

returns true if status code >=200 and < 300

method()

MethodID method ( )

inline

parse1stLine()

virtual void parse1stLine ( const char *  line )

protectedpure virtual

Implemented in HttpRequestHeader, and HttpReplyHeader.

protocol()

const char * protocol ( )

inline

Provide the protocol.

put() [1/3]

HttpHeader & put ( const char *  key, const char *  value  )

inline

put() [2/3]

HttpHeader & put ( const char *  key, int  value  )

inline

adds a new line to the header - e.g. for content size

put() [3/3]

HttpHeader & put ( const char *  line )

inline

adds a received new line to the header

read()

bool read ( Client &  in )

inline

reads the full header from the request (stream)

readLine()

int readLine ( Client &  in, char *  str, int  len  )

inline

resize()

bool resize ( size_t  bufferSize )

inline

Resizes the internal read buffer.

setAutoCreateLines()

void setAutoCreateLines ( bool  is_auto_line )

inline

automatically create new lines

setProcessed()

void setProcessed ( )

inline

setProtocol()

void setProtocol ( const char *  protocal )

inline

Defines the protocol: e.g. HTTP/1.1.

setTimeout()

void setTimeout ( int  timeoutMs )

inline

Set the timout.

statusCode()

int statusCode ( )

inline

statusMessage()

const char * statusMessage ( )

inline

tempBuffer()

char * tempBuffer ( )

inlineprotected

urlPath()

const char * urlPath ( )

inline

write()

bool write ( Client &  out )

inline

writes the full header to the indicated HttpStreamedMultiOutput stream

write1stLine()

virtual bool write1stLine ( Client &  out )

protectedpure virtual

Implemented in HttpRequestHeader, and HttpReplyHeader.

writeHeaderLine()

void writeHeaderLine ( Client &  out, HttpHeaderLine &  header  )

inline

Member Data Documentation

create_new_lines

bool create_new_lines = true

protected

CRLF

const char* CRLF = "\r\n"

protected

is_chunked

bool is_chunked = false

protected

is_written

bool is_written = false

protected

lines

List<HttpHeaderLine*> lines

protected

method_id

MethodID method_id

protected

protocol_str

Str protocol_str {10}

protected

reader

HttpLineReader reader

protected

status_code

int status_code = HTTP_STATUS_UNDEFINED

protected

status_msg

Str status_msg {20}

protected

temp_buffer

Vector<char> temp_buffer {HTTP_MAX_LEN}

protected

timeout_ms

int timeout_ms = URL_CLIENT_TIMEOUT

protected

url_path

Str url_path {70}

protected

---

The documentation for this class was generated from the following file:

• src/AudioTools/Communication/HTTP/HttpHeader.h