tcp_listener.h

Go to the documentation of this file.

// Copyright (C) 2022-2024 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 TCP_LISTENER_H
#define TCP_LISTENER_H
 
#include <asiolink/io_service.h>
#include <asiolink/io_address.h>
#include <asiolink/tcp_endpoint.h>
#include <tcp/tcp_connection_pool.h>
#include <boost/scoped_ptr.hpp>
 
namespace isc {
namespace tcp {
 
class TcpListenerError : public Exception {
public:
    TcpListenerError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { }
};
 
class TcpListener {
public:
    struct IdleTimeout {
        explicit IdleTimeout(long value)
            : value_(value) {
        }
        long value_; 
    };
 
    TcpListener(const asiolink::IOServicePtr& io_service,
                const asiolink::IOAddress& server_address,
                const unsigned short server_port,
                const asiolink::TlsContextPtr& tls_context,
                const IdleTimeout& idle_timeout,
                const TcpConnectionFilterCallback& connection_filter = 0);
 
    virtual ~TcpListener();
 
    const asiolink::TCPEndpoint& getEndpoint() const;
 
    void start();
 
    void stop();
 
    asiolink::IOAddress getLocalAddress() const;
 
    uint16_t getLocalPort() const;
 
    long getIdleTimeout() const {
        return (idle_timeout_);
    }
 
    size_t usedByRemoteIp(const asiolink::IOAddress& remote_ip,
                          size_t& total_connections) {
        return (connections_.usedByRemoteIp(remote_ip, total_connections));
    }
 
protected:
 
    void accept();
 
    void acceptHandler(const boost::system::error_code& ec);
 
    virtual TcpConnectionPtr createConnection(
        const TcpConnectionAcceptorCallback& acceptor_callback,
        const TcpConnectionFilterCallback& connection_filter);
 
    asiolink::IOServicePtr io_service_;
 
    asiolink::TlsContextPtr tls_context_;
 
    TcpConnectionAcceptorPtr acceptor_;
 
    boost::scoped_ptr<asiolink::TCPEndpoint> endpoint_;
 
    TcpConnectionPool connections_;
 
    long idle_timeout_;
 
    TcpConnectionFilterCallback connection_filter_;
};
 
typedef boost::shared_ptr<TcpListener> TcpListenerPtr;
 
} // end of namespace isc::asiolink
} // end of namespace isc
 
#endif // TCP_LISTENER_H