Namespace drogon

Description

No description yet.

Namespaces

	orm
	plugin
	test
	utils

Classes

	AsyncTask	Fires a coroutine and doesn't force waiting nor deallocates upon promise destructs
	Attributes	This class represents the attributes stored in the HTTP request. One can add/get any type of data to/from an Attributes object.
	await_result
	CacheMap	Cache Map.
	CallbackAwaiter	Helper class that provides the infrastructure for turning callback into coroutines
	CallbackAwaiter< void >
	CallbackEntry	A utility class for CacheMap.
	Cookie	this class represents a cookie entity.
	DrClassMap	A map class which can create DrObjects from names.
	DrObject	a class template to implement the reflection function of creating the class object by class name
	DrObjectBase	The base class for all drogon reflection classes.
	DrTemplate
	DrTemplateBase	The templating engine class.
	final_awaiter
	HttpAppFramework	Mentioned in View / A simple example View / Dynamic compilation and loading of views Wiki / Session Session / Examples of sessions
	HttpClient	Asynchronous http client.
	HttpController	The reflection base class template for HTTP controllers.
	HttpControllerBase	The base class for HTTP controllers.
	HttpFile	This class represents a uploaded file by a HTTP request.
	HttpFilter	The reflection base class template for filters.
	HttpFilterBase	The abstract base class for filters For more details on the class, see the wiki site (the 'Filter' section)
	HttpRequest	Abstract class for webapp developer to get or set the Http request;.
	HttpResponse	Mentioned in Controller Introduction / Controller HttpSimpleController View / The use of views FAQ / Understanding drogon's threading model / Network IO in practice
	HttpSimpleController	The reflection base class template for HTTP simple controllers.
	HttpSimpleControllerBase	The abstract base class for HTTP simple controllers.
	HttpViewData	This class represents the data set displayed in views.
	IntranetIpFilter	A filter that prohibit access from external networks.
	IOThreadStorage	Utility class for thread storage handling.
	is_awaitable
	is_awaitable< T, std::void_t< decltype(internal::getAwaiter(std::declval< T >()))> >
	is_resumable
	is_resumable< AsyncTask, std::void_t< AsyncTask > >
	is_resumable< T, std::void_t< decltype(internal::getAwaiter(std::declval< T >()))> >
	IsPlugin
	LocalHostFilter	A filter that prohibit access from other hosts.
	MultiPartParser	A parser class which help the user to get the files and the parameters in the multipart format request.
	NotFound	This class is used by the drogon to generate the 404 page. Users don't use this class directly.
	OStringStream
	Plugin	The reflection base class for plugins.
	PluginBase	The abstract base class for plugins.
	PubSubService	This class template implements a publish-subscribe pattern with multiple named topics.
	RestfulController	this class is a helper class for the implementation of restful api controllers generated by the drogon_ctl command.
	Session	This class represents a session stored in the framework. One can get or set any type of data to a session object.
	StringViewHasher
	StringViewHasher< 4 >
	StringViewHasher< 8 >
	Task
	Task< void >
	Topic	This class template presents an unnamed topic.
	UploadFile	This class represents an upload file which will be transferred to the server via the multipart/form-data format
	WebSocketClient	WebSocket client abstract class.
	WebSocketConnection	The WebSocket connection abstract class.
	WebSocketController	The reflection base class template for WebSocket controllers.
	WebSocketControllerBase	The abstract base class for WebSocket controllers.

Functions

	app	A wrapper of the instance() method.
	apply
	async_func	returns a function that calls a coroutine
	async_run	Runs a coroutine from a regular function.
	co_future
	fromRequest overload	This template is used to convert a request object to a custom type object. Users must specialize the template for a particular type.
	fromResponse overload	This template is used to convert a response object to a custom type object. Users must specialize the template for a particular type.
	getGitCommit
	getIOThreadStorageLoop
	getVersion
	operator<< overload
	sleepCoro overload
	sync_wait	Mentioned in Testing Framework / Asynchronous testing
	to_string
	to_string_view
	toRequest overload	This template is used to create a request object from a custom type object by calling the newCustomHttpRequest(). Users must specialize the template for a particular type.
	toRequest< const Json::Value & >
	toRequest< Json::Value & >
	toResponse overload	This template is used to create a response object from a custom type object by calling the newCustomHttpResponse(). Users must specialize the template for a particular type.
	toResponse< const Json::Value & >
	toResponse< Json::Value & >

Enums

	HttpStatusCode
	Version	Mentioned in Drogon Ctl Command / Version subcommand
	ContentType
	FileType
	HttpMethod	Mentioned in Controller Introduction / Controller HttpSimpleController
	ReqResult	Mentioned in Testing Framework / Asynchronous testing FAQ / Understanding drogon's threading model / Network IO in practice
	WebSocketMessageType	Mentioned in Controller Introduction / Controller WebSocketController / WebSocketController
	PluginStatus
	CloseCode

