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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/*
* Copyright (c) 2017 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 metis_Configuration.h
* @brief Metis 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 Metis_metis_Configuration_h
#define Metis_metis_Configuration_h
#include <ccnx/forwarder/metis/core/metis_Forwarder.h>
struct metis_configuration;
typedef struct metis_configuration MetisConfiguration;
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @retval <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
MetisConfiguration *metisConfiguration_Create(MetisForwarder *metis);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @retval <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
void metisConfiguration_Destroy(MetisConfiguration **configPtr);
void metisConfiguration_SetupAllListeners(MetisConfiguration *config, uint16_t port, const char *localPath);
/**
* Receive a CPI control message from the user encapsulated in a MetisMessage
*
* Takes ownership of the message, and will destroy it as needed.
*
* @param message is of type CCNX_MSG_CPI.
*
* Example:
* @code
* <#example#>
* @endcode
*/
void metisConfiguration_Receive(MetisConfiguration *config, MetisMessage *message);
/**
* Receives a CPI control message from the user
*
* Processes the message and generates the CPI control response. The response should always
* be non-null and must be released by the caller.
*
* @param [in] config Allocated MetisConfiguration
* @param [in] request The CPI Request to process
* @param [in] ingressId The ingress connection ID, used to track in logging messages
*
* @retval CCNxControl The response control message (an ACK, NACK, or Response).
*
* Example:
* @code
* <#example#>
* @endcode
*/
CCNxControl *metisConfiguration_ReceiveControl(MetisConfiguration *config, CCNxControl *request, unsigned ingressId);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @retval <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
PARCJSON *metisConfiguration_GetVersion(MetisConfiguration *config);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @retval <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
void metisConfiguration_StartCLI(MetisConfiguration *config, uint16_t port);
/**
* 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 metisConfiguration_GetObjectStoreSize(MetisConfiguration *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 metisConfiguration_SetObjectStoreSize(MetisConfiguration *config, size_t maximumContentObjectCount);
const char * metisConfiguration_GetForwarginStrategy(MetisConfiguration *config, const CCNxName * prefix);
/**
* Returns the MetisForwarder that owns the MetisConfiguration
*
* Returns the Metis Forwarder. Used primarily by associated classes in the
* configuration group.
*
* @param [in] config An allocated MetisConfiguration
*
* @return non-null The owning MetisForwarder
* @return null An error
*
* Example:
* @code
* {
* <#example#>
* }
* @endcode
*/
MetisForwarder *metisConfiguration_GetForwarder(const MetisConfiguration *config);
/**
* Returns the logger used by the Configuration subsystem
*
* Returns the logger specified when the MetisConfiguration was created.
*
* @param [in] config An allocated MetisConfiguration
*
* @retval non-null The logger
* @retval null An error
*
* Example:
* @code
* <#example#>
* @endcode
*/
MetisLogger *metisConfiguration_GetLogger(const MetisConfiguration *config);
#endif // Metis_metis_Configuration_h
|
