vehicle_request.h

Go to the documentation of this file.

// Copyright (c) 2018, Smart Projects Holdings Ltd
// All rights reserved.
// See LICENSE file for license details.

#ifndef _UGCS_VSM_VEHICLE_REQUEST_H_
#define _UGCS_VSM_VEHICLE_REQUEST_H_

#include <ugcs/vsm/request_context.h>
#include <ugcs/vsm/reference_guard.h>
#include <ugcs/vsm/debug.h>

namespace ugcs {
namespace vsm {

class Vehicle_request: public std::enable_shared_from_this<Vehicle_request> {
    DEFINE_COMMON_CLASS(Vehicle_request, Vehicle_request)

public:
    enum class Result {
        OK,
        NOK
    };

    class Handle {
    public:
        Handle();

        Handle(Vehicle_request::Ptr vehicle_request);

        explicit operator bool() const;

        void
        Fail(const char *format = nullptr, ...) __FORMAT(printf, 2, 3);

        void
        Fail_v(const char *format, va_list fmt_args) __FORMAT(printf, 2, 0);

        void
        Fail(const std::string& reason);

        void
        Succeed();

    protected:
        void
        Assign_result(Result result, const std::string& status_text = std::string());

        Reference_guard<Vehicle_request::Ptr> vehicle_request;
    };

    typedef Callback_proxy<void, Result, std::string> Completion_handler;

    Vehicle_request(Completion_handler completion_handler,
            Request_completion_context::Ptr completion_ctx);

    virtual
    ~Vehicle_request();

    void
    Set_completion_result(Result result, const std::string&);

    void
    Complete();

    void
    Abort();

    Result
    Get_completion_result();

    bool
    Is_completed() const;

    void
    Add_ref();

    void
    Release_ref();

private:
    Request::Ptr request;

    Completion_handler completion_handler;

    std::atomic_int ref_count = { 0 };

    friend class Vehicle;
};

template <class Payload>
class Vehicle_request_spec: public Vehicle_request {
    DEFINE_COMMON_CLASS(Vehicle_request_spec, Vehicle_request)

public:
    template<typename... Args>
    Vehicle_request_spec(Completion_handler completion_handler,
                     Request_completion_context::Ptr completion_ctx,
                     Args &&... args):
        Vehicle_request(completion_handler, completion_ctx),
        payload(std::forward<Args>(args)...)
    {}

    class Handle: public Vehicle_request::Handle {
    public:
        using Vehicle_request::Handle::Handle;

        Payload*
        operator ->()
        {
            return &static_cast<Vehicle_request_spec&>(*vehicle_request).payload;
        }

        const Payload*
        operator ->() const
        {
            return &static_cast<Vehicle_request_spec&>(*vehicle_request).payload;
        }

        Payload&
        operator *()
        {
            return static_cast<Vehicle_request_spec&>(*vehicle_request).payload;
        }

        const Payload&
        operator *() const
        {
            return static_cast<Vehicle_request_spec&>(*vehicle_request).payload;
        }
    };

    Payload payload;
};

template<>
class Vehicle_request_spec<void>: public Vehicle_request {
    DEFINE_COMMON_CLASS(Vehicle_request_spec, Vehicle_request)
public:
    template<typename... Args>
    Vehicle_request_spec(Args &&... args):
        Vehicle_request(std::forward<Args>(args)...)
    {}
};

} /* namespace vsm */
} /* namespace ugcs */

#endif /* _UGCS_VSM_VEHICLE_REQUEST_H_ */