io_endpoint.h

Go to the documentation of this file.

// Copyright (C) 2010-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 IO_ENDPOINT_H
#define IO_ENDPOINT_H 1
 
// IMPORTANT NOTE: only very few ASIO headers files can be included in
// this file.  In particular, asio.hpp should never be included here.
// See the description of the namespace below.
 
#include <functional>
#include <string>
 
#include <exceptions/exceptions.h>
#include <asiolink/io_address.h>
 
# include <ostream>
 
#include <unistd.h>             // for some network system calls
 
#include <sys/socket.h>         // for sockaddr
 
namespace isc {
namespace asiolink {

class IOEndpoint {

private:
    IOEndpoint(const IOEndpoint& source);
    IOEndpoint& operator=(const IOEndpoint& source);
protected:
    IOEndpoint() {}
public:
    virtual ~IOEndpoint() {}

    virtual IOAddress getAddress() const = 0;

    virtual uint16_t getPort() const = 0;

    virtual short getProtocol() const = 0;

    virtual short getFamily() const = 0;

    virtual const struct sockaddr& getSockAddr() const = 0;
 
    bool operator==(const IOEndpoint& other) const;
    bool operator!=(const IOEndpoint& other) const;

    static const IOEndpoint* create(const int protocol,
                                    const IOAddress& address,
                                    const unsigned short port);
};

std::ostream& operator<<(std::ostream& os, const IOEndpoint& endpoint);
}  // namespace asiolink
}  // namespace isc
#endif // IO_ENDPOINT_H