blob: 78a0669a47725d96aa434cbc0ceac38432ca5212 (
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
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
|
/*
* 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 config_Forwarder_Metis.h
* @brief Generates stack and connection configuration information
*
* Each component in the protocol stack must have a configuration element.
* This module generates the configuration elements for the Metis connector.
*
* The Metis connector requires one parameter to specify the port.
*
* @code
* {
* // Configure a stack with {APIConnector,TLVCodec,MetisConnector}
*
* stackConfig = ccnxStackConfig_Create();
* connConfig = ccnxConnectionConfig_Create();
*
* apiConnector_ProtocolStackConfig(stackConfig);
* apiConnector_ConnectionConfig(connConfig);
* tlvCodec_ProtocolStackConfig(stackConfig);
* tlvCodec_ConnectionConfig(connConfig);
* metisForwarder_ProtocolStackConfig(stackConfig);
* metisForwarder_ConnectionConfig(connConfig, metisForwarder_GetDefaultPort());
*
* CCNxTransportConfig *config = ccnxTransportConfig_Create(stackConfig, connConfig);
* }
*
*/
#ifndef Libccnx_config_Forwarder_Metis_h
#define Libccnx_config_Forwarder_Metis_h
#include <ccnx/transport/common/ccnx_TransportConfig.h>
#define METIS_PORT_ENV "METIS_PORT"
#define FORWARDER_CONNECTION_ENV "CCNX_FORWARDER"
/**
* Generates the configuration settings included in the Protocol Stack configuration
*
* Adds configuration elements to the Protocol Stack configuration
*
* { "FWD_METIS" : { } }
*
* @param [in] stackConfig The protocl stack configuration to update
*
* @return non-null The updated protocol stack configuration
*
* Example:
* @code
* <#example#>
* @endcode
*/
CCNxStackConfig *metisForwarder_ProtocolStackConfig(CCNxStackConfig *stackConfig);
/**
* Generates the configuration settings included in the Connection configuration
*
* Adds configuration elements to the `CCNxConnectionConfig`
*
* { "FWD_METIS" : { "port" : port } }
*
* @param [in] config A pointer to a valid CCNxConnectionConfig instance.
*
* @return non-null The modified `CCNxConnectionConfig`
*
* Example:
* @code
* <#example#>
* @endcode
*/
CCNxConnectionConfig *metisForwarder_ConnectionConfig(CCNxConnectionConfig *config, uint16_t port);
/**
* Returns the text string for this component
*
* Used as the text key to a JSON block. You do not need to free it.
*
* @return non-null A text string unique to this component
*
*/
const char *metisForwarder_GetName(void);
/**
* Returns the IANA assigned port for the CCN forwarder
*
* <#Paragraphs Of Explanation#>
*
* @return 9695 The IANA assigned port for CCN
*
* Example:
* @code
* <#example#>
* @endcode
*/
uint16_t metisForwarder_GetDefaultPort(void);
/**
* Return the metis port ot use (or the default 9695) based on the setting
* in the per-connection configuration
*/
uint16_t metisForwarder_GetPortFromConfig(PARCJSON *json);
#endif // Libccnx_config_Forwarder_Metis_h
|
