udspath.hpp

Go to the documentation of this file.

/*------------------------------------------------------------------------------
    Copyright Butterfly Energy Systems 2014-2015, 2022.
    Distributed under the Boost Software License, Version 1.0.
    http://www.boost.org/LICENSE_1_0.txt
------------------------------------------------------------------------------*/
 
#ifndef CPPWAMP_UDSPATH_HPP
#define CPPWAMP_UDSPATH_HPP
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
#include <string>
#include "api.hpp"
#include "rawsockoptions.hpp"
#include "internal/socketoptions.hpp"
 
// Forward declaration
namespace boost { namespace asio { namespace local { class stream_protocol; }}}
 
namespace wamp
{
 
namespace internal { class UdsOpener; } // Forward declaration
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
class CPPWAMP_API UdsOptions
{
public:
    UdsOptions& withBroadcast(bool enabled = true);
 
    UdsOptions& withDebug(bool enabled = true);
 
    UdsOptions& withDoNotRoute(bool enabled = true);
 
    UdsOptions& withKeepAlive(bool enabled = true);
 
    UdsOptions& withLinger(bool enabled, int timeout);
 
    UdsOptions& withOutOfBandInline(bool enabled);
 
    UdsOptions& withReceiveBufferSize(int size);
 
    UdsOptions& withReceiveLowWatermark(int size);
 
    UdsOptions& withReuseAddress(bool enabled = true);
 
    UdsOptions& withSendBufferSize(int size);
 
    UdsOptions& withSendLowWatermark(int size);
 
private:
    template <typename TOption, typename... TArgs>
    UdsOptions& set(TArgs... args);
 
    template <typename TSocket> void applyTo(TSocket& socket) const;
 
    internal::SocketOptionList<boost::asio::local::stream_protocol> options_;
 
    friend class internal::UdsOpener;
 
    /* Implementation note: Explicit template instantiation does not seem
       to play nice with CRTP, so it was not feasible to factor out the
       commonality with TcpOptions as a mixin (not without giving up the
       fluent API). */
};
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
class CPPWAMP_API UdsPath
{
public:
    static constexpr RawsockMaxLength defaultMaxRxLength =
        RawsockMaxLength::MB_16;
 
    UdsPath(
        std::string pathName,        
        UdsOptions options = {},     
        RawsockMaxLength maxRxLength
        = defaultMaxRxLength         
    );
 
    UdsPath& withOptions(UdsOptions options);
 
    UdsPath& withMaxRxLength(RawsockMaxLength length);
 
    const std::string& pathName() const;
 
    const UdsOptions& options() const;
 
    RawsockMaxLength maxRxLength() const;
 
 
    CPPWAMP_DEPRECATED UdsPath& withBroadcast(bool enabled = true)
    {
        options_.withBroadcast(enabled);
        return *this;
    }
 
    CPPWAMP_DEPRECATED UdsPath& withDebug(bool enabled = true)
    {
        options_.withDebug(enabled);
        return *this;
    }
 
    CPPWAMP_DEPRECATED UdsPath& withDoNotRoute(bool enabled = true)
    {
        options_.withDoNotRoute(enabled);
        return *this;
    }
 
    CPPWAMP_DEPRECATED UdsPath& withKeepAlive(bool enabled = true)
    {
        options_.withKeepAlive(enabled);
        return *this;
    }
 
    CPPWAMP_DEPRECATED UdsPath& withOutOfBandInline(bool enabled)
    {
        options_.withOutOfBandInline(enabled);
        return *this;
    }
 
    CPPWAMP_DEPRECATED UdsPath& withLinger(bool enabled, int timeout)
    {
        options_.withLinger(enabled, timeout);
        return *this;
    }
 
    CPPWAMP_DEPRECATED UdsPath& withReceiveBufferSize(int size)
    {
        options_.withReceiveBufferSize(size);
        return *this;
    }
 
    CPPWAMP_DEPRECATED UdsPath& withReceiveLowWatermark(int size)
    {
        options_.withReceiveLowWatermark(size);
        return *this;
    }
 
    CPPWAMP_DEPRECATED UdsPath& withReuseAddress(bool enabled = true)
    {
        options_.withReuseAddress(enabled);
        return *this;
    }
 
    CPPWAMP_DEPRECATED UdsPath& withSendBufferSize(int size)
    {
        options_.withSendBufferSize(size);
        return *this;
    }
 
    CPPWAMP_DEPRECATED UdsPath& withSendLowWatermark(int size)
    {
        options_.withSendLowWatermark(size);
        return *this;
    }
 
private:
    std::string pathName_;
    UdsOptions options_;
    RawsockMaxLength maxRxLength_;
};
 
} // namespace wamp
 
#ifndef CPPWAMP_COMPILED_LIB
#include "./internal/udspath.ipp"
#endif
 
#endif // CPPWAMP_UDSPATH_HPP