listener.h

Go to the documentation of this file.

// Copyright (C) 2017-2025 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 HTTP_LISTENER_H
#define HTTP_LISTENER_H
 
#include <asiolink/io_address.h>
#include <asiolink/io_service.h>
#include <asiolink/crypto_tls.h>
#include <exceptions/exceptions.h>
#include <http/response_creator_factory.h>
#include <boost/shared_ptr.hpp>
#include <cstdint>
 
namespace isc {
namespace http {

class HttpListenerError : public Exception {
public:
    HttpListenerError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { }
};

class HttpListenerImpl;

class HttpListener {
public:

    struct RequestTimeout {
        explicit RequestTimeout(long value)
            : value_(value) {
        }
        long value_; 
    };

    struct IdleTimeout {
        explicit IdleTimeout(long value)
            : value_(value) {
        }
        long value_; 
    };

    HttpListener(const asiolink::IOServicePtr& io_service,
                 const asiolink::IOAddress& server_address,
                 const unsigned short server_port,
                 const asiolink::TlsContextPtr& tls_context,
                 const HttpResponseCreatorFactoryPtr& creator_factory,
                 const RequestTimeout& request_timeout,
                 const IdleTimeout& idle_timeout);

    ~HttpListener();

    asiolink::IOAddress getLocalAddress() const;

    uint16_t getLocalPort() const;

    const asiolink::TlsContextPtr& getTlsContext() const;

    void setTlsContext(const asiolink::TlsContextPtr& context);

    int getNative() const;

    void addExternalSockets(bool use_external = false);

    void start();

    void stop();
 
protected:

    boost::shared_ptr<HttpListenerImpl> impl_;
};

typedef boost::shared_ptr<HttpListener> HttpListenerPtr;

typedef boost::shared_ptr<const HttpListener> ConstHttpListenerPtr;
 
} // end of namespace isc::http
} // end of namespace isc
 
#endif