fawkes::DynamicFileWebReply Class Reference

Dynamic raw file transfer reply. More...

#include <>>

Inheritance diagram for fawkes::DynamicFileWebReply:

List of all members.

Public Member Functions
	DynamicFileWebReply (const char *filename)
	Constructor.
virtual	~DynamicFileWebReply ()
	Destructor.
virtual size_t	size ()
	Total size of the web reply.
virtual size_t	next_chunk (size_t pos, char *buffer, size_t buf_max_size)
	Get data of next chunk.
Public Member Functions inherited from fawkes::DynamicWebReply
	DynamicWebReply (response_code_t code)
	Constructor.
virtual size_t	chunk_size ()
	Chunksize.
Public Member Functions inherited from fawkes::WebReply
	WebReply (response_code_t code)
	Constructor.
virtual	~WebReply ()
	Destructor.
response_code_t	code () const
	Get response code.
void	add_header (std::string header, std::string content)
	Add a HTTP header.
void	add_header (std::string header_string)
	Add a HTTP header.
const HeaderMap &	headers () const
	get headers.

---

Detailed Description

Dynamic raw file transfer reply.

This dynamic file transfer reply transmits the given file with a mime type determined with libmagic.

Author:

Tim Niemueller

Definition at line 34 of file file_reply.h.

---

Constructor & Destructor Documentation

fawkes::DynamicFileWebReply::DynamicFileWebReply

(

const char *

filename

)

Constructor.

Parameters:

filename

path and name of the file to transmit

Definition at line 47 of file file_reply.cpp.

References fawkes::WebReply::add_header(), and fawkes::mimetype_file().

fawkes::DynamicFileWebReply::~DynamicFileWebReply ( )

virtual

Destructor.

Definition at line 66 of file file_reply.cpp.

---

Member Function Documentation

size_t fawkes::DynamicFileWebReply::next_chunk ( size_t  pos, char *  buffer, size_t  buf_max_size  )

virtual

Get data of next chunk.

Parameters:

pos	position in the stream. Note that a certain position may be called several times.
buffer	buffer to store data in
buf_max_size	maximum size in bytes of data that can be put into buffer

Returns:

number of bytes written to buffer, or -1 to immediately stop the transfer.

Implements fawkes::DynamicWebReply.

Definition at line 78 of file file_reply.cpp.

size_t fawkes::DynamicFileWebReply::size ( )

virtual

Total size of the web reply.

Return the total size of the reply if known, or 0 if it is not known. In the latter case your next_chunk() method has to return -1 at some point to end the transfer. If possible by any means return a meaningful value, as it will improve the experience of users, especially for long transfers!

Returns:

total size of reply in bytes

Implements fawkes::DynamicWebReply.

Definition at line 72 of file file_reply.cpp.

---

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

• src/libs/webview/file_reply.h
• src/libs/webview/file_reply.cpp