crow Namespace Reference

Namespaces
	detail
	json
	multipart
	Encapsulates anything related to processing and organizing multipart/xyz messages.
	mustache
	websocket

Classes
class	BaseRule
	A base class for all rules. More...
class	Blueprint
	A blueprint can be considered a smaller section of a Crow app, specifically where the router is conecerned. More...
class	CatchallRule
class	CerrLogHandler
struct	ci_hash
	Hashing function for ci_map (unordered_multimap). More...
struct	ci_key_eq
	Equals function for ci_map (unordered_multimap). More...
class	Connection
	An HTTP connection. More...
struct	CookieParser
struct	CORSHandler
	CORSHandler is a global middleware for setting CORS headers. More...
struct	CORSRules
	Used for tuning CORS policies. More...
class	Crow
	The main server application. More...
class	DynamicRule
	A rule that can change its parameters during runtime. More...
struct	HTTPParser
	A wrapper for nodejs/http-parser. More...
struct	ILocalMiddleware
	Local middleware should extend ILocalMiddleware. More...
class	ILogHandler
class	logger
class	query_string
	A class to represent any data coming after the ? in the request URL into key-value pairs. More...
struct	request
	An HTTP request. More...
struct	response
	HTTP response. More...
struct	returnable
	An abstract class that allows any other class to be returned by a handler. More...
class	Router
	Handles matching requests to existing rules and upgrade requests. More...
struct	RuleParameterTraits
	Allows the user to assign parameters using functions. More...
class	Server
struct	SocketAdaptor
	A wrapper for the asio::ip::tcp::socket and asio::ssl::stream. More...
class	TaggedRule
	Default rule created when CROW_ROUTE is called. More...
class	Trie
	A search tree. More...
struct	UTF8
class	WebSocketRule
	A rule dealing with websockets. More...

Typedefs
template<typename... Middlewares>
using	App = Crow< Middlewares... >
using	SimpleApp = Crow<>
using	ci_map = std::unordered_multimap< std::string, std::string, ci_hash, ci_key_eq >
using	tcp = asio::ip::tcp

Enumerations
enum	HTTPMethod : char {   HTTPMethod::DELETE = 0,   HTTPMethod::GET,   HTTPMethod::HEAD,   HTTPMethod::POST,   HTTPMethod::PUT,   HTTPMethod::CONNECT,   HTTPMethod::OPTIONS,   HTTPMethod::TRACE,   HTTPMethod::PATCH,   HTTPMethod::PURGE,   HTTPMethod::COPY,   HTTPMethod::LOCK,   HTTPMethod::MKCOL,   HTTPMethod::MOVE,   HTTPMethod::PROPFIND,   HTTPMethod::PROPPATCH,   HTTPMethod::SEARCH,   HTTPMethod::UNLOCK,   HTTPMethod::BIND,   HTTPMethod::REBIND,   HTTPMethod::UNBIND,   HTTPMethod::ACL,   HTTPMethod::REPORT,   HTTPMethod::MKACTIVITY,   HTTPMethod::CHECKOUT,   HTTPMethod::MERGE,   HTTPMethod::MSEARCH,   HTTPMethod::NOTIFY,   HTTPMethod::SUBSCRIBE,   HTTPMethod::UNSUBSCRIBE,   HTTPMethod::MKCALENDAR,   HTTPMethod::LINK,   HTTPMethod::UNLINK,   HTTPMethod::SOURCE,   HTTPMethod::Delete = 0,   HTTPMethod::Get,   HTTPMethod::Head,   HTTPMethod::Post,   HTTPMethod::Put,   HTTPMethod::Connect,   HTTPMethod::Options,   HTTPMethod::Trace,   HTTPMethod::Patch,   HTTPMethod::Purge,   HTTPMethod::Copy,   HTTPMethod::Lock,   HTTPMethod::MkCol,   HTTPMethod::Move,   HTTPMethod::Propfind,   HTTPMethod::Proppatch,   HTTPMethod::Search,   HTTPMethod::Unlock,   HTTPMethod::Bind,   HTTPMethod::Rebind,   HTTPMethod::Unbind,   HTTPMethod::Acl,   HTTPMethod::Report,   HTTPMethod::MkActivity,   HTTPMethod::Checkout,   HTTPMethod::Merge,   HTTPMethod::MSearch,   HTTPMethod::Notify,   HTTPMethod::Subscribe,   HTTPMethod::Unsubscribe,   HTTPMethod::MkCalendar,   HTTPMethod::Link,   HTTPMethod::Unlink,   HTTPMethod::Source,   HTTPMethod::InternalMethodCount }
enum	status {   CONTINUE = 100,   SWITCHING_PROTOCOLS = 101,   OK = 200,   CREATED = 201,   ACCEPTED = 202,   NON_AUTHORITATIVE_INFORMATION = 203,   NO_CONTENT = 204,   RESET_CONTENT = 205,   PARTIAL_CONTENT = 206,   MULTIPLE_CHOICES = 300,   MOVED_PERMANENTLY = 301,   FOUND = 302,   SEE_OTHER = 303,   NOT_MODIFIED = 304,   TEMPORARY_REDIRECT = 307,   PERMANENT_REDIRECT = 308,   BAD_REQUEST = 400,   UNAUTHORIZED = 401,   FORBIDDEN = 403,   NOT_FOUND = 404,   METHOD_NOT_ALLOWED = 405,   PROXY_AUTHENTICATION_REQUIRED = 407,   CONFLICT = 409,   GONE = 410,   PAYLOAD_TOO_LARGE = 413,   UNSUPPORTED_MEDIA_TYPE = 415,   RANGE_NOT_SATISFIABLE = 416,   EXPECTATION_FAILED = 417,   PRECONDITION_REQUIRED = 428,   TOO_MANY_REQUESTS = 429,   UNAVAILABLE_FOR_LEGAL_REASONS = 451,   INTERNAL_SERVER_ERROR = 500,   NOT_IMPLEMENTED = 501,   BAD_GATEWAY = 502,   SERVICE_UNAVAILABLE = 503,   GATEWAY_TIMEOUT = 504,   VARIANT_ALSO_NEGOTIATES = 506 }
enum	ParamType : char {   ParamType::INT,   ParamType::UINT,   ParamType::DOUBLE,   ParamType::STRING,   ParamType::PATH,   ParamType::MAX }
enum	LogLevel {   LogLevel::DEBUG = 0,   LogLevel::INFO,   LogLevel::WARNING,   LogLevel::ERROR,   LogLevel::CRITICAL,   LogLevel::Debug = 0,   LogLevel::Info,   LogLevel::Warning,   LogLevel::Error,   LogLevel::Critical }

