Fawkes API Fawkes Development Version
fawkes::DynamicFileWebReply Class Reference

Dynamic raw file transfer reply. More...

#include <>>

Inheritance diagram for fawkes::DynamicFileWebReply:

Public Member Functions

 DynamicFileWebReply (const std::string &filename, const std::string &content_type="")
 Constructor. More...
 
 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...
 
- Public Member Functions inherited from fawkes::DynamicWebReply
 DynamicWebReply (Code code)
 Constructor. More...
 
virtual size_t chunk_size ()
 Chunksize. More...
 
virtual size_t size ()=0
 Total size of the web reply. More...
 
virtual size_t next_chunk (size_t pos, char *buffer, size_t buf_max_size)=0
 Get data of next chunk. More...
 
- Public Member Functions inherited from fawkes::WebReply
 WebReply (Code code)
 Constructor. More...
 
virtual ~WebReply ()
 Destructor. More...
 
Code code () const
 Get response code. More...
 
void set_code (Code code)
 Set response code. More...
 
void add_header (const std::string &header, const std::string &content)
 Add a HTTP header. More...
 
void add_header (const std::string &header_string)
 Add a HTTP header. More...
 
const HeaderMapheaders () const
 get headers. More...
 
void set_caching (bool caching)
 Enable or disable caching for this specific reply. More...
 
void set_request (WebRequest *request)
 Set associated request. More...
 
WebRequestget_request () const
 Get associated request. More...
 
void pack_caching ()
 Called just before the reply is sent. More...
 

Additional Inherited Members

- Public Types inherited from fawkes::WebReply
enum  Code {
  HTTP_CONTINUE = 100 , HTTP_SWITCHING_PROTOCOLS = 101 , HTTP_PROCESSING = 102 , HTTP_OK = 200 ,
  HTTP_CREATED = 201 , HTTP_ACCEPTED = 202 , HTTP_NON_AUTHORITATIVE_INFORMATION = 203 , HTTP_NO_CONTENT = 204 ,
  HTTP_RESET_CONTENT = 205 , HTTP_PARTIAL_CONTENT = 206 , HTTP_MULTI_STATUS = 207 , HTTP_MULTIPLE_CHOICES = 300 ,
  HTTP_MOVED_PERMANENTLY = 301 , HTTP_FOUND = 302 , HTTP_SEE_OTHER = 303 , HTTP_NOT_MODIFIED = 304 ,
  HTTP_USE_PROXY = 305 , HTTP_SWITCH_PROXY = 306 , HTTP_TEMPORARY_REDIRECT = 307 , HTTP_BAD_REQUEST = 400 ,
  HTTP_UNAUTHORIZED = 401 , HTTP_PAYMENT_REQUIRED = 402 , HTTP_FORBIDDEN = 403 , HTTP_NOT_FOUND = 404 ,
  HTTP_METHOD_NOT_ALLOWED = 405 , HTTP_METHOD_NOT_ACCEPTABLE = 406 , HTTP_PROXY_AUTHENTICATION_REQUIRED = 407 , HTTP_REQUEST_TIMEOUT = 408 ,
  HTTP_CONFLICT = 409 , HTTP_GONE = 410 , HTTP_LENGTH_REQUIRED = 411 , HTTP_PRECONDITION_FAILED = 412 ,
  HTTP_REQUEST_ENTITY_TOO_LARGE = 413 , HTTP_REQUEST_URI_TOO_LONG = 414 , HTTP_UNSUPPORTED_MEDIA_TYPE = 415 , HTTP_REQUESTED_RANGE_NOT_SATISFIABLE = 416 ,
  HTTP_EXPECTATION_FAILED = 417 , HTTP_UNPROCESSABLE_ENTITY = 422 , HTTP_LOCKED = 423 , HTTP_FAILED_DEPENDENCY = 424 ,
  HTTP_UNORDERED_COLLECTION = 425 , HTTP_UPGRADE_REQUIRED = 426 , HTTP_RETRY_WITH = 449 , HTTP_INTERNAL_SERVER_ERROR = 500 ,
  HTTP_NOT_IMPLEMENTED = 501 , HTTP_BAD_GATEWAY = 502 , HTTP_SERVICE_UNAVAILABLE = 503 , HTTP_GATEWAY_TIMEOUT = 504 ,
  HTTP_HTTP_VERSION_NOT_SUPPORTED = 505 , HTTP_VARIANT_ALSO_NEGOTIATES = 506 , HTTP_INSUFFICIENT_STORAGE = 507 , HTTP_BANDWIDTH_LIMIT_EXCEEDED = 509 ,
  HTTP_NOT_EXTENDED = 510
}
 HTTP response code. More...
 
typedef std::map< std::string, std::string > HeaderMap
 Map of headers. More...
 
- Static Public Member Functions inherited from fawkes::WebReply
static void set_caching_default (bool caching)
 Enable or disable caching default for replies. More...
 

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 32 of file file_reply.h.

Constructor & Destructor Documentation

◆ DynamicFileWebReply() [1/3]

fawkes::DynamicFileWebReply::DynamicFileWebReply ( const std::string &  filename,
const std::string &  content_type = "" 
)

Constructor.

Parameters
filenamepath and name of the file to transmit
content_typecontent type of file, will try to guess by magic if not given

Definition at line 45 of file file_reply.cpp.

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

◆ DynamicFileWebReply() [2/3]

fawkes::DynamicFileWebReply::DynamicFileWebReply ( const char *  filename)

Constructor.

Parameters
filenamepath and name of the file to transmit

Definition at line 65 of file file_reply.cpp.

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

◆ DynamicFileWebReply() [3/3]

fawkes::DynamicFileWebReply::DynamicFileWebReply ( FILE *  file,
bool  close_when_done = true 
)

Constructor.

Parameters
filefile handle of file to transmit
close_when_donetrue to close file after transmission is completed

Definition at line 81 of file file_reply.cpp.

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

◆ ~DynamicFileWebReply()

fawkes::DynamicFileWebReply::~DynamicFileWebReply ( )
virtual

Destructor.

Definition at line 94 of file file_reply.cpp.

Member Function Documentation

◆ next_chunk()

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

Get data of next chunk.

Parameters
posposition in the stream. Note that a certain position may be called several times.
bufferbuffer to store data in
buf_max_sizemaximum 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 120 of file file_reply.cpp.

◆ size()

size_t fawkes::DynamicFileWebReply::size ( )
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!

Returns
total size of reply in bytes

Implements fawkes::DynamicWebReply.

Definition at line 114 of file file_reply.cpp.


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