cmd_http_listener.h

Go to the documentation of this file.

// Copyright (C) 2021-2022 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#ifndef CMD_HTTP_LISTENER_H
#define CMD_HTTP_LISTENER_H
 
#include <asiolink/io_address.h>
#include <asiolink/io_service.h>
#include <asiolink/io_service_thread_pool.h>
#include <http/auth_config.h>
#include <http/listener.h>
#include <thread>
#include <vector>
 
namespace isc {
namespace config {

class CmdHttpListener {
public:
    CmdHttpListener(const asiolink::IOAddress& address, const uint16_t port,
                    const uint16_t thread_pool_size = 1,
                    asiolink::TlsContextPtr context = asiolink::TlsContextPtr(),
                    http::HttpAuthConfigPtr http_auth_config = http::HttpAuthConfigPtr(),
                    std::unordered_set<std::string> command_accept_list = {});

    virtual ~CmdHttpListener();

    void checkPermissions();

    void start();

    void pause();

    void resume();

    void stop();

    bool isRunning();

    bool isStopped();

    bool isPaused();

    isc::asiolink::IOAddress getAddress() const {
        return (address_);
    }

    uint16_t getPort() const {
        return (port_);
    }

    uint16_t getThreadPoolSize() const {
        return (thread_pool_size_);
    }

    asiolink::TlsContextPtr getTlsContext() const {
        return (tls_context_);
    }

    uint16_t getThreadCount() const {
        if (!thread_pool_) {
            return (0);
        }
 
        return (thread_pool_->getThreadCount());
    }

    asiolink::IOServicePtr getThreadIOService() const {
        return (thread_io_service_);
    }

    http::HttpAuthConfigPtr getAuthConfig() const {
        return (http_auth_config_);
    }

    std::unordered_set<std::string> getCommandAcceptList() const {
        return (command_accept_list_);
    }
 
private:
    isc::asiolink::IOAddress address_;

    uint16_t port_;

    isc::asiolink::IOServicePtr thread_io_service_;

    http::HttpListenerPtr http_listener_;

    std::size_t thread_pool_size_;

    asiolink::IoServiceThreadPoolPtr thread_pool_;

    asiolink::TlsContextPtr tls_context_;

    http::HttpAuthConfigPtr http_auth_config_;

    std::unordered_set<std::string> command_accept_list_;
};

typedef boost::shared_ptr<CmdHttpListener> CmdHttpListenerPtr;
 
} // namespace isc::config
} // namespace isc
 
#endif // CMD_HTTP_LISTENER_H