HttpResource handler to support streaming updates to a configuration database. More...

#include <HttpImportResource.h>

Inheritance diagram for ConfigDB::HttpImportResource:

Collaboration diagram for ConfigDB::HttpImportResource:

Public Types
using	OnRequest = Delegate< std::unique_ptr< ImportStream >(HttpRequest &request, MimeType mimeType)>
	Callback invoked when a POST request received. More...

using	OnComplete = Delegate< void(HttpRequest &request, HttpResponse &response, ImportStream &stream)>
	Callback invoked when a POST request has completed. More...

Public Member Functions
	HttpImportResource (OnRequest onRequest, OnComplete onComplete)
	Construct a resource handler. More...

	HttpImportResource (Database &database, const Format &format)

Public Member Functions inherited from HttpResource
virtual	~HttpResource ()=default

virtual void	shutdown (HttpServerConnection &)
	Takes care to cleanup the connection. More...

void	addPlugin (HttpResourcePlugin *plugin)

template<class... Tail>
void	addPlugin (HttpResourcePlugin *plugin, Tail... plugins)

Additional Inherited Members
Public Attributes inherited from HttpResource
HttpResourceDelegate	onUrlComplete = nullptr
	URL is ready. Path and status code are available. More...

HttpServerConnectionBodyDelegate	onBody = nullptr
	resource wants to process the raw body data More...

HttpResourceDelegate	onHeadersComplete = nullptr
	headers are ready More...

HttpResourceDelegate	onRequestComplete = nullptr
	request is complete OR upgraded More...

HttpServerConnectionUpgradeDelegate	onUpgrade = nullptr
	request is upgraded and raw data is passed to it More...

Detailed Description

HttpResource handler to support streaming updates to a configuration database.

Member Typedef Documentation

◆ OnComplete

using ConfigDB::HttpImportResource::OnComplete = Delegate<void(HttpRequest& request, HttpResponse& response, ImportStream& stream)>

Callback invoked when a POST request has completed.

Parameters

request	The request previously passed to `onRequest` callback
response	The response message that will be returned to the client
stream	The stream created by the `onRequest` call

Typically this callback will inspect the status of the update operation and return a suitable code or message in the response.

◆ OnRequest

using ConfigDB::HttpImportResource::OnRequest = Delegate<std::unique_ptr<ImportStream>(HttpRequest& request, MimeType mimeType)>

Callback invoked when a POST request received.

Parameters

request	The incoming request
mimeType	Decoded Content-Type field from request

Return values

std::unique_ptr<ReadWriteStream> Writeable stream created by calling, for example, ConfigDB::Database.createExportStream Return null if request is to be rejected

Constructor & Destructor Documentation

◆ HttpImportResource() [1/2]

ConfigDB::HttpImportResource::HttpImportResource	(	OnRequest	onRequest,
		OnComplete	onComplete
	)

inline

Construct a resource handler.

◆ HttpImportResource() [2/2]

ConfigDB::HttpImportResource::HttpImportResource	(	Database &	database,
		const Format &	format
	)

inline

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

HttpImportResource.h

Public Types

Public Member Functions