aboutsummaryrefslogtreecommitdiffstats
path: root/libtransport/includes/hicn/transport/protocols/transport_algorithm.h
blob: f5c8cf4153e9442bc7660be4c6329d2c624235a8 (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
71
72
/*
 * Copyright (c) 2020 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef transport_algorithm_h
#define transport_algorithm_h

#include <hicn/header.h>
#include <stddef.h>
#include <stdint.h>

/**
 * TransportAlgorithm: class containing the protocol machinery
 */
#ifdef __cplusplus

#include <hicn/transport/core/content_object.h>

class TransportAlgorithm {
 public:
  virtual ~TransportAlgorithm() = default;
  virtual void reset() = 0;
  virtual uint32_t onContentObject(uint32_t suffix, uint32_t path_label) = 0;
  virtual uint32_t onInterestTimeout(uint32_t suffix) = 0;
  virtual void onInterestSent(uint32_t suffix) = 0;
  virtual void sessionEnd() = 0;
};

extern "C" {

#else
typedef void *TransportAlgorithm;
#endif

typedef void *(allocator_t)(size_t size);
typedef void *(deallocator_t)(void *ptr);

void transportAlgorithm_Init(allocator_t *allocator,
                             deallocator_t *deallocator);

TransportAlgorithm *transportAlgorithm_CreateRaaqm(
    double drop_factor, double minimum_drop_probability, double gamma,
    double beta, uint32_t sample_number, uint32_t interest_lifetime,
    double beta_wifi, double drop_wifi, double beta_lte, double drop_lte,
    unsigned int wifi_delay, unsigned int lte_delay, double max_window,
    double min_window);

void transportAlgorithm_Destroy(TransportAlgorithm *algorithm);

uint32_t transportAlgorithm_OnContentObject(TransportAlgorithm *algorithm,
                                            uint32_t suffix,
                                            uint32_t path_label);

uint32_t transportAlgorithm_OnInterestTimeout(TransportAlgorithm *algorithm,
                                              uint32_t suffix);

#ifdef __cplusplus
} /* __cplusplus */
#endif

#endif /* transport_algorithm_h */