mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
2cb3834bbb
Beast.WebSocket provides developers with a robust WebSocket implementation built on Boost.Asio with a consistent asynchronous model using a modern C++ approach.
73 lines
2.3 KiB
C++
73 lines
2.3 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of rippled: https://github.com/ripple/rippled
|
|
Copyright (c) 2012, 2013 Ripple Labs Inc.
|
|
|
|
Permission to use, copy, modify, and/or distribute this software for any
|
|
purpose with or without fee is hereby granted, provided that the above
|
|
copyright notice and this permission notice appear in all copies.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#ifndef RIPPLE_SERVER_SERVER_H_INCLUDED
|
|
#define RIPPLE_SERVER_SERVER_H_INCLUDED
|
|
|
|
#include <ripple/server/Port.h>
|
|
#include <ripple/beast/utility/Journal.h>
|
|
#include <ripple/beast/utility/PropertyStream.h>
|
|
|
|
namespace ripple {
|
|
|
|
/** 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.
|
|
*/
|
|
class Server
|
|
{
|
|
public:
|
|
/** Destroy the server.
|
|
The server is closed if it is not already closed. This call
|
|
blocks until the server has stopped.
|
|
*/
|
|
virtual
|
|
~Server() = default;
|
|
|
|
/** Returns the Journal associated with the server. */
|
|
virtual
|
|
beast::Journal
|
|
journal() = 0;
|
|
|
|
/** Set the listening port settings.
|
|
This may only be called once.
|
|
*/
|
|
virtual
|
|
void
|
|
ports (std::vector<Port> const& v) = 0;
|
|
|
|
/** 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.
|
|
*/
|
|
virtual
|
|
void
|
|
close() = 0;
|
|
};
|
|
|
|
} // ripple
|
|
|
|
#endif
|