seastar::httpd::file_interaction_handler Class Reference

Detailed Description

A base class for handlers that interact with files. directory and file handlers both share some common logic with regards to file handling. they both needs to read a file from the disk, optionally transform it, and return the result or page not found on error

#include <seastar/http/file_handler.hh>

Inheritance diagram for seastar::httpd::file_interaction_handler:

Public Member Functions
	file_interaction_handler (file_transformer *p=nullptr)
file_interaction_handler *	set_transformer (file_transformer *t)
bool	redirect_if_needed (const http::request &req, http::reply &rep) const
virtual future< std::unique_ptr< http::reply > >	handle (const sstring &path, std::unique_ptr< http::request > req, std::unique_ptr< http::reply > rep)=0
handler_base &	mandatory (const sstring &param)
void	verify_mandatory_params (const http::request &req) const

Static Public Member Functions
static sstring	get_extension (const sstring &file)

Protected Member Functions
future< std::unique_ptr< http::reply > >	read (sstring file, std::unique_ptr< http::request > req, std::unique_ptr< http::reply > rep)
output_stream< char >	get_stream (std::unique_ptr< http::request > req, const sstring &extension, output_stream< char > &&s)

Protected Attributes
file_transformer *	transformer

Member Function Documentation

get_extension()

static sstring seastar::httpd::file_interaction_handler::get_extension ( const sstring &  file )

static

A helper method that returns the file extension.

Parameters

file	the file to check

Returns

the file extension

handle()

virtual future< std::unique_ptr< http::reply > > seastar::httpd::handler_base::handle ( const sstring &  path, std::unique_ptr< http::request >  req, std::unique_ptr< http::reply >  rep  )

pure virtualinherited

All handlers should implement this method. It fill the reply according to the request.

Parameters

path	the url path used in this call
req	the original request
rep	the reply

Implemented in seastar::httpd::api_registry, seastar::httpd::api_registry_20, seastar::httpd::directory_handler, seastar::httpd::file_handler, and seastar::httpd::function_handler.

mandatory()

handler_base & seastar::httpd::handler_base::mandatory ( const sstring &  param )

inlineinherited

Add a mandatory parameter

Parameters

param

a parameter name

Returns

a reference to the handler

read()

future< std::unique_ptr< http::reply > > seastar::httpd::file_interaction_handler::read ( sstring  file, std::unique_ptr< http::request >  req, std::unique_ptr< http::reply >  rep  )

protected

read a file from the disk and return it in the replay.

Parameters

file	the full path to a file on the disk
req	the reuest
rep	the reply

redirect_if_needed()

bool seastar::httpd::file_interaction_handler::redirect_if_needed	(	const http::request &	req,
		http::reply &	rep
	)		const

if the url ends without a slash redirect

Parameters

req	the request
rep	the reply

Returns

true on redirect

set_transformer()

file_interaction_handler * seastar::httpd::file_interaction_handler::set_transformer ( file_transformer *  t )

inline

Allows setting a transformer to be used with the files returned.

Parameters

t	the file transformer to use

Returns

this

verify_mandatory_params()

void seastar::httpd::handler_base::verify_mandatory_params ( const http::request &  req ) const

inlineinherited

Check if all mandatory parameters exist in the request. if any param does not exist, the function would throw a missing_param_exception

Parameters

params

req the http request

---

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

• seastar/http/file_handler.hh