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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
/*
* 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 configuration.h
* @brief hicn-light configuration, such as in-band commands or CLI
*
* Manages all user configuration of the system, such as from the CLI or web
* interface It remembers the user commands and will be able to write out a
* config file.
*
*/
#ifndef configuration_h
#define configuration_h
#include "../core/msgbuf.h"
#include "../core/strategy.h"
#include <hicn/ctrl/api.h>
typedef struct configuration_s configuration_t;
struct forwarder_s;
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @retval <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
configuration_t * configuration_create(struct forwarder_s * forwarder);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @retval <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
void configuration_free(configuration_t * config);
void configuration_setup_all_listeners(configuration_t *config, uint16_t port,
const char *localPath);
ssize_t configuration_receive_command(configuration_t *config, msgbuf_t * msgbuf);
/**
* Returns the configured size of the content store
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @retval <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
size_t configuration_cs_get_size(configuration_t *config);
/**
* Sets the size of the content store (in objects, not bytes)
*
* Must be set before starting the forwarder
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
void configuration_cs_set_size(configuration_t *config, size_t size);
strategy_type_t configuration_get_strategy(configuration_t *config, const char *prefix);
/**
* Returns the Forwarder that owns the Configuration
*
* Returns the hicn-light Forwarder. Used primarily by associated classes in
* the configuration group.
*
* @param [in] config An allocated Configuration
*
* @return non-null The owning Forwarder
* @return null An error
*
* Example:
* @code
* {
* <#example#>
* }
* @endcode
*/
struct forwarder_s * configuration_get_forwarder(const configuration_t *config);
uint8_t *
configuration_dispatch_command(configuration_t * config, command_type_t command_type,
uint8_t * packet, unsigned ingress_id);
face_type_t get_face_type_from_listener_type(hc_connection_type_t listener_type);
#endif // configuration_h
|
