watch_socket.h

Go to the documentation of this file.

// Copyright (C) 2014-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 WATCH_SOCKET_H
#define WATCH_SOCKET_H

 
#include <exceptions/exceptions.h>
#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>
 
#include <stdint.h>
#include <string>
 
namespace isc {
namespace util {

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

class WatchSocket : public boost::noncopyable {
public:
    static const int SOCKET_NOT_VALID /* = -1 */;

    static const uint32_t MARKER /* = 0xDEADBEEF */;

    WatchSocket();

    virtual ~WatchSocket();

    void markReady();

    bool isReady();

    void clearReady();

    int getSelectFd();

    bool closeSocket(std::string& error_string);
 
private:

    void closeSocket();

    int source_;

    int sink_;
};

typedef boost::shared_ptr<WatchSocket> WatchSocketPtr;
 
} // namespace isc::util
} // namespace isc
 
#endif