1 files changed, 219 insertions, 0 deletions
diff --git a/libccnx-transport-rta/ccnx/api/control/cpi_InterfaceGeneric.h b/libccnx-transport-rta/ccnx/api/control/cpi_InterfaceGeneric.h
new file mode 100644
index 00000000..ffdd0978
--- /dev/null
+++ b/libccnx-transport-rta/ccnx/api/control/cpi_InterfaceGeneric.h
@@ -0,0 +1,219 @@
+/*
+ * 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 cpi_InterfaceGeneric.h
+ * @brief A generic interface that is used as a super type for other interfaces.
+ *
+ * <#Detailed Description#>
+ *
+ */
+#ifndef libccnx_cpi_InterfaceGeneric_h
+#define libccnx_cpi_InterfaceGeneric_h
+
+#include <ccnx/api/control/cpi_InterfaceType.h>
+#include <ccnx/api/control/cpi_Address.h>
+#include <ccnx/api/control/cpi_AddressList.h>
+
+
+struct cpi_interface_generic;
+typedef struct cpi_interface_generic CPIInterfaceGeneric;
+
+/**
+ * Creates an Generic-like interface abstraction. Takes ownership of addresses.
+ *
+ *   <#Discussion#>
+ *
+ * @param <#param1#>
+ * @return <#return#>
+ *
+ * Example:
+ * @code
+ * <#example#>
+ * @endcode
+ */
+CPIInterfaceGeneric *cpiInterfaceGeneric_Create(unsigned ifidx, CPIAddressList *addresses);
+
+/**
+ * <#One Line Description#>
+ *
+ * <#Paragraphs Of Explanation#>
+ *
+ * @param [<#in out in,out#>] <#name#> <#description#>
+ *
+ * @return <#value#> <#explanation#>
+ *
+ * Example:
+ * @code
+ * <#example#>
+ * @endcode
+ *
+ * @see <#references#>
+ */
+CPIInterfaceGeneric *cpiInterfaceGeneric_Copy(const CPIInterfaceGeneric *generic);
+
+/**
+ * <#One Line Description#>
+ *
+ * <#Paragraphs Of Explanation#>
+ *
+ * @param [<#in out in,out#>] <#name#> <#description#>
+ *
+ * @return <#value#> <#explanation#>
+ *
+ * Example:
+ * @code
+ * <#example#>
+ * @endcode
+ *
+ * @see <#references#>
+ */
+void cpiInterfaceGeneric_Destroy(CPIInterfaceGeneric **genericPtr);
+
+/**
+ * <#One Line Description#>
+ *
+ * <#Paragraphs Of Explanation#>
+ *
+ * @param [<#in out in,out#>] <#name#> <#description#>
+ *
+ * @return <#value#> <#explanation#>
+ *
+ * Example:
+ * @code
+ * <#example#>
+ * @endcode
+ *
+ * @see <#references#>
+ */
+void cpiInterfaceGeneric_SetState(CPIInterfaceGeneric *generic, CPIInterfaceStateType state);
+
+/**
+ * <#One Line Description#>
+ *
+ * <#Paragraphs Of Explanation#>
+ *
+ * @param [<#in out in,out#>] <#name#> <#description#>
+ *
+ * @return <#value#> <#explanation#>
+ *
+ * Example:
+ * @code
+ * <#example#>
+ * @endcode
+ *
+ * @see <#references#>
+ */
+unsigned cpiInterfaceGeneric_GetIndex(const CPIInterfaceGeneric *generic);
+
+/**
+ * <#One Line Description#>
+ *
+ * <#Paragraphs Of Explanation#>
+ *
+ * @param [<#in out in,out#>] <#name#> <#description#>
+ *
+ * @return <#value#> <#explanation#>
+ *
+ * Example:
+ * @code
+ * <#example#>
+ * @endcode
+ *
+ * @see <#references#>
+ */
+const CPIAddressList *cpiInterfaceGeneric_GetAddresses(const CPIInterfaceGeneric *generic);
+
+/**
+ * <#One Line Description#>
+ *
+ * <#Paragraphs Of Explanation#>
+ *
+ * @param [<#in out in,out#>] <#name#> <#description#>
+ *
+ * @return <#value#> <#explanation#>
+ *
+ * Example:
+ * @code
+ * <#example#>
+ * @endcode
+ *
+ * @see <#references#>
+ */
+CPIInterfaceStateType  cpiInterfaceGeneric_GetState(const CPIInterfaceGeneric *generic);
+
+/**
+ * Determine if two CPIInterfaceGeneric instances are equal.
+ *
+ * Two CPIInterfaceGeneric instances are equal if, and only if, the same state and index and addresses
+ * are equal in the same order.
+ *
+ * The following equivalence relations on non-null `CPIInterfaceGeneric` instances are maintained:
+ *
+ *  * It is reflexive: for any non-null reference value x, `CPIInterfaceGeneric_Equals(x, x)`
+ *      must return true.
+ *
+ *  * It is symmetric: for any non-null reference values x and y,
+ *    `cpiInterfaceGeneric_Equals(x, y)` must return true if and only if
+ *        `cpiInterfaceGeneric_Equals(y, x)` returns true.
+ *
+ *  * It is transitive: for any non-null reference values x, y, and z, if
+ *        `cpiInterfaceGeneric_Equals(x, y)` returns true and
+ *        `cpiInterfaceGeneric_Equals(y, z)` returns true,
+ *        then  `cpiInterfaceGeneric_Equals(x, z)` must return true.
+ *
+ *  * It is consistent: for any non-null reference values x and y, multiple
+ *      invocations of `cpiInterfaceGeneric_Equals(x, y)` consistently return true or
+ *      consistently return false.
+ *
+ *  * For any non-null reference value x, `cpiInterfaceGeneric_Equals(x, NULL)` must
+ *      return false.
+ *
+ * @param a A pointer to a `CPIInterfaceGeneric` instance.
+ * @param b A pointer to a `CPIInterfaceGeneric` instance.
+ * @return true if the two `CPIInterfaceGeneric` instances are equal.
+ *
+ * Example:
+ * @code
+ * {
+ *    CPIInterfaceGeneric *a = cpiInterfaceGeneric_Create();
+ *    CPIInterfaceGeneric *b = cpiInterfaceGeneric_Create();
+ *
+ *    if (cpiInterfaceGeneric_Equals(a, b)) {
+ *        // true
+ *    } else {
+ *        // false
+ *    }
+ * }
+ * @endcode
+ */
+bool cpiInterfaceGeneric_Equals(const CPIInterfaceGeneric *a, const CPIInterfaceGeneric *b);
+
+/**
+ * <#OneLineDescription#>
+ *
+ *   <#Discussion#>
+ *
+ * @param [in] interface
+ * @param [in] composer A pointer to a PARCBufferComposer instance.
+ * @return return The input parameter string.
+ *
+ * Example:
+ * @code
+ * <#example#>
+ * @endcode
+ */
+PARCBufferComposer *cpiInterfaceGeneric_BuildString(const CPIInterfaceGeneric *interface, PARCBufferComposer *composer);
+#endif // libccnx_cpi_InterfaceGeneric_h