unix_domain_socket.h

Go to the documentation of this file.

// Copyright (C) 2017-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 UNIX_DOMAIN_SOCKET_H
#define UNIX_DOMAIN_SOCKET_H
 
#include <asiolink/io_service.h>
#include <asiolink/io_socket.h>
#include <boost/shared_ptr.hpp>
#include <functional>
#include <string>
 
namespace isc {
namespace asiolink {

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

class UnixDomainSocket : public IOSocket {
public:

    typedef std::function<void(const boost::system::error_code&)> ConnectHandler;

    typedef std::function<void(const boost::system::error_code&, size_t)> Handler;

    explicit UnixDomainSocket(const IOServicePtr& io_service);

    virtual int getNative() const;

    virtual int getProtocol() const;

    void connect(const std::string& path);

    void asyncConnect(const std::string& path, const ConnectHandler& handler);

    size_t write(const void* data, size_t length);

    void asyncSend(const void* data, const size_t length, const Handler& handler);

    size_t receive(void* data, size_t length);

    void asyncReceive(void* data, const size_t length, const Handler& handler);

    void shutdown();

    void cancel();

    void close();

    virtual boost::asio::local::stream_protocol::socket& getASIOSocket() const;
 
private:

    boost::shared_ptr<UnixDomainSocketImpl> impl_;
 
};
 
} // end of namespace isc::asiolink
} // end of namespace isc
 
#endif // UNIX_DOMAIN_SOCKET_H