f3eade2f62
Drop the AGPL license in favor of a source-available license. See the blog post [1] for details. [1] https://www.scylladb.com/2024/12/18/why-were-moving-to-a-source-available-license/
52 lines
1.9 KiB
C++
52 lines
1.9 KiB
C++
/*
|
|
* Copyright (C) 2021-present ScyllaDB
|
|
*/
|
|
|
|
/*
|
|
* SPDX-License-Identifier: LicenseRef-ScyllaDB-Source-Available-1.0
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "seastarx.hh"
|
|
#include <seastar/core/future.hh>
|
|
#include <seastar/net/socket_defs.hh>
|
|
#include <vector>
|
|
#include "client_data.hh"
|
|
#include "utils/chunked_vector.hh"
|
|
|
|
struct client_data;
|
|
|
|
// Abstraction for a server serving some kind of user-facing protocol.
|
|
class protocol_server {
|
|
protected:
|
|
seastar::scheduling_group _sched_group;
|
|
public:
|
|
virtual ~protocol_server() = default;
|
|
/// Name of the server, can be different or the same as than the protocol it serves.
|
|
virtual sstring name() const = 0;
|
|
/// Name of the protocol served.
|
|
virtual sstring protocol() const = 0;
|
|
/// Version of the protocol served (if any -- not all protocols are versioned).
|
|
virtual sstring protocol_version() const = 0;
|
|
/// Addresses the server is listening on, shall be empty when server is not running.
|
|
virtual std::vector<socket_address> listen_addresses() const = 0;
|
|
/// Start the server.
|
|
/// Can be called multiple times, in any state of the server.
|
|
virtual future<> start_server() = 0;
|
|
/// Stop the server.
|
|
/// Can be called multiple times, in any state of the server.
|
|
/// This variant is used on shutdown and therefore it must succeed.
|
|
virtual future<> stop_server() = 0;
|
|
/// Stop the server. Weaker variant of \ref stop_server().
|
|
/// Can be called multiple times, in any state of the server.
|
|
/// This variant is used by the REST API so failure is acceptable.
|
|
virtual future<> request_stop_server() = 0;
|
|
|
|
virtual future<utils::chunked_vector<client_data>> get_client_data() {
|
|
return make_ready_future<utils::chunked_vector<client_data>>(utils::chunked_vector<client_data>());
|
|
}
|
|
|
|
protocol_server(seastar::scheduling_group sg) noexcept : _sched_group(std::move(sg)) {}
|
|
};
|