Fawkes API Fawkes Development Version
fawkes::WebviewRestException Class Reference

REST processing exception. More...

#include <rest_api.h>

Inheritance diagram for fawkes::WebviewRestException:

Public Member Functions

 WebviewRestException (WebReply::Code code, const char *format,...)
 Constructor. More...
 
template<typename T , typename = std::enable_if_t<std::is_class<T>::value>>
 WebviewRestException (WebReply::Code code, const T &o, bool pretty=false)
 Constructor. More...
 
WebReply::Code code ()
 Get HTTP response code. More...
 
const std::string & content_type () const
 Get content type of response. More...
 
- Public Member Functions inherited from fawkes::Exception
 Exception (const char *format,...) noexcept
 Constructor. More...
 
 Exception (int errnoval, const char *format,...) noexcept
 Constructor. More...
 
 Exception (const Exception &exc) noexcept
 Copy constructor. More...
 
virtual ~Exception () noexcept
 Destructor. More...
 
virtual void raise ()
 This can be used to throw this exception. More...
 
void prepend (const char *format,...) noexcept
 Prepend messages to the message list. More...
 
void append (const char *format,...) noexcept
 Append messages to the message list. More...
 
void append_va (const char *format, va_list va) noexcept
 Append messages to the message list. More...
 
void append (const Exception &e) noexcept
 Append message that are from another Exception. More...
 
void print_trace () noexcept
 Prints trace to stderr. More...
 
void print_backtrace () const noexcept
 Prints a backtrace. More...
 
char * generate_backtrace () const noexcept
 Generate backtrace string. More...
 
int get_errno () noexcept
 Get errno. More...
 
void set_type_id (const char *id)
 Set exception type ID. More...
 
const char * type_id () const
 Get type ID. More...
 
virtual const char * what () const noexcept
 Get primary string. More...
 
virtual const char * what_no_backtrace () const noexcept
 Get primary string (does not implicitly print the back trace). More...
 
Exceptionoperator= (const Exception &exc) noexcept
 Assign an Exception. More...
 
iterator begin () noexcept
 Get iterator for messages. More...
 
iterator end () noexcept
 Get end iterator for messages. More...
 

Additional Inherited Members

- Protected Member Functions inherited from fawkes::Exception
 Exception () noexcept
 Constructor for subclasses. More...
 
void append_nolock (const char *format,...) noexcept
 Append messages without lock. More...
 
void append_nolock_va (const char *format, va_list va) noexcept
 Append messages without lock by formatted string. More...
 
void append_nolock_nocopy (char *msg) noexcept
 Append message without copying. More...
 
void prepend_nolock_va (const char *format, va_list va) noexcept
 Prepend messages without lock by formatted string. More...
 
void copy_messages (const Exception &exc) noexcept
 Copy messages from given exception. More...
 
- Protected Attributes inherited from fawkes::Exception
message_list_tmessages
 List of messages. More...
 
message_list_tmessages_iterator
 Iterator to iterate over messages. More...
 
message_list_tmessages_end
 Pointer that points to the very last message. More...
 
Mutexmessages_mutex
 Mutex to protect operations on messages list. More...
 
int _errno
 Error number, should be used if the error was caused by a method that supplies errno. More...
 

Detailed Description

REST processing exception.

Use to indicate failure with more specific response. The HTTP code will be used for the static response with the formatted error message.

Author
Tim Niemueller

Definition at line 70 of file rest_api.h.

Constructor & Destructor Documentation

◆ WebviewRestException() [1/2]

fawkes::WebviewRestException::WebviewRestException ( WebReply::Code  code,
const char *  format,
  ... 
)
inlineexplicit

Constructor.

Parameters
codeHTTP response code
formatformat string for error message (cf. printf)

Definition at line 77 of file rest_api.h.

References fawkes::Exception::append_va().

◆ WebviewRestException() [2/2]

template<typename T , typename = std::enable_if_t<std::is_class<T>::value>>
fawkes::WebviewRestException::WebviewRestException ( WebReply::Code  code,
const T &  o,
bool  pretty = false 
)
inline

Constructor.

Parameters
codeHTTP response code
oObject to convert to JSON
prettytrue to enable pretty printing of the JSON input

Definition at line 92 of file rest_api.h.

References fawkes::Exception::append().

Member Function Documentation

◆ code()

WebReply::Code fawkes::WebviewRestException::code ( )
inline

Get HTTP response code.

Returns
HTTP response code

Definition at line 102 of file rest_api.h.

Referenced by fawkes::WebviewRestApi::add_handler().

◆ content_type()

const std::string & fawkes::WebviewRestException::content_type ( ) const
inline

Get content type of response.

Returns
HTTP content type

Definition at line 111 of file rest_api.h.

Referenced by fawkes::WebviewRestApi::add_handler().


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