Fawkes API
Fawkes Development Version
|
Dynamic raw file transfer reply. More...
#include <>>
Public Member Functions | |
DynamicFileWebReply (const char *filename) | |
Constructor. More... | |
DynamicFileWebReply (FILE *file, bool close_when_done=true) | |
Constructor. More... | |
virtual | ~DynamicFileWebReply () |
Destructor. More... | |
virtual size_t | size () |
Total size of the web reply. More... | |
virtual size_t | next_chunk (size_t pos, char *buffer, size_t buf_max_size) |
Get data of next chunk. More... | |
![]() | |
DynamicWebReply (Code code) | |
Constructor. More... | |
virtual size_t | chunk_size () |
Chunksize. More... | |
![]() | |
WebReply (Code code) | |
Constructor. More... | |
virtual | ~WebReply () |
Destructor. More... | |
Code | code () const |
Get response code. More... | |
void | add_header (std::string header, std::string content) |
Add a HTTP header. More... | |
void | add_header (std::string header_string) |
Add a HTTP header. More... | |
const HeaderMap & | headers () const |
get headers. More... | |
void | set_request (WebRequest *request) |
Set associated request. More... | |
WebRequest * | get_request () const |
Get associated request. More... | |
Dynamic raw file transfer reply.
This dynamic file transfer reply transmits the given file with a mime type determined with libmagic.
Definition at line 34 of file file_reply.h.
fawkes::DynamicFileWebReply::DynamicFileWebReply | ( | const char * | filename | ) |
Constructor.
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 | ( | FILE * | file, |
bool | close_when_done = true |
||
) |
Constructor.
file | file handle of file to transmit |
close_when_done | true to close file after transmission is completed |
Definition at line 63 of file file_reply.cpp.
References fawkes::WebReply::add_header(), and fawkes::mimetype_file().
|
virtual |
Destructor.
Definition at line 76 of file file_reply.cpp.
|
virtual |
Get data of next chunk.
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 |
Implements fawkes::DynamicWebReply.
Definition at line 102 of file file_reply.cpp.
|
virtual |
Total size of the web reply.
Return the total size of the reply if known, or -1 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!
Implements fawkes::DynamicWebReply.
Definition at line 96 of file file_reply.cpp.