options.hpp

Go to the documentation of this file.

/*
 * Copyright © 2018 Max Mazurov (fox.cpp) <fox.cpp [at] disroot [dot] org>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#pragma once

#include <chrono>
#include <tuple>

/*
 * If you had to open this file to find answer for your question - we are so
 * sorry. Please open issue with your question so we can update documentation
 * to answer it.
 */

namespace libwire::tcp {
    class socket;

    inline namespace options {
        struct no_delay_t {
            static void set(socket&, bool enabled) noexcept;

            static bool get(const socket&) noexcept;
        };

        constexpr no_delay_t no_delay{};

        struct timeout_t {
            template<typename Duration>
            static void set(socket& socket, Duration d) noexcept {
                namespace ch = std::chrono;

                set_impl(socket, ch::duration_cast<ch::milliseconds>(d));
            }
            static std::chrono::milliseconds get(const socket&) noexcept;

        private:
            static void set_impl(socket&, std::chrono::milliseconds) noexcept;
        };

        constexpr timeout_t timeout{};

        struct keep_alive_t {
            static void set(socket&, bool) noexcept;
            static bool get(const socket&) noexcept;
        };

        constexpr keep_alive_t keep_alive{};

        struct linger_t {
            template<typename Duration>
            static void set(socket& sock, bool enabled, Duration timeout) noexcept {
                namespace ch = std::chrono;

                set_impl(sock, enabled, ch::duration_cast<ch::seconds>(timeout));
            }

            static std::tuple<bool, std::chrono::seconds> get(const socket&) noexcept;

        private:
            static void set_impl(socket&, bool enabled, std::chrono::seconds timeout) noexcept;
        };

        constexpr linger_t linger{};
    } // namespace options
} // namespace libwire::tcp