Functions
const std::string	crlf ("\r\n")
std::string	method_name (HTTPMethod method)
template<typename T >
const std::string &	get_header_value (const T &headers, const std::string &key)
	Find and return the value associated with the key. (returns an empty string if nothing is found) More...
int	qs_strncmp (const char *s, const char *qs, size_t n)
int	qs_parse (char *qs, char *qs_kv[], int qs_kv_size)
int	qs_decode (char *qs)
char *	qs_k2v (const char *key, char *const *qs_kv, int qs_kv_size, int nth)
char *	qs_scanvalue (const char *key, const char *qs, char *val, size_t val_len)
boost::optional< std::pair< std::string, std::string > >	qs_dict_name2kv (const char *dict_name, char *const *qs_kv, int qs_kv_size, int nth=0)
static std::string	base64encode (const unsigned char *data, size_t size, const char *key="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/")
static std::string	base64encode (std::string data, size_t size, const char *key="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/")
static std::string	base64encode_urlsafe (const unsigned char *data, size_t size)
static std::string	base64encode_urlsafe (std::string data, size_t size)
static std::string	base64decode (const char *data, size_t size)
static std::string	base64decode (const std::string &data, size_t size)
static std::string	base64decode (const std::string &data)
static void	sanitize_filename (std::string &data, char replacement='_')

Variables
const char	cr = '\r'
const char	lf = '\n'
constexpr const char *	method_strings []
const std::unordered_map< std::string, std::string >	mime_types
constexpr const uint16_t	INVALID_BP_ID {((uint16_t)-1)}
const int	RULE_SPECIAL_REDIRECT_SLASH = 1
constexpr const char	VERSION [] = "master"

Typedef Documentation

App

template<typename... Middlewares>

using crow::App = typedef Crow<Middlewares...>

SimpleApp

using crow::SimpleApp = typedef Crow<>

ci_map

using crow::ci_map = typedef std::unordered_multimap<std::string, std::string, ci_hash, ci_key_eq>

tcp

typedef asio::ip::tcp crow::tcp

Enumeration Type Documentation

HTTPMethod

enum crow::HTTPMethod : char

strong

Enumerator
DELETE
GET
HEAD
POST
PUT
CONNECT
OPTIONS
TRACE
PATCH
PURGE
COPY
LOCK
MKCOL
MOVE
PROPFIND
PROPPATCH
SEARCH
UNLOCK
BIND
REBIND
UNBIND
ACL
REPORT
MKACTIVITY
CHECKOUT
MERGE
MSEARCH
NOTIFY
SUBSCRIBE
UNSUBSCRIBE
MKCALENDAR
LINK
UNLINK
SOURCE
Delete
Get
Head
Post
Put
Connect
Options
Trace
Patch
Purge
Copy
Lock
MkCol
Move
Propfind
Proppatch
Search
Unlock
Bind
Rebind
Unbind
Acl
Report
MkActivity
Checkout
Merge
MSearch
Notify
Subscribe
Unsubscribe
MkCalendar
Link
Unlink
Source
InternalMethodCount

status

enum crow::status

