aboutsummaryrefslogtreecommitdiff
path: root/ouroboros/_qosspec.py
blob: 5c8b2456bd2159e40dfc32d9e53280976ff2bd72 (plain)
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
#
# SPDX-FileCopyrightText: 2016 - 2026 Dimitri Staessens
# SPDX-License-Identifier: LGPL-2.1-only
#

"""
Shared QoSSpec <-> qosspec_t conversion helpers.

CFFI types are not interchangeable across extension modules, so the
caller passes its own ``ffi`` instance.
"""

from __future__ import annotations

from typing import TYPE_CHECKING, Any, Optional

from ouroboros.qos import QoSSpec

if TYPE_CHECKING:
    from cffi import FFI


def qos_to_qosspec(ffi: FFI, qos: Optional[QoSSpec]) -> Any:
    """
    Convert a :class:`QoSSpec` to a freshly-allocated ``qosspec_t *``.

    Returns ``ffi.NULL`` when *qos* is ``None``.
    """

    if qos is None:
        return ffi.NULL

    return ffi.new("qosspec_t *",
                   [qos.service,
                    qos.delay,
                    qos.bandwidth,
                    qos.availability,
                    qos.loss,
                    qos.ber,
                    qos.max_gap,
                    qos.timeout])


def qosspec_to_qos(ffi: FFI, _qos: Any) -> Optional[QoSSpec]:
    """
    Convert a ``qosspec_t *`` back to a :class:`QoSSpec`.

    Returns ``None`` when *_qos* is ``ffi.NULL``.
    """

    if _qos == ffi.NULL:
        return None

    return QoSSpec(service=_qos.service,
                   delay=_qos.delay,
                   bandwidth=_qos.bandwidth,
                   availability=_qos.availability,
                   loss=_qos.loss,
                   ber=_qos.ber,
                   max_gap=_qos.max_gap,
                   timeout=_qos.timeout)