Arduino DLNA Server
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
tiny_dlna::HttpRequestHeader Class Reference

Reading and writing of Http Requests. More...

#include <HttpHeader.h>

Inheritance diagram for tiny_dlna::HttpRequestHeader:
Inheritance graph
[legend]

Public Member Functions

HttpHeadersetValues (TinyMethodID id, const char *urlPath, const char *protocol=nullptr)
 
void write1stLine (Client &out)
 
void parse1stLine (const char *line)
 
HttpHeaderclear (bool activeFlag=true)
 clears the data - usually we do not delete but we just set the active flag
 
HttpHeaderput (const char *key, const char *value)
 
HttpHeaderput (const char *key, int value)
 adds a new line to the header - e.g. for content size
 
HttpHeaderput (const char *line)
 adds a received new line to the header
 
const char * get (const char *key)
 
void readLine (Client &in, char *str, int len)
 
void writeHeaderLine (Client &out, HttpHeaderLine *header)
 
const char * urlPath ()
 
const char * protocol ()
 
TinyMethodID method ()
 
const char * accept ()
 
int statusCode ()
 
const char * statusMessage ()
 
bool isChunked ()
 
void read (Client &in)
 
void write (Client &out)
 
void setAutoCreateLines (bool is_auto_line)
 
bool isValidStatus ()
 returns true if status code >=200 and < 300
 
bool isRedirectStatus ()
 

Protected Member Functions

void crlf (Client &out)
 
HttpHeaderLineheaderLine (const char *key)
 
TinyMethodID getMethod (const char *line)
 

Protected Attributes

int status_code = T_UNDEFINED
 
bool is_written = false
 
bool is_chunked = false
 
bool create_new_lines = true
 
TinyMethodID method_id = T_GET
 
Str protocol_str = Str(10)
 
Str url_path = Str(70)
 
Str status_msg = Str(20)
 
List< HttpHeaderLine * > lines
 
HttpLineReader reader
 
const char * CRLF = "\r\n"
 

Detailed Description

Reading and writing of Http Requests.

Member Function Documentation

◆ accept()

const char * tiny_dlna::HttpHeader::accept ( )
inlineinherited

◆ clear()

HttpHeader & tiny_dlna::HttpHeader::clear ( bool  activeFlag = true)
inlineinherited

clears the data - usually we do not delete but we just set the active flag

◆ crlf()

void tiny_dlna::HttpHeader::crlf ( Client &  out)
inlineprotectedinherited

◆ get()

const char * tiny_dlna::HttpHeader::get ( const char *  key)
inlineinherited

◆ getMethod()

TinyMethodID tiny_dlna::HttpHeader::getMethod ( const char *  line)
inlineprotectedinherited

◆ headerLine()

HttpHeaderLine * tiny_dlna::HttpHeader::headerLine ( const char *  key)
inlineprotectedinherited

◆ isChunked()

bool tiny_dlna::HttpHeader::isChunked ( )
inlineinherited

◆ isRedirectStatus()

bool tiny_dlna::HttpHeader::isRedirectStatus ( )
inlineinherited

◆ isValidStatus()

bool tiny_dlna::HttpHeader::isValidStatus ( )
inlineinherited

returns true if status code >=200 and < 300

◆ method()

TinyMethodID tiny_dlna::HttpHeader::method ( )
inlineinherited

◆ parse1stLine()

void tiny_dlna::HttpRequestHeader::parse1stLine ( const char *  line)
inlinevirtual

Implements tiny_dlna::HttpHeader.

◆ protocol()

const char * tiny_dlna::HttpHeader::protocol ( )
inlineinherited

◆ put() [1/3]

HttpHeader & tiny_dlna::HttpHeader::put ( const char *  key,
const char *  value 
)
inlineinherited

◆ put() [2/3]

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

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

◆ put() [3/3]

HttpHeader & tiny_dlna::HttpHeader::put ( const char *  line)
inlineinherited

adds a received new line to the header

◆ read()

void tiny_dlna::HttpHeader::read ( Client &  in)
inlineinherited

◆ readLine()

void tiny_dlna::HttpHeader::readLine ( Client &  in,
char *  str,
int  len 
)
inlineinherited

◆ setAutoCreateLines()

void tiny_dlna::HttpHeader::setAutoCreateLines ( bool  is_auto_line)
inlineinherited

◆ setValues()

HttpHeader & tiny_dlna::HttpRequestHeader::setValues ( TinyMethodID  id,
const char *  urlPath,
const char *  protocol = nullptr 
)
inline

◆ statusCode()

int tiny_dlna::HttpHeader::statusCode ( )
inlineinherited

◆ statusMessage()

const char * tiny_dlna::HttpHeader::statusMessage ( )
inlineinherited

◆ urlPath()

const char * tiny_dlna::HttpHeader::urlPath ( )
inlineinherited

◆ write()

void tiny_dlna::HttpHeader::write ( Client &  out)
inlineinherited

◆ write1stLine()

void tiny_dlna::HttpRequestHeader::write1stLine ( Client &  out)
inlinevirtual

Implements tiny_dlna::HttpHeader.

◆ writeHeaderLine()

void tiny_dlna::HttpHeader::writeHeaderLine ( Client &  out,
HttpHeaderLine header 
)
inlineinherited

Member Data Documentation

◆ create_new_lines

bool tiny_dlna::HttpHeader::create_new_lines = true
protectedinherited

◆ CRLF

const char* tiny_dlna::HttpHeader::CRLF = "\r\n"
protectedinherited

◆ is_chunked

bool tiny_dlna::HttpHeader::is_chunked = false
protectedinherited

◆ is_written

bool tiny_dlna::HttpHeader::is_written = false
protectedinherited

◆ lines

List<HttpHeaderLine*> tiny_dlna::HttpHeader::lines
protectedinherited

◆ method_id

TinyMethodID tiny_dlna::HttpHeader::method_id = T_GET
protectedinherited

◆ protocol_str

Str tiny_dlna::HttpHeader::protocol_str = Str(10)
protectedinherited

◆ reader

HttpLineReader tiny_dlna::HttpHeader::reader
protectedinherited

◆ status_code

int tiny_dlna::HttpHeader::status_code = T_UNDEFINED
protectedinherited

◆ status_msg

Str tiny_dlna::HttpHeader::status_msg = Str(20)
protectedinherited

◆ url_path

Str tiny_dlna::HttpHeader::url_path = Str(70)
protectedinherited

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