Enumerator
CONTINUE
SWITCHING_PROTOCOLS
OK
CREATED
ACCEPTED
NON_AUTHORITATIVE_INFORMATION
NO_CONTENT
RESET_CONTENT
PARTIAL_CONTENT
MULTIPLE_CHOICES
MOVED_PERMANENTLY
FOUND
SEE_OTHER
NOT_MODIFIED
TEMPORARY_REDIRECT
PERMANENT_REDIRECT
BAD_REQUEST
UNAUTHORIZED
FORBIDDEN
NOT_FOUND
METHOD_NOT_ALLOWED
PROXY_AUTHENTICATION_REQUIRED
CONFLICT
GONE
PAYLOAD_TOO_LARGE
UNSUPPORTED_MEDIA_TYPE
RANGE_NOT_SATISFIABLE
EXPECTATION_FAILED
PRECONDITION_REQUIRED
TOO_MANY_REQUESTS
UNAVAILABLE_FOR_LEGAL_REASONS
INTERNAL_SERVER_ERROR
NOT_IMPLEMENTED
BAD_GATEWAY
SERVICE_UNAVAILABLE
GATEWAY_TIMEOUT
VARIANT_ALSO_NEGOTIATES

ParamType

enum crow::ParamType : char

strong

Enumerator
INT
UINT
DOUBLE
STRING
PATH
MAX

LogLevel

enum crow::LogLevel

strong

Enumerator
DEBUG
INFO
WARNING
ERROR
CRITICAL
Debug
Info
Warning
Error
Critical

Function Documentation

crlf()

const std::string crow::crlf

(

"\r\n"

)

Here is the caller graph for this function:

method_name()

std::string crow::method_name ( HTTPMethod  method )

inline

Here is the caller graph for this function:

get_header_value()

template<typename T >

const std::string& crow::get_header_value ( const T &  headers, const std::string &  key  )

inline

Find and return the value associated with the key. (returns an empty string if nothing is found)

Here is the caller graph for this function:

qs_strncmp()

int crow::qs_strncmp ( const char *  s, const char *  qs, size_t  n  )

inline

Here is the caller graph for this function:

qs_parse()

int crow::qs_parse ( char *  qs, char *  qs_kv[], int  qs_kv_size  )

inline

Here is the call graph for this function:

Here is the caller graph for this function:

qs_decode()

int crow::qs_decode ( char *  qs )

inline

Here is the caller graph for this function:

qs_k2v()

char * crow::qs_k2v ( const char *  key, char *const *  qs_kv, int  qs_kv_size, int  nth = 0  )

inline

Here is the call graph for this function:

Here is the caller graph for this function:

qs_scanvalue()

char * crow::qs_scanvalue ( const char *  key, const char *  qs, char *  val, size_t  val_len  )

inline

Here is the call graph for this function:

qs_dict_name2kv()

boost::optional<std::pair<std::string, std::string> > crow::qs_dict_name2kv ( const char *  dict_name, char *const *  qs_kv, int  qs_kv_size, int  nth = 0  )

inline

Here is the caller graph for this function:

base64encode() [1/2]

static std::string crow::base64encode ( const unsigned char *  data, size_t  size, const char *  key = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"  )

inlinestatic

Here is the caller graph for this function:

base64encode() [2/2]

static std::string crow::base64encode ( std::string  data, size_t  size, const char *  key = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"  )

inlinestatic

Here is the call graph for this function:

base64encode_urlsafe() [1/2]

static std::string crow::base64encode_urlsafe ( const unsigned char *  data, size_t  size  )

inlinestatic

Here is the call graph for this function:

base64encode_urlsafe() [2/2]

static std::string crow::base64encode_urlsafe ( std::string  data, size_t  size  )

inlinestatic

Here is the call graph for this function:

base64decode() [1/3]

static std::string crow::base64decode ( const char *  data, size_t  size  )

inlinestatic

Here is the caller graph for this function:

base64decode() [2/3]

static std::string crow::base64decode ( const std::string &  data, size_t  size  )

inlinestatic

Here is the call graph for this function:

base64decode() [3/3]

static std::string crow::base64decode ( const std::string &  data )

inlinestatic

Here is the call graph for this function:

sanitize_filename()

static void crow::sanitize_filename ( std::string &  data, char  replacement = '_'  )

inlinestatic

Variable Documentation

cr

const char crow::cr = '\r'

lf

const char crow::lf = '\n'

method_strings

constexpr const char* crow::method_strings[]

constexpr

mime_types

const std::unordered_map<std::string, std::string> crow::mime_types

INVALID_BP_ID

constexpr const uint16_t crow::INVALID_BP_ID {((uint16_t)-1)}

constexpr

RULE_SPECIAL_REDIRECT_SLASH

const int crow::RULE_SPECIAL_REDIRECT_SLASH = 1

VERSION

constexpr const char crow::VERSION[] = "master"

constexpr