ripple::Server Class Reference

A multi-protocol server. More...

#include <ServerImpl.h>

Inheritance diagram for ripple::Server:

Public Member Functions
virtual	~Server ()=default
	Destroy the server.
virtual beast::Journal	journal ()=0
	Returns the Journal associated with the server.
virtual Endpoints	ports (std::vector< Port > const &v)=0
	Set the listening port settings.
virtual void	close ()=0
	Close the server.

Detailed Description

A multi-protocol server.

This server maintains multiple configured listening ports, with each listening port allows for multiple protocols including HTTP, HTTP/S, WebSocket, Secure WebSocket, and the Peer protocol.

Definition at line 49 of file ServerImpl.h.

Constructor & Destructor Documentation

~Server()

virtual ripple::Server::~Server ( )

virtualdefault

Destroy the server.

The server is closed if it is not already closed. This call blocks until the server has stopped.

Member Function Documentation

journal()

virtual beast::Journal ripple::Server::journal ( )

pure virtual

Returns the Journal associated with the server.

Implemented in ripple::ServerImpl< Handler >.

ports()

virtual Endpoints ripple::Server::ports ( std::vector< Port > const &  v )

pure virtual

Set the listening port settings.

This may only be called once.

Implemented in ripple::ServerImpl< Handler >.

close()

virtual void ripple::Server::close ( )

pure virtual

Close the server.

The close is performed asynchronously. The handler will be notified when the server has stopped. The server is considered stopped when there are no pending I/O completion handlers and all connections have closed. Thread safety: Safe to call concurrently from any thread.

Implemented in ripple::ServerImpl< Handler >.