diff options
Diffstat (limited to 'libccnx-transport-rta/ccnx/transport/transport_rta/config/config_ApiConnector.h')
-rw-r--r-- | libccnx-transport-rta/ccnx/transport/transport_rta/config/config_ApiConnector.h | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/libccnx-transport-rta/ccnx/transport/transport_rta/config/config_ApiConnector.h b/libccnx-transport-rta/ccnx/transport/transport_rta/config/config_ApiConnector.h new file mode 100644 index 00000000..7e0867ad --- /dev/null +++ b/libccnx-transport-rta/ccnx/transport/transport_rta/config/config_ApiConnector.h @@ -0,0 +1,89 @@ +/* + * 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_ApiConnector.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 API Connector. + * + * @code + * { + * // Configure a stack with {APIConnector,TLVCodec,MetisConnector} + * + * CCNxStackConfig *stackConfig = ccnxStackConfig_Create(); + * CCNxConnectionConfig *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_ApiConnector_h +#define Libccnx_config_ApiConnector_h + +#include <ccnx/transport/common/ccnx_TransportConfig.h> + +/** + * Generates the configuration settings included in the Protocol Stack configuration + * + * Adds configuration elements to the Protocol Stack configuration + * { "API_CONNECTOR" : { } } + * + * @param [in] stackConfig The protocl stack configuration to update + * + * @return non-null The updated protocol stack configuration + * + * Example: + * @code + * <#example#> + * @endcode + */ +CCNxStackConfig *apiConnector_ProtocolStackConfig(CCNxStackConfig *stackConfig); + +/** + * Generates the configuration settings included in the Connection configuration + * + * Adds configuration elements to the `CCNxConnectionConfig` + * + * @param [in] config A pointer to a valid CCNxConnectionConfig instance. + * + * @return non-null The modified `CCNxConnectionConfig` + * + * Example: + * @code + * <#example#> + * @endcode + */ +CCNxConnectionConfig *apiConnector_ConnectionConfig(CCNxConnectionConfig *config); + +/** + * 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 *apiConnector_GetName(void); +#endif + |