RestLink::Server Class Reference

#include <server.h>

Inherits QObject, and RestLink::AbstractRequestHandler.

Public Types
enum	ServerType { Synchronous , Asynchronous }
Public Types inherited from RestLink::AbstractRequestHandler
enum	Method {   HeadMethod , GetMethod , PostMethod , PutMethod ,   PatchMethod , DeleteMethod , UnknownMethod = -1 }
	Defines supported HTTP methods for handling outgoing requests. More...
enum	HandlerType { NetworkManager , ServerHandler , UnknownHandler = -1 }
	Describes the type of request handler being used. More...

Signals
void	stateChanged (bool listening)
void	errorOccured (int error)

Public Member Functions
	Server (QObject *parent=nullptr)
	Server (ServerType type, QObject *parent=nullptr)
virtual	~Server ()
bool	isListening () const
void	listen ()
void	close ()
QJsonObject	configuration () const
int	error () const
QString	errorString () const
void	registerController (AbstractController *controller)
HandlerType	handlerType () const override
Public Member Functions inherited from RestLink::AbstractRequestHandler
virtual	~AbstractRequestHandler ()
	Destructor for RequestHandler.
virtual QString	handlerName () const
	Returns the name of the handler based on its type.
Response *	head (const Request &request)
	Sends a HEAD request.
Response *	get (const Request &request)
	Sends a GET request.
Response *	post (const Request &request, const Body &body)
	Sends a POST request.
Response *	put (const Request &request, const Body &body)
	Sends a PUT request.
Response *	patch (const Request &request, const Body &body)
	Sends a PATCH request.
Response *	deleteResource (const Request &request)
	Sends a DELETE request.
Response *	send (Method method, const Request &request, const Body &body)
QList< AbstractRequestInterceptor * >	requestInterceptors () const
	Returns the list of registered request interceptors.
void	addRequestInterceptor (AbstractRequestInterceptor *interceptor)
	Adds a new request interceptor.
void	removeRequestInterceptor (AbstractRequestInterceptor *interceptor)
	Removes a request interceptor.
virtual QStringList	supportedSchemes () const =0

Protected Member Functions
	Server (ServerPrivate *d, QObject *parent)
virtual bool	init ()=0
virtual void	cleanup ()=0
virtual bool	maintain ()=0
ServerResponse *	sendRequest (Method method, const Request &request, const Body &body) override final
virtual void	processInternalRequest (const ServerRequest &request, ServerResponse *response)
virtual void	processStandardRequest (const ServerRequest &request, ServerResponse *response)
void	processUnsupportedRequest (const ServerRequest &request, ServerResponse *response)
virtual AbstractController *	findController (const ServerRequest &request) const
virtual void	prepareController (AbstractController *controller, const ServerRequest &request, ServerResponse *response)
void	setError (int code, const QString &str)
Protected Member Functions inherited from RestLink::AbstractRequestHandler
	AbstractRequestHandler ()
bool	isRequestSupported (const Request &request) const
	Checks if the request is supported by this handler.
void	initResponse (Response *response, const Request &request, Method method)
	Initializes the response object with the associated request.

Protected Attributes
QScopedPointer< ServerPrivate >	d_ptr
Protected Attributes inherited from RestLink::AbstractRequestHandler
QScopedPointer< AbstractRequestHandlerPrivate >	d_ptr

Member Enumeration Documentation

ServerType

enum RestLink::Server::ServerType

Enumerator
Synchronous
Asynchronous

Constructor & Destructor Documentation

Server() [1/3]

RestLink::Server::Server ( QObject *  parent = nullptr )

explicit

Server() [2/3]

RestLink::Server::Server	(	ServerType	type,
		QObject *	parent = nullptr
	)

~Server()

RestLink::Server::~Server ( )

virtual

Server() [3/3]

RestLink::Server::Server ( ServerPrivate *  d, QObject *  parent  )

protected

Member Function Documentation

isListening()

bool RestLink::Server::isListening

(

)

const

listen()

void RestLink::Server::listen

(

)

close()

void RestLink::Server::close

(

)

configuration()

QJsonObject RestLink::Server::configuration

(

)

const

error()

int RestLink::Server::error

(

)

const

errorString()

QString RestLink::Server::errorString

(

)

const

registerController()

void RestLink::Server::registerController

(

AbstractController *

controller

)

handlerType()

AbstractRequestHandler::HandlerType RestLink::Server::handlerType ( ) const

overridevirtual

Implements RestLink::AbstractRequestHandler.

stateChanged

void RestLink::Server::stateChanged ( bool  listening )

signal

errorOccured

void RestLink::Server::errorOccured ( int  error )

signal

init()

virtual bool RestLink::Server::init ( )

protectedpure virtual

cleanup()

virtual void RestLink::Server::cleanup ( )

protectedpure virtual

maintain()

virtual bool RestLink::Server::maintain ( )

protectedpure virtual

sendRequest()

ServerResponse * RestLink::Server::sendRequest ( Method  method, const Request &  request, const Body &  body  )

finaloverrideprotectedvirtual

Implements RestLink::AbstractRequestHandler.

processInternalRequest()

void RestLink::Server::processInternalRequest ( const ServerRequest &  request, ServerResponse *  response  )

protectedvirtual

processStandardRequest()

void RestLink::Server::processStandardRequest ( const ServerRequest &  request, ServerResponse *  response  )

protectedvirtual

processUnsupportedRequest()

void RestLink::Server::processUnsupportedRequest ( const ServerRequest &  request, ServerResponse *  response  )

protected

findController()

AbstractController * RestLink::Server::findController ( const ServerRequest &  request ) const

protectedvirtual

prepareController()

void RestLink::Server::prepareController ( AbstractController *  controller, const ServerRequest &  request, ServerResponse *  response  )

protectedvirtual

setError()

void RestLink::Server::setError ( int  code, const QString &  str  )

protected

Member Data Documentation

d_ptr

QScopedPointer<ServerPrivate> RestLink::Server::d_ptr

protected