Typedefs

Typedefs (Attribute.h)

using AttributesPtr = std::shared_ptr< Attributes >

Typedefs (CacheMap.h)

	using CallbackEntryPtr = std::shared_ptr< CallbackEntry >
	using WeakCallbackEntryPtr = std::weak_ptr< CallbackEntry >
	using CallbackBucket = std::unordered_set< CallbackEntryPtr >
	using CallbackBucketQueue = std::deque< CallbackBucket >

Typedefs (DrClassMap.h)

using DrAllocFunc = std::function< DrObjectBase *()>

Typedefs (drogon_callbacks.h)

	typedef std::shared_ptr< HttpResponse > HttpResponsePtr	Mentioned in: Getting Started / A very simple example Quick Start / Dynamic Site Controller Introduction / Controller Controller Introduction / Controller HttpSimpleController Controller Introduction / Controller HttpController / Generation Controller Introduction / Controller HttpController / Usage Controller Introduction / Controller HttpController / Parameter mapping Filter / Custom Filter View / The use of views View / A simple example Session / Examples of sessions AOP Aspect Oriented Programming / Predefined joinpoints Benchmarks / Test plan and results Coroutines / Using coroutines Testing Framework / Asynchronous testing FAQ / Understanding drogon's threading model / Event loops and threads FAQ / Understanding drogon's threading model / Network IO in practice FAQ / Understanding drogon's threading model / Deadlocking the event loop
	typedef std::shared_ptr< HttpRequest > HttpRequestPtr	Mentioned in: Getting Started / A very simple example Quick Start / Dynamic Site Controller Introduction / Controller Controller Introduction / Controller HttpSimpleController Controller Introduction / Controller HttpController / Generation Controller Introduction / Controller HttpController / Usage Controller Introduction / Controller HttpController / Parameter mapping Controller Introduction / Controller WebSocketController / WebSocketController Filter / Custom Filter View / A simple example Session / Examples of sessions AOP Aspect Oriented Programming / Predefined joinpoints Benchmarks / Test plan and results Coroutines / Using coroutines
	using AdviceCallback = std::function< void(const HttpResponsePtr &)>	Mentioned in: AOP Aspect Oriented Programming / Predefined joinpoints
	using AdviceChainCallback = std::function< void()>	Mentioned in: AOP Aspect Oriented Programming / Predefined joinpoints
	using FilterCallback = std::function< void(const HttpResponsePtr &)>	Mentioned in: Filter / Custom Filter Session / Examples of sessions
	using FilterChainCallback = std::function< void()>	Mentioned in: Filter / Custom Filter Session / Examples of sessions
	using HttpReqCallback = std::function< void(ReqResult, const HttpResponsePtr &)>

Typedefs (DrTemplateBase.h)

using DrTemplateData = HttpViewData

Typedefs (HttpAppFramework.h)

	using ExceptionHandler = std::function< void(const std::exception &, const HttpRequestPtr &, std::function< void(const HttpResponsePtr &)> &&)>
	using DefaultHandler = std::function< void(const HttpRequestPtr &, std::function< void(const HttpResponsePtr &)> &&)>

Typedefs (HttpClient.h)

using HttpClientPtr = std::shared_ptr< HttpClient >

Typedefs (MultiPart.h)

using FileUpload = MultiPartParser

In order to be compatible with old interfaces.

Typedefs (PubSubService.h)

using SubscriberID = uint64_t

Typedefs (Session.h)

using SessionPtr = std::shared_ptr< Session >

Mentioned in:

Session / Session object

Typedefs (coroutine.h)

template <typename T>
using await_result_t = typename await_result< T >::type

Typedefs (WebSocketClient.h)

	using WebSocketClientPtr = std::shared_ptr< WebSocketClient >
	using WebSocketRequestCallback = std::function< void(ReqResult, const HttpResponsePtr &, const WebSocketClientPtr &)>

Typedefs (WebSocketConnection.h)

using WebSocketConnectionPtr = std::shared_ptr< WebSocketConnection >

Mentioned in:

Controller Introduction / Controller WebSocketController / WebSocketController

Typedefs (WebSocketController.h)

using WebSocketControllerBasePtr = std::shared_ptr< WebSocketControllerBase >

Variables

Variables (HttpAppFramework.h)

Variables (coroutine.h)

	template <typename T> constexpr bool is_awaitable_v = is_awaitable<T>::value
	template <typename T> constexpr bool is_resumable_v = is_resumable<T>::value