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
201
202
203
204
205
|
/*
* 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_ControlState.h
* @brief A control program for Metis using CLI commands
*
* Implements the state machine for the control program. It takes a "writeRead" function
* as part of the constructor. This abstracts out the backend. It could be a Portal from
* metis_control program down to the forwarder or it could be an internal function within
* metis.
*
*/
#ifndef Metis_metis_control_h
#define Metis_metis_control_h
#include <parc/algol/parc_List.h>
#include <ccnx/transport/common/transport_MetaMessage.h>
#include <ccnx/forwarder/metis/config/metis_CommandParser.h>
struct metis_control_state;
typedef struct metis_control_state MetisControlState;
/**
* metisControlState_Create
*
* Creates the global state for the MetisControl program. The user provides the writeRead function
* for sending and receiving the CCNxMetaMessage wrapping a CPIControlMessage. For a CLI program, this
* function would work over a CCNxSocket or CCNxComms. For the baked-in CLI or configuration file
* inside metis, it would make direct calls to MetisConfiguration.
*
* @param [in] userdata A closure passed back to the user when calling writeRead.
* @param [in] writeRead The function to write then read configuration messages to Metis
*
* @return non-null The control state
*
* Example:
* @code
* <#example#>
* @endcode
*/
MetisControlState *metisControlState_Create(void *userdata, CCNxMetaMessage * (*writeRead)(void *userdata, CCNxMetaMessage * msg));
/**
* Destroys the control state, closing all network connections
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
void metisControlState_Destroy(MetisControlState **statePtr);
/**
* Registers a MetisCommandOps with the system.
*
* Each command has its complete command prefix in the "command" field. RegisterCommand
* will put these command prefixes in to a tree and then match what a user types against
* the longest-matching prefix in the tree. If there's a match, it will call the "execute"
* function.
*
* @param [in] state An allocated MetisControlState
* @param [in] command The command to register with the system
*
* Example:
* @code
* static MetisCommandReturn
* metisControl_Root_Execute(MetisCommandParser *parser, MetisCommandOps *ops, PARCList *args)
* {
* printf("Root Command\n");
* return MetisCommandReturn_Success;
* }
*
* static MetisCommandReturn
* metisControl_FooBar_Execute(MetisCommandParser *parser, MetisCommandOps *ops, PARCList *args)
* {
* printf("Foo Bar Command\n");
* return MetisCommandReturn_Success;
* }
*
* const MetisCommandOps metisControl_Root = {
* .command = "", // empty string for root
* .init = NULL,
* .execute = metisControl_Root_Execute
* };
*
* const MetisCommandOps metisControl_FooBar = {
* .command = "foo bar", // empty string for root
* .init = NULL,
* .execute = metisControl_FooBar_Execute
* };
*
* void startup(void)
* {
* MetisControlState *state = metisControlState_Create("happy", "day");
* metisControlState_RegisterCommand(state, metisControl_FooBar);
* metisControlState_RegisterCommand(state, metisControl_Root);
*
* // this executes "root"
* metisControlState_DispatchCommand(state, "foo");
* metisControlState_Destroy(&state);
* }
* @endcode
*/
void metisControlState_RegisterCommand(MetisControlState *state, MetisCommandOps *command);
/**
* Performs a longest-matching prefix of the args to the command tree
*
* The command tree is created with metisControlState_RegisterCommand.
*
* @param [in] state The allocated MetisControlState
* @param [in] args Each command-line word parsed to the ordered list
*
* @return MetisCommandReturn_Success the command was successful
* @return MetisCommandReturn_Failure the command failed or was not found
* @return MetisCommandReturn_Exit the command indicates that the interactive mode should exit
*
* Example:
* @code
* <#example#>
* @endcode
*/
MetisCommandReturn metisControlState_DispatchCommand(MetisControlState *state, PARCList *args);
/**
* Begin an interactive shell
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
int metisControlState_Interactive(MetisControlState *state);
/**
* Write then Read a CPI command
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
CCNxMetaMessage *metisControlState_WriteRead(MetisControlState *state, CCNxMetaMessage *msg);
/**
* Sets the Debug mode, which will print out much more information.
*
* Prints out much more diagnostic information about what metis-control is doing.
* yes, you would make a MetisCommandOps to set and unset this :)
*
* @param [in] debugFlag true means to print debug info, false means to turn it off
*
* Example:
* @code
* <#example#>
* @endcode
*/
void metisControlState_SetDebug(MetisControlState *state, bool debugFlag);
/**
* Returns the debug state of MetisControlState
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
bool metisControlState_GetDebug(MetisControlState *state);
#endif // Metis_metis_control_h
|
