summaryrefslogtreecommitdiffstats
path: root/lib/src/hicn.h
blob: 749fd4247452446f685ca49daa7945717de60a52 (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
73
74
75
76
77
78
79
/*
 * Copyright (c) 2017-2019 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.
 */

/**
 * @file hicn.h
 * @brief hICN master include file.
 *
 * Reference: https://tools.ietf.org/html/draft-muscariello-intarea-hicn
 *
 * This file is the entry point for projects to libhicn, which provides a
 * reference implementation for hICN specifications [1], including:
 *  - naming
 *  - packet headers
 *  - protocol mappings (IPv4, IPv6, TCP, ICMP, AH)
 *  - protocol independent packet operations
 *  - helpers for additional features such as Wireless Loss Detection and
 *    Recovery (WLDR) [2], Anchorless Mobility Management (hICN-AMM) [3],
 *    including MAP-Me producer mobility mechanisms [4].
 *
 *  [1] Hybrid Information-Centric Networking
 *      L. Muscariello, G. Carofiglio, J. Augé, M. Papalini
 *      IETF draft (intarea) @ https://tools.ietf.org/html/draft-muscariello-intarea-hicn
 *
 *  [2] Leveraging ICN in-network control for loss detection and recovery in wireless mobile networks
 *      G. Carofiglio, L. Muscariello, M. Papalini, N. Rozhnova, X. Zeng
 *      In proc. ICN'2016, Kyoto, JP
 *
 *  [3] Anchorless mobility through hICN
 *      J. Augé, G. Carofiglio, L. Muscariello, M. Papalini
 *      IETF draft (DMM) @ https://tools.ietf.org/html/draft-auge-dmm-hicn-mobility
 *
 *
 *  [4] MAP-Me : Managing Anchorless Mobility in Content Centric Networking
 *      J. Augé, G. Carofiglio, L. Muscariello, M. Papalini
 *      IRTF draft (ICNRG) @ https://tools.ietf.org/html/draft-irtf-icnrg-mapme
 */

#ifndef HICN__H
#define HICN__H

#ifdef HICN_VPP_PLUGIN

#include <hicn/header.h>
#include <hicn/name.h>
#include <hicn/ops.h>
#include <hicn/mapme.h>

#else

#include <hicn/error.h>
#include <hicn/header.h>
#include <hicn/name.h>
#include <hicn/ops.h>
#include <hicn/mapme.h>
#include <hicn/compat.h>

#endif

#endif /* HICN__H */

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */