seastar::httpd::file_handler Class Reference

Detailed Description

The file handler get a path to a file on the disk in the constructor. it will always return the content of the file.

#include <seastar/http/file_handler.hh>

Inheritance diagram for seastar::httpd::file_handler:

Public Member Functions
	file_handler (const sstring &file, file_transformer *transformer=nullptr, bool force_path=true)
future< std::unique_ptr< http::reply > >	handle (const sstring &path, std::unique_ptr< http::request > req, std::unique_ptr< http::reply > rep) override
file_interaction_handler *	set_transformer (file_transformer *t)
bool	redirect_if_needed (const http::request &req, http::reply &rep) const
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

Constructor & Destructor Documentation

file_handler()

seastar::httpd::file_handler::file_handler ( const sstring &  file, file_transformer *  transformer = nullptr, bool  force_path = true  )

inlineexplicit

The file handler map a file to a url

Parameters

file	the full path to the file on the disk
transformer	an optional file transformer
force_path	check if redirect is needed upon handle

Member Function Documentation

get_extension()

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

staticinherited

A helper method that returns the file extension.

Parameters

file	the file to check

Returns

the file extension

handle()

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

overridevirtual

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

Implements seastar::httpd::handler_base.

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  )

protectedinherited

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

inherited

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 )

inlineinherited

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