seastar::httpd::directory_handler Class Reference

Detailed Description

The directory handler get a disk path in the constructor. and expect a path parameter in the handle method. it would concatenate the two and return the file e.g. if the path is /usr/mgmt/public in the path parameter is index.html handle will return the content of /usr/mgmt/public/index.html

#include <seastar/http/file_handler.hh>

Inheritance diagram for seastar::httpd::directory_handler:

Public Member Functions
	directory_handler (const sstring &doc_root, file_transformer *transformer=nullptr)
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)

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

Public Attributes
std::vector< sstring >	_mandatory_param

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

directory_handler()

seastar::httpd::directory_handler::directory_handler ( const sstring &  doc_root, file_transformer *  transformer = nullptr  )

explicit

The directory handler map a base path and a path parameter to a file

Parameters

doc_root	the root directory to search the file from.
transformer	an optional file transformer For example if the root is '/usr/mgmt/public' and the path parameter will be '/css/style.css' the file wil be /usr/mgmt/public/css/style.css'

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::directory_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

---

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

• seastar/http/file_handler.hh