Commit 2238f58c authored by Ciarán Ó Rourke's avatar Ciarán Ó Rourke
Browse files

Rename Project

Rename project from FiPhoboServer to Deimos

Change log:
* replace all occurances of variations of fiphoboserver with its deimos
equivalent
parent 99ca98cf
Pipeline #1815 passed with stages
in 8 minutes and 15 seconds
......@@ -15,7 +15,7 @@ WarningsAsErrors: '*'
HeaderFilterRegex: ''
AnalyzeTemporaryDtors: false
FormatStyle: none
User: FiPhoboServer
User: Deimos
CheckOptions:
- key: google-readability-braces-around-statements.ShortStatementLines
value: '1'
......@@ -73,6 +73,6 @@ CheckOptions:
- key: readability-identifier-naming.MacroDefinitionCase
value: UPPER_CASE
- key: readability-identifier-naming.MacroDefinitionPrefix
value: FIPHOBOSERVER_
value: DEIMOS_
...
......@@ -13,11 +13,11 @@ image: ciaranorourke/fiphoboserver:debian
-DCMAKE_EXPORT_COMPILE_COMMANDS=ON
-DCMAKE_C_COMPILER=${CC}
-DCMAKE_CXX_COMPILER=${CXX}
-DFIPHOBOSERVER_BUILD_TESTS="${FIPHOBOSERVER_BUILD_TESTS}"
-DDEIMOS_BUILD_TESTS="${DEIMOS_BUILD_TESTS}"
-DCMAKE_PREFIX_PATH="${DEPS_DIR}"
-DCUSTOM_DOCU_PATH="${FIPHOBOSERVER_DOC_DIR}"
-DFIPHOBOSERVER_BUILD_DOCUMENTATION="${FIPHOBOSERVER_BUILD_DOCUMENTATION}"
-DFIPHOBOSERVER_DISABLE_AUTHORISATION="${FIPHOBOSERVER_DISABLE_AUTHORISATION}"
-DCUSTOM_DOCU_PATH="${DEIMOS_DOC_DIR}"
-DDEIMOS_BUILD_DOCUMENTATION="${DEIMOS_BUILD_DOCUMENTATION}"
-DDEIMOS_DISABLE_AUTHORISATION="${DEIMOS_DISABLE_AUTHORISATION}"
..
)
&& popd
......@@ -34,9 +34,9 @@ image: ciaranorourke/fiphoboserver:debian
CC: gcc
CXX: g++
DEPS_DIR: /home/superfiphoboserver/build/install
FIPHOBOSERVER_DOC_DIR: ""
FIPHOBOSERVER_BUILD_TESTS: "ON"
FIPHOBOSERVER_DISABLE_AUTHORISATION: "OFF"
DEIMOS_DOC_DIR: ""
DEIMOS_BUILD_TESTS: "ON"
DEIMOS_DISABLE_AUTHORISATION: "OFF"
.default_job: &default_job
tags:
......@@ -96,8 +96,8 @@ Documentation:
stage: build
variables:
<<: *default_cmake_variables
FIPHOBOSERVER_BUILD_DOCUMENTATION: "ON"
FIPHOBOSERVER_DOC_DIR: /home/superfiphoboserver/external/doxygen-xml-parser/src
DEIMOS_BUILD_DOCUMENTATION: "ON"
DEIMOS_DOC_DIR: /home/superfiphoboserver/external/doxygen-xml-parser/src
CC: clang
CXX: clang++
before_script:
......@@ -119,5 +119,5 @@ Authorisation Disabled:
<<: *default_job
variables:
<<: *default_cmake_variables
FIPHOBOSERVER_DISABLE_AUTHORISATION: "ON"
DEIMOS_DISABLE_AUTHORISATION: "ON"
stage: test
cmake_minimum_required(VERSION 3.0)
project(fiphoboserver)
project(deimos)
set(CUSTOM_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
......@@ -11,18 +11,18 @@ find_package(proxygen REQUIRED)
# programs/libraries in the given subdirectories
#
option(
FIPHOBOSERVER_BUILD_TESTS
"build FiPhoboServer tests. Depends on Catch2."
DEIMOS_BUILD_TESTS
"build Deimos tests. Depends on Catch2."
OFF
)
option(
FIPHOBOSERVER_BUILD_DOCUMENTATION
"build FiPhoboServer Documentation. Depends on Doxygen."
DEIMOS_BUILD_DOCUMENTATION
"build Deimos Documentation. Depends on Doxygen."
OFF
)
option(
FIPHOBOSERVER_DISABLE_AUTHORISATION
"build FiPhoboServer with AWS authorisation disabled. Default is enabled"
DEIMOS_DISABLE_AUTHORISATION
"build Deimos with AWS authorisation disabled. Default is enabled"
OFF
)
......@@ -33,12 +33,12 @@ target_include_directories(
$<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/include>
)
if(FIPHOBOSERVER_BUILD_DOCUMENTATION)
if(DEIMOS_BUILD_DOCUMENTATION)
add_subdirectory(doc)
endif(FIPHOBOSERVER_BUILD_DOCUMENTATION)
endif(DEIMOS_BUILD_DOCUMENTATION)
# Build tests
if(FIPHOBOSERVER_BUILD_TESTS)
if(DEIMOS_BUILD_TESTS)
add_subdirectory(test/unit_tests)
enable_testing()
endif(FIPHOBOSERVER_BUILD_TESTS)
endif(DEIMOS_BUILD_TESTS)
# FIPhoboServer
# Deimos
## Dependencies Installation Instructions
FIPhoboServer has many dependencies that require much patience to build. It may be simpler to invoke a prebuilt Docker image using a Dockerfile such as;
Deimos has many dependencies that require much patience to build. It may be simpler to invoke a prebuilt Docker image using a Dockerfile such as;
```
FROM ciaranorourke/fiphoboserver:debian
FROM ciaranorourke/deimos:debian
RUN apt-get -y update && apt-get -y upgrade
RUN apt-get -y install doxygen graphviz
RUN apt-get -y install \
[personal installation preferences]
CMD /home/superfiphoboserver/tools/build_phobos.sh -r && [favourite shell]
CMD /home/superdeimos/tools/build_phobos.sh -r && [favourite shell]
```
Alternatively, see [SuperFIPhoboServer](https://git.ichec.ie/oilgas/ltfs/superfiphoboserver) for instructions on how to create your own build environment.
Alternatively, see [SuperDeimos](https://git.ichec.ie/oilgas/ltfs/superdeimos) for instructions on how to create your own build environment.
It is recommended to run this Docker image by mounting your local branch of the FIPhoboServer project with `docker run -it -v /path/to/fiphoboserver:/destination [name]:[tag]`
It is recommended to run this Docker image by mounting your local branch of the Deimos project with `docker run -it -v /path/to/deimos:/destination [name]:[tag]`
To use the Phobos raid1 layout which is compatible with FIFOs, the following environment variables must be set;
......@@ -27,7 +27,7 @@ export PHOBOS_LAYOUT_RAID1_repl_count={1,2,3,...}
## Build Instructions
To configure and build FIPhoboServer, a C++14 compatible compiler is required, and CMake >= 3.0.
To configure and build Deimos, a C++14 compatible compiler is required, and CMake >= 3.0.
```
# Make a directory to hold the temporary build files
......@@ -36,22 +36,22 @@ mkdir -p build
# Change directory to the build directory
cd build
# Configure the FIPhoboServer build using CMake
# Configure the Deimos build using CMake
cmake \
-DCMAKE_PREFIX_PATH=/path/to/proxygen \
[more options below] \
/path/to/fiphoboserver/project
/path/to/deimos/project
# Build the FIPhoboServer project
# Build the Deimos project
make
```
### Build instructions using the superbuild
When using the Docker image from [SuperFIPhoboServer](https://git.ichec.ie/oilgas/ltfs/superfiphoboserver), some specific values make life a bit easier:
* docker image should be run with `/home/superfiphoboserver/external/fiphoboserver` as `destination` for the mount option (example: `docker run -it -v ./fiphoboserver:/home/superfiphoboserver/external/fiphoboserver phobos:debian`).
* the `CMAKE_PREFIX_PATH` need to be set to `/home/superfiphoboserver/build/install`
* An example script to build this project can be found inside the container under `/home/superfiphoboserver/tools/build_fiphboserver.sh`.
When using the Docker image from [SuperDeimos](https://git.ichec.ie/oilgas/ltfs/superdeimos), some specific values make life a bit easier:
* docker image should be run with `/home/superdeimos/external/deimos` as `destination` for the mount option (example: `docker run -it -v ./deimos:/home/superdeimos/external/deimos phobos:debian`).
* the `CMAKE_PREFIX_PATH` need to be set to `/home/superdeimos/build/install`
* An example script to build this project can be found inside the container under `/home/superdeimos/tools/build_deimos.sh`.
### Useful Options
......@@ -61,25 +61,25 @@ Option | Effect
`-DCMAKE_CXX_COMPILER=...` | Set the C++ compiler.
`-DCMAKE_CXX_FLAGS=...` | Set the flags to pass to the C++ compiler. Overrides the default flags.
#### Enabling/Disabling Sections of FIPhoboServer
#### Enabling/Disabling Sections of Deimos
Option | Effect
------ | ------
`-DFIPHOBOSERVER_BUILD_TESTS=...` | Set to `ON` to build FIPhoboServer tests and enable the `make test` target, or `OFF` to skip (Default `OFF`).
`-DFIPHOBOSERVER_DISABLE_AUTHORISATION=...` | Set to `ON` to disable AWS V4 authorisation (= letting everything through), or `OFF` to authorise requests (Default `OFF`).
`-DFIPHOBOSERVER_BUILD_DOCUMENTATION=...` | Set to `ON` to build FIPhoboServer Doxygen documentation, or `OFF` to skip (Default `OFF`).
`-DCUSTOM_DOCU_PATH=...` | Set to the path to the `src` folder in [DoxygenXMLParser](https://git.ichec.ie/sophie.wenzel-teuber/doxygen-xml-parser) to create the Markdown output from the Doxygen XML, that can also be found [here](doc/Markdown/fiphoboserver) or don't set to skip (Default `not set`).
`-DDEIMOS_BUILD_TESTS=...` | Set to `ON` to build Deimos tests and enable the `make test` target, or `OFF` to skip (Default `OFF`).
`-DDEIMOS_DISABLE_AUTHORISATION=...` | Set to `ON` to disable AWS V4 authorisation (= letting everything through), or `OFF` to authorise requests (Default `OFF`).
`-DDEIMOS_BUILD_DOCUMENTATION=...` | Set to `ON` to build Deimos Doxygen documentation, or `OFF` to skip (Default `OFF`).
`-DCUSTOM_DOCU_PATH=...` | Set to the path to the `src` folder in [DoxygenXMLParser](https://git.ichec.ie/sophie.wenzel-teuber/doxygen-xml-parser) to create the Markdown output from the Doxygen XML, that can also be found [here](doc/Markdown/deimos) or don't set to skip (Default `not set`).
## Testing
Units test can be run with `make -C build tests`, given `FIPHOBOSERVER_BUILD_TESTS` was set to `ON` during the build process.
Units test can be run with `make -C build tests`, given `DEIMOS_BUILD_TESTS` was set to `ON` during the build process.
Integration tests can be run from the `test/integration_tests/` directory with `python -m unittest client`.
## Documentation
The Doxygen documentation can be found [here](doc/Markdown/fiphoboserver).
The Doxygen documentation can be found [here](doc/Markdown/deimos).
## Usage
The `fiphoboserver` executable requires exactly one subcommand.
The `deimos` executable requires exactly one subcommand.
#### Subcommands
Subcommand | Effect
......@@ -96,11 +96,11 @@ Flag/Option | Effect
`--http2 INT` | Set the port to listen on with HTTP2 protocol (Default `11002`).
`-t,--threads INT` | Set the number of threads to listen on, <= 0 will use number of available cores (Default `0`).
`-w,--write-config TEXT` | Write the configuration to `TEXT`.
`-l,--logfile` | Set the filename to write logs to (Default `/tmp/fiphoboserver_log.txt").
`-l,--logfile` | Set the filename to write logs to (Default `/tmp/deimos_log.txt").
Options can also be given to the `start` subcommand using `--config [config_filename]`. Note that if `hostname` is specified in the configuration file then the `--config` options must be suppied before the `start` subcommand;
```
fiphoboserver --config [config_filename] start
deimos --config [config_filename] start
```
### Authentication
......
......@@ -4,7 +4,7 @@
# This is a template file used for configuration in doc/CMakeLists.txt.
#
PROJECT_NAME = FiPhoboServer
PROJECT_NAME = Deimos
# Extraction options
EXTRACT_PRIVATE = YES
......
# <a name='fiphoboserver-FIPhoboServerException' /> public fiphoboserver::FIPhoboServerException
# <a name='deimos-DeimosException' /> public deimos::DeimosException
exception class for all user defined exceptions in FiPhboServer
exception class for all user defined exceptions in Deimos
## Inheritance:
Is inherited by [fiphoboserver::IOException][fiphoboserver-IOException], [fiphoboserver::storage::PhobosException][fiphoboserver-storage-PhobosException].
Is inherited by [deimos::IOException][deimos-IOException], [deimos::storage::PhobosException][deimos-storage-PhobosException].
## Protected Attributes
| Name | Description |
| ---- | ---- |
| [m_message](#fiphoboserver-FIPhoboServerException-m_message) | the internal message |
| [m_message](#deimos-DeimosException-m_message) | the internal message |
## Public Functions
| Name | Description |
| ---- | ---- |
| [FIPhoboServerException](#fiphoboserver-FIPhoboServerException-FIPhoboServerException) | default constructor |
| [FIPhoboServerException](#fiphoboserver-FIPhoboServerException-FIPhoboServerException-1) | constructor for a message with information on the exception |
| [what](#fiphoboserver-FIPhoboServerException-what) | get information on this exception |
| [get_inner_error](#fiphoboserver-FIPhoboServerException-get_inner_error) | return the inner error value that caused this exception |
| [DeimosException](#deimos-DeimosException-DeimosException) | default constructor |
| [DeimosException](#deimos-DeimosException-DeimosException-1) | constructor for a message with information on the exception |
| [what](#deimos-DeimosException-what) | get information on this exception |
| [get_inner_error](#deimos-DeimosException-get_inner_error) | return the inner error value that caused this exception |
## Protected Attributes
### <a name='fiphoboserver-FIPhoboServerException-m_message' /> protected fiphoboserver::FIPhoboServerException::m_message
### <a name='deimos-DeimosException-m_message' /> protected deimos::DeimosException::m_message
the internal message
......@@ -36,10 +36,10 @@ the internal message
[Go to Top](#fiphoboserver-FIPhoboServerException)
[Go to Top](#deimos-DeimosException)
## Public Functions
### <a name='fiphoboserver-FIPhoboServerException-FIPhoboServerException' /> public fiphoboserver::FIPhoboServerException::FIPhoboServerException ()
### <a name='deimos-DeimosException-DeimosException' /> public deimos::DeimosException::DeimosException ()
default constructor
......@@ -54,9 +54,9 @@ default constructor
* inline
[Go to Top](#fiphoboserver-FIPhoboServerException)
[Go to Top](#deimos-DeimosException)
### <a name='fiphoboserver-FIPhoboServerException-FIPhoboServerException-1' /> public fiphoboserver::FIPhoboServerException::FIPhoboServerException (const char *message)
### <a name='deimos-DeimosException-DeimosException-1' /> public deimos::DeimosException::DeimosException (const char *message)
constructor for a message with information on the exception
......@@ -83,9 +83,9 @@ constructor for a message with information on the exception
* inline
[Go to Top](#fiphoboserver-FIPhoboServerException)
[Go to Top](#deimos-DeimosException)
### <a name='fiphoboserver-FIPhoboServerException-what' /> public const char * fiphoboserver::FIPhoboServerException::what () const noexcept override
### <a name='deimos-DeimosException-what' /> public const char * deimos::DeimosException::what () const noexcept override
get information on this exception
......@@ -114,9 +114,9 @@ get information on this exception
* virtual
[Go to Top](#fiphoboserver-FIPhoboServerException)
[Go to Top](#deimos-DeimosException)
### <a name='fiphoboserver-FIPhoboServerException-get_inner_error' /> public int fiphoboserver::FIPhoboServerException::get_inner_error () const noexcept
### <a name='deimos-DeimosException-get_inner_error' /> public int deimos::DeimosException::get_inner_error () const noexcept
return the inner error value that caused this exception
......@@ -138,7 +138,7 @@ return the inner error value that caused this exception
* virtual
[Go to Top](#fiphoboserver-FIPhoboServerException)
[Go to Top](#deimos-DeimosException)
[fiphoboserver-IOException]:./IOException.md
[fiphoboserver-storage-PhobosException]:./storage/PhobosException.md
[deimos-IOException]:./IOException.md
[deimos-storage-PhobosException]:./storage/PhobosException.md
# <a name='fiphoboserver-GetRequestHandler' /> public fiphoboserver::GetRequestHandler
# <a name='deimos-GetRequestHandler' /> public deimos::GetRequestHandler
proxygen class implementation for handling GET requests
......@@ -11,20 +11,20 @@ Inherits from RequestHandler.
## Public Functions
| Name | Description |
| ---- | ---- |
| [onRequest](#fiphoboserver-GetRequestHandler-onRequest) | first function to be called when a new request comes in |
| [onBody](#fiphoboserver-GetRequestHandler-onBody) | function called on every body chunk belonging to this message |
| [onEOM](#fiphoboserver-GetRequestHandler-onEOM) | function called when the incoming message is finished |
| [onUpgrade](#fiphoboserver-GetRequestHandler-onUpgrade) | function called on upgrade |
| [requestComplete](#fiphoboserver-GetRequestHandler-requestComplete) | function ... |
| [onError](#fiphoboserver-GetRequestHandler-onError) | function called when an error occurred |
| [onEgressPaused](#fiphoboserver-GetRequestHandler-onEgressPaused) | called when the queue is full. |
| [onEgressResumed](#fiphoboserver-GetRequestHandler-onEgressResumed) | called when the queue is not longer full. |
| [GetRequestHandler](#fiphoboserver-GetRequestHandler-GetRequestHandler) | Constructor for stream class initialization. |
| [onRequest](#deimos-GetRequestHandler-onRequest) | first function to be called when a new request comes in |
| [onBody](#deimos-GetRequestHandler-onBody) | function called on every body chunk belonging to this message |
| [onEOM](#deimos-GetRequestHandler-onEOM) | function called when the incoming message is finished |
| [onUpgrade](#deimos-GetRequestHandler-onUpgrade) | function called on upgrade |
| [requestComplete](#deimos-GetRequestHandler-requestComplete) | function ... |
| [onError](#deimos-GetRequestHandler-onError) | function called when an error occurred |
| [onEgressPaused](#deimos-GetRequestHandler-onEgressPaused) | called when the queue is full. |
| [onEgressResumed](#deimos-GetRequestHandler-onEgressResumed) | called when the queue is not longer full. |
| [GetRequestHandler](#deimos-GetRequestHandler-GetRequestHandler) | Constructor for stream class initialization. |
## Public Functions
### <a name='fiphoboserver-GetRequestHandler-onRequest' /> public void fiphoboserver::GetRequestHandler::onRequest (std::unique_ptr< proxygen::HTTPMessage > headers) noexcept override
### <a name='deimos-GetRequestHandler-onRequest' /> public void deimos::GetRequestHandler::onRequest (std::unique_ptr< proxygen::HTTPMessage > headers) noexcept override
first function to be called when a new request comes in
......@@ -47,9 +47,9 @@ first function to be called when a new request comes in
[Go to Top](#fiphoboserver-GetRequestHandler)
[Go to Top](#deimos-GetRequestHandler)
### <a name='fiphoboserver-GetRequestHandler-onBody' /> public void fiphoboserver::GetRequestHandler::onBody (std::unique_ptr< folly::IOBuf > body) noexcept override
### <a name='deimos-GetRequestHandler-onBody' /> public void deimos::GetRequestHandler::onBody (std::unique_ptr< folly::IOBuf > body) noexcept override
function called on every body chunk belonging to this message
......@@ -72,9 +72,9 @@ This is not used in this case because GET requests don't usually have a body
[Go to Top](#fiphoboserver-GetRequestHandler)
[Go to Top](#deimos-GetRequestHandler)
### <a name='fiphoboserver-GetRequestHandler-onEOM' /> public void fiphoboserver::GetRequestHandler::onEOM () noexcept override
### <a name='deimos-GetRequestHandler-onEOM' /> public void deimos::GetRequestHandler::onEOM () noexcept override
function called when the incoming message is finished
......@@ -85,9 +85,9 @@ function called when the incoming message is finished
[Go to Top](#fiphoboserver-GetRequestHandler)
[Go to Top](#deimos-GetRequestHandler)
### <a name='fiphoboserver-GetRequestHandler-onUpgrade' /> public void fiphoboserver::GetRequestHandler::onUpgrade (proxygen::UpgradeProtocol proto) noexcept override
### <a name='deimos-GetRequestHandler-onUpgrade' /> public void deimos::GetRequestHandler::onUpgrade (proxygen::UpgradeProtocol proto) noexcept override
function called on upgrade
......@@ -111,9 +111,9 @@ Not supported in our case!
[Go to Top](#fiphoboserver-GetRequestHandler)
[Go to Top](#deimos-GetRequestHandler)
### <a name='fiphoboserver-GetRequestHandler-requestComplete' /> public void fiphoboserver::GetRequestHandler::requestComplete () noexcept override
### <a name='deimos-GetRequestHandler-requestComplete' /> public void deimos::GetRequestHandler::requestComplete () noexcept override
function ...
......@@ -131,9 +131,9 @@ function ...
[Go to Top](#fiphoboserver-GetRequestHandler)
[Go to Top](#deimos-GetRequestHandler)
### <a name='fiphoboserver-GetRequestHandler-onError' /> public void fiphoboserver::GetRequestHandler::onError (proxygen::ProxygenError err) noexcept override
### <a name='deimos-GetRequestHandler-onError' /> public void deimos::GetRequestHandler::onError (proxygen::ProxygenError err) noexcept override
function called when an error occurred
......@@ -157,9 +157,9 @@ Not supported in our case!
[Go to Top](#fiphoboserver-GetRequestHandler)
[Go to Top](#deimos-GetRequestHandler)
### <a name='fiphoboserver-GetRequestHandler-onEgressPaused' /> public void fiphoboserver::GetRequestHandler::onEgressPaused () noexcept override
### <a name='deimos-GetRequestHandler-onEgressPaused' /> public void deimos::GetRequestHandler::onEgressPaused () noexcept override
called when the queue is full.
......@@ -177,9 +177,9 @@ Contents are copies from a proxygen example
[Go to Top](#fiphoboserver-GetRequestHandler)
[Go to Top](#deimos-GetRequestHandler)
### <a name='fiphoboserver-GetRequestHandler-onEgressResumed' /> public void fiphoboserver::GetRequestHandler::onEgressResumed () noexcept override
### <a name='deimos-GetRequestHandler-onEgressResumed' /> public void deimos::GetRequestHandler::onEgressResumed () noexcept override
called when the queue is not longer full.
......@@ -197,9 +197,9 @@ Contents are copies from a proxygen example
[Go to Top](#fiphoboserver-GetRequestHandler)
[Go to Top](#deimos-GetRequestHandler)
### <a name='fiphoboserver-GetRequestHandler-GetRequestHandler' /> public fiphoboserver::GetRequestHandler::GetRequestHandler (std::unique_ptr< stream::Stream > input_stream)
### <a name='deimos-GetRequestHandler-GetRequestHandler' /> public deimos::GetRequestHandler::GetRequestHandler (std::unique_ptr< stream::Stream > input_stream)
Constructor for stream class initialization.
......@@ -209,7 +209,7 @@ Constructor for stream class initialization.
#### Parameters:
| Type | Name | Description |
| ---- | ---- | ---- |
| std::unique_ptr< [stream::Stream][fiphoboserver-stream-Stream] > | input_stream | [stream::Stream][fiphoboserver-stream-Stream] class instance to initialize the server |
| std::unique_ptr< [stream::Stream][deimos-stream-Stream] > | input_stream | [stream::Stream][deimos-stream-Stream] class instance to initialize the server |
......@@ -226,7 +226,7 @@ Constructor for stream class initialization.
* inline
[Go to Top](#fiphoboserver-GetRequestHandler)
[Go to Top](#deimos-GetRequestHandler)
[fiphoboserver-stream-Stream]:./stream/Stream.md
[deimos-stream-Stream]:./stream/Stream.md
[todo]:./../todo.md#todo
# <a name='fiphoboserver-GetmdRequestHandler' /> public fiphoboserver::GetmdRequestHandler
# <a name='deimos-GetmdRequestHandler' /> public deimos::GetmdRequestHandler
proxygen class implementation for handling HEAD requests
......@@ -11,18 +11,18 @@ Inherits from RequestHandler.
## Public Functions
| Name | Description |
| ---- | ---- |
| [onRequest](#fiphoboserver-GetmdRequestHandler-onRequest) | first function to be called when a new request comes in |
| [onBody](#fiphoboserver-GetmdRequestHandler-onBody) | function called on every body chunk belonging to this message |
| [onEOM](#fiphoboserver-GetmdRequestHandler-onEOM) | function called when the incoming message is finished |
| [onUpgrade](#fiphoboserver-GetmdRequestHandler-onUpgrade) | function called on upgrade |
| [requestComplete](#fiphoboserver-GetmdRequestHandler-requestComplete) | function ... |
| [onError](#fiphoboserver-GetmdRequestHandler-onError) | function called when an error occurred |
| [GetmdRequestHandler](#fiphoboserver-GetmdRequestHandler-GetmdRequestHandler) | Constructor for stream class initialization. |
| [onRequest](#deimos-GetmdRequestHandler-onRequest) | first function to be called when a new request comes in |
| [onBody](#deimos-GetmdRequestHandler-onBody) | function called on every body chunk belonging to this message |
| [onEOM](#deimos-GetmdRequestHandler-onEOM) | function called when the incoming message is finished |
| [onUpgrade](#deimos-GetmdRequestHandler-onUpgrade) | function called on upgrade |
| [requestComplete](#deimos-GetmdRequestHandler-requestComplete) | function ... |
| [onError](#deimos-GetmdRequestHandler-onError) | function called when an error occurred |
| [GetmdRequestHandler](#deimos-GetmdRequestHandler-GetmdRequestHandler) | Constructor for stream class initialization. |
## Public Functions
### <a name='fiphoboserver-GetmdRequestHandler-onRequest' /> public void fiphoboserver::GetmdRequestHandler::onRequest (std::unique_ptr< proxygen::HTTPMessage > headers) noexcept override
### <a name='deimos-GetmdRequestHandler-onRequest' /> public void deimos::GetmdRequestHandler::onRequest (std::unique_ptr< proxygen::HTTPMessage > headers) noexcept override
first function to be called when a new request comes in
......@@ -45,9 +45,9 @@ first function to be called when a new request comes in
[Go to Top](#fiphoboserver-GetmdRequestHandler)
[Go to Top](#deimos-GetmdRequestHandler)
### <a name='fiphoboserver-GetmdRequestHandler-onBody' /> public void fiphoboserver::GetmdRequestHandler::onBody (std::unique_ptr< folly::IOBuf > body) noexcept override
### <a name='deimos-GetmdRequestHandler-onBody' /> public void deimos::GetmdRequestHandler::onBody (std::unique_ptr< folly::IOBuf > body) noexcept override
function called on every body chunk belonging to this message
......@@ -70,9 +70,9 @@ This is not used in this case because GET requests don't usually have a body
[Go to Top](#fiphoboserver-GetmdRequestHandler)
[Go to Top](#deimos-GetmdRequestHandler)
### <a name='fiphoboserver-GetmdRequestHandler-onEOM' /> public void fiphoboserver::GetmdRequestHandler::onEOM () noexcept override
### <a name='deimos-GetmdRequestHandler-onEOM' /> public void deimos::GetmdRequestHandler::onEOM () noexcept override
function called when the incoming message is finished
......@@ -83,9 +83,9 @@ function called when the incoming message is finished
[Go to Top](#fiphoboserver-GetmdRequestHandler)
[Go to Top](#deimos-GetmdRequestHandler)
### <a name='fiphoboserver-GetmdRequestHandler-onUpgrade' /> public void fiphoboserver::GetmdRequestHandler::onUpgrade (proxygen::UpgradeProtocol proto) noexcept override
### <a name='deimos-GetmdRequestHandler-onUpgrade' /> public void deimos::GetmdRequestHandler::onUpgrade (proxygen::UpgradeProtocol proto) noexcept override
function called on upgrade
......@@ -109,9 +109,9 @@ Not supported in our case!
[Go to Top](#fiphoboserver-GetmdRequestHandler)
[Go to Top](#deimos-GetmdRequestHandler)
### <a name='fiphoboserver-GetmdRequestHandler-requestComplete' /> public void fiphoboserver::GetmdRequestHandler::requestComplete () noexcept override
### <a name='deimos-GetmdRequestHandler-requestComplete' /> public void deimos::GetmdRequestHandler::requestComplete () noexcept override
function ...
......@@ -129,9 +129,9 @@ function ...
[Go to Top](#fiphoboserver-GetmdRequestHandler)
[Go to Top](#deimos-GetmdRequestHandler)
### <a name='fiphoboserver-GetmdRequestHandler-onError' /> public void fiphoboserver::GetmdRequestHandler::onError (proxygen::ProxygenError err) noexcept override
### <a name='deimos-GetmdRequestHandler-onError' /> public void deimos::GetmdRequestHandler::onError (proxygen::ProxygenError err) noexcept override
function called when an error occurred
......@@ -155,9 +155,9 @@ Not supported in our case!
[Go to Top](#fiphoboserver-GetmdRequestHandler)
[Go to Top](#deimos-GetmdRequestHandler)
### <a name='fiphoboserver-GetmdRequestHandler-GetmdRequestHandler' /> public fiphoboserver::GetmdRequestHandler::GetmdRequestHandler (std::unique_ptr< stream::Stream > input_stream)
### <a name='deimos-GetmdRequestHandler-GetmdRequestHandler' /> public deimos::GetmdRequestHandler::GetmdRequestHandler (std::unique_ptr< stream::Stream > input_stream)
Constructor for stream class initialization.
......@@ -167,7 +167,7 @@ Constructor for stream class initialization.
#### Parameters:
| Type | Name | Description |
| ---- | ---- | ---- |
| std::unique_ptr< [stream::Stream][fiphoboserver-stream-Stream] > | input_stream | [stream::Stream][fiphoboserver-stream-Stream] class instance to initialize the server |
| std::unique_ptr< [stream::Stream][deimos-stream-Stream] > | input_stream | [stream::Stream][deimos-stream-Stream] class instance to initialize the server |
......@@ -184,7 +184,7 @@ Constructor for stream class initialization.
* inline
[Go to Top](#fiphoboserver-GetmdRequestHandler)
[Go to Top](#deimos-GetmdRequestHandler)
[fiphoboserver-stream-Stream]:./stream/Stream.md
[deimos-stream-Stream]:./stream/Stream.md
[todo]:./../todo.md#todo
# <a name='fiphoboserver-HandlerFactory' /> public fiphoboserver::HandlerFactory
# <a name='deimos-HandlerFactory' /> public deimos::HandlerFactory
factory to create the handlers for incoming HTTP requests
......@@ -6,7 +6,7 @@ factory to create the handlers for incoming HTTP requests
Depending on the method (GET, PUT, HEAD) this class creates an object of the corresponding request handler.
All other requests result in an object of [UnsupportedRequestHandler][fiphoboserver-UnsupportedRequestHandler], that will then send an 400 Bad request response.
All other requests result in an object of [UnsupportedRequestHandler][deimos-UnsupportedRequestHandler], that will then send an 400 Bad request response.
......@@ -17,14 +17,14 @@ Inherits from RequestHandlerFactory.
## Public Functions
| Name | Description |
| ---- | ---- |
| [onServerStart](#fiphoboserver-HandlerFactory-onServerStart) | function that gets called when the server starts |
| [onServerStop](#fiphoboserver-HandlerFactory-onServerStop) | function that gets called when the server stops |
| [onRequest](#fiphoboserver-HandlerFactory-onRequest) | this function gets called whenever a request reaches the server |
| [onServerStart](#deimos-HandlerFactory-onServerStart) | function that gets called when the server starts |
| [onServerStop](#deimos-HandlerFactory-onServerStop) | function that gets called when the server stops |
| [onRequest](#deimos-HandlerFactory-onRequest) | this function gets called whenever a request reaches the server |