server.hpp

Go to the documentation of this file.

/*
 * Copyright 2022 Robert Bosch GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <memory>  // for unique_ptr<>
 
#include <cloe/registrar.hpp>  // for Registrar
#include <cloe/stack.hpp>
 
#include "utility/defer.hpp"  // for Defer
 
namespace engine {
 
class ServerRegistrar {
 public:
  virtual ~ServerRegistrar() = default;
 
  [[nodiscard]] virtual std::unique_ptr<ServerRegistrar> clone() const = 0;
 
  [[nodiscard]] virtual std::unique_ptr<ServerRegistrar> with_prefix(const std::string& static_prefix,
                                                       const std::string& api_prefix) const = 0;
 
  virtual void register_static_handler(const std::string& endpoint, cloe::Handler h) = 0;
 
  virtual void register_api_handler(const std::string& endpoint, cloe::HandlerType t,
                                    cloe::Handler h) = 0;
};
 
class Server {
 public:
  Server(const Server&) = default;
  Server(Server&&) = delete;
  Server& operator=(const Server&) = default;
  Server& operator=(Server&&) = delete;
  Server(cloe::ServerConf config) : config_(std::move(config)) {}
  virtual ~Server() = default;
 
  [[nodiscard]] const cloe::ServerConf& config() const { return config_; }
 
  [[nodiscard]] virtual bool is_listening() const = 0;
 
  [[nodiscard]] virtual bool is_streaming() const = 0;
 
  virtual void start() = 0;
 
  virtual void stop() = 0;
 
  virtual void init_stream(const std::string& filename) = 0;
 
  virtual void enroll(cloe::Registrar& r) = 0;
 
  [[nodiscard]] virtual std::unique_ptr<ServerRegistrar> server_registrar() = 0;
 
  virtual void refresh_buffer_start_stream() = 0;
 
  virtual void refresh_buffer() = 0;
 
  [[nodiscard]] virtual std::vector<std::string> endpoints() const = 0;
 
  [[nodiscard]] virtual Defer lock() = 0;
 
 protected:
  cloe::Logger logger() const { return cloe::logger::get("cloe"); }
  cloe::ServerConf config_;
};
 
std::unique_ptr<Server> make_server(const cloe::ServerConf&);
 
}  // namespace engine