vsomeip-sys 0.6.0

Somewhat low level unsafe wrapper around vsomeip
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

/********************************************************************************
 * Copyright (c) 2024 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Apache License Version 2.0 which is available at
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * SPDX-License-Identifier: Apache-2.0
 ********************************************************************************/

#pragma once

#include <memory>
#include <iostream>
#include "vsomeip/vsomeip.hpp"  // Adjust the path as necessary to include the runtime type

namespace glue {

/**
 *
 * \brief A C++ wrapper around an `std::shared_ptr<payload>`
 *
 * Need as a helpful shim to work around the current challenges of interop between Rust
 * and lifetimes of `std::shared_ptr<>` in C++
 *
 */
class PayloadWrapper {
public:
    explicit PayloadWrapper(std::shared_ptr<vsomeip_v3::payload> ptr) : ptr_(std::move(ptr)) {}

    vsomeip_v3::payload* get_mut() const {
        return ptr_.get();
    }

    std::shared_ptr<vsomeip_v3::payload> get_shared_ptr() const {
        return ptr_;
    }

private:
    std::shared_ptr<vsomeip_v3::payload> ptr_;
};

/**
 *
 * \brief Allows us to wrap a `std::shared_ptr<vsomeip_v3::payload>` into a
 *        `std::unique_ptr<PayloadWrapper>`
 *
 * We can then use the `std::unique<PayloadWrapper>` with the `get_pinned_payload()`
 * function to call methods on a `vsomeip_v3::payload` which mutate it
 *
 */
std::unique_ptr<PayloadWrapper> make_payload_wrapper(std::shared_ptr<vsomeip_v3::payload> ptr) {
    return std::make_unique<PayloadWrapper>(std::move(ptr));
}

/**
 *
 * \brief Allows us to set a `messsage` with the content of a `payload`
 *
 * A glue function to allow us to wrap this with a safe variant within Rust.
 *
 */
void set_payload_raw(vsomeip_v3::message* message_ptr, const vsomeip_v3::payload* payload_ptr) {
    std::shared_ptr<vsomeip_v3::payload> sptr(const_cast<vsomeip_v3::payload*>(payload_ptr), [](vsomeip_v3::payload*){});
    message_ptr->set_payload(sptr);
}

/**
 *
 * \brief Allows us to get a `payload` from a `message`
 *
 * A glue function to allow us to wrap this with a safe variant within Rust.
 *
 */
const vsomeip_v3::payload* get_payload_raw(const vsomeip_v3::message* self) {
    auto sp = self->get_payload();
    return sp.get();
}

/**
 *
 * \brief Allows us create a `std::shared_ptr<vsomeip_v3::payload>` from a pointer to a
 * vsomeip_v3::payload
 *
 * A glue function used to work around the fact that within Rust we're manipulating
 * a `std::unique_ptr<MessageWrapper>` and a `std::unique_ptr<PayloadWrapper>`
 */
std::shared_ptr<vsomeip_v3::payload> clone_payload(const vsomeip_v3::payload* payload_ptr) {
    return std::shared_ptr<vsomeip_v3::payload>(const_cast<vsomeip_v3::payload*>(payload_ptr), [](vsomeip_v3::payload*){});
}

/**
 *
 * \brief Allows us create a `std::unique_ptr<vsomeip_v3::payload>` from a pointer to a
 * vsomeip_v3::payload
 *
 * A glue function used to work around the fact that within Rust we're manipulating
 * a `std::unique_ptr<MessageWrapper>` and a `std::unique_ptr<PayloadWrapper>`
 */
std::unique_ptr<PayloadWrapper> create_payload_wrapper(const vsomeip_v3::payload* payload_ptr) {
    std::shared_ptr<vsomeip_v3::payload> sptr = clone_payload(payload_ptr);
    return std::make_unique<PayloadWrapper>(sptr);
}

} // namespace glue