aboutsummaryrefslogtreecommitdiff
path: root/ouroboros/_qosspec.py
blob: 6031c426916974a8ffbe600472d65cb620951641 (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
62
63
64
65
66
67
68
69
70
#
# Ouroboros - Copyright (C) 2016 - 2026
#
# Internal helpers for translating QoSSpec <-> CFFI qosspec_t.
#
#    Dimitri Staessens <dimitri@ouroboros.rocks>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public License
# version 2.1 as published by the Free Software Foundation.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., http://www.fsf.org/about/contact/.
#

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

dev.py and irm.py each link against their own CFFI extension module
(``_ouroboros_dev_cffi`` and ``_ouroboros_irm_cffi``), so they each
have their own ``ffi`` instance and their own ``qosspec_t`` type.
CFFI types are not interchangeable across modules, so these helpers
take the caller's ``ffi`` instance as a parameter.
"""

from __future__ import annotations

from typing import Optional

from ouroboros.qos import QoSSpec


def qos_to_qosspec(ffi, qos: Optional[QoSSpec]):
    """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, _qos) -> 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)