MsgFactory.h

Go to the documentation of this file.

//
// Copyright 2015 - 2026 (C). Alex Robenko. All rights reserved.
//
// SPDX-License-Identifier: MPL-2.0
//
// 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/.
 
 
#pragma once
 
#include "comms/Assert.h"
#include "comms/details/MsgFactoryBase.h"
#include "comms/details/MsgFactoryOptionsParser.h"
#include "comms/MsgFactoryCreateFailureReason.h"
#include "comms/util/Tuple.h"
#include "comms/util/alloc.h"
 
#include <cstddef>
 
namespace comms
{
 
template <typename TMsgBase, typename TAllMessages, typename... TOptions>
class MsgFactory : private details::MsgFactoryBase<TMsgBase, TAllMessages, TOptions...>
{
    using Base = details::MsgFactoryBase<TMsgBase, TAllMessages, TOptions...>;
    static_assert(TMsgBase::hasMsgIdType(),
        "Usage of MsgFactory requires Message interface to provide ID type. "
        "Use comms::option::def::MsgIdType option in message interface type definition.");
 
public:
    using ParsedOptions = typename Base::ParsedOptions;
 
    using Message = typename Base::Message;
 
    using MsgIdParamType = typename Base::MsgIdParamType;
 
    using MsgIdType = typename Base::MsgIdType;
 
    using MsgPtr = typename Base::MsgPtr;
 
    using AllMessages = typename Base::AllMessages;
 
    using CreateFailureReason = MsgFactoryCreateFailureReason;
 
    using GenericMessage = typename ParsedOptions::GenericMessage;
 
    MsgPtr createMsg(MsgIdParamType id, unsigned idx = 0U, CreateFailureReason* reason = nullptr) const
    {
        return Base::createMsg(id, idx, reason);
    }
 
    MsgPtr createGenericMsg(MsgIdParamType id, unsigned idx = 0U) const
    {
        return Base::createGenericMsg(id, idx);
    }
 
    bool canAllocate() const
    {
        return Base::canAllocate();
    }
 
    std::size_t msgCount(MsgIdParamType id) const
    {
        return Base::msgCount(id);
    }
 
    static constexpr bool hasUniqueIds()
    {
        return Base::hasUniqueIds();
    }
 
    static constexpr bool isDispatchPolymorphic()
    {
        return Base::isDispatchPolymorphic();
    }
 
    static constexpr bool isDispatchStaticBinSearch()
    {
        return Base::isDispatchStaticBinSearch();
    }
 
    static constexpr bool isDispatchLinearSwitch()
    {
        return Base::isDispatchLinearSwitch();
    }
 
    static constexpr bool hasInPlaceAllocation()
    {
        return ParsedOptions::HasInPlaceAllocation;
    }
 
    static constexpr bool hasGenericMessageSupport()
    {
        return ParsedOptions::HasSupportGenericMessage;
    }
 
    static constexpr bool hasForcedDispatch()
    {
        return ParsedOptions::HasForcedDispatch;
    }
};
 
}  // namespace comms