Initial commit: ccnxlibs.

Change-Id: I1b376527a7dd01a6b9e083a6cb646955902f45c0
Signed-off-by: Luca Muscariello <lumuscar+fdio@cisco.com>

1 files changed, 145 insertions, 0 deletions

diff --git a/libccnx-common/ccnx/common/internal/ccnx_ContentObjectInterface.h b/libccnx-common/ccnx/common/internal/ccnx_ContentObjectInterface.h
new file mode 100644
index 00000000..c2d67680
--- /dev/null
+++ b/libccnx-common/ccnx/common/internal/ccnx_ContentObjectInterface.h
@@ -0,0 +1,145 @@
+/*
+ * 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.
+ */
+
+/**
+ * @brief A structure of functions representing a ContentObject implementation.
+ *
+ * The underlying implementation should support the CCNxContentObject API.
+ *
+ */
+
+#ifndef CCNx_Common_ccnx_internal_ContentObjectInterface_h
+#define CCNx_Common_ccnx_internal_ContentObjectInterface_h
+
+#include <parc/algol/parc_Buffer.h>
+
+#include <ccnx/common/internal/ccnx_TlvDictionary.h>
+
+#include <ccnx/common/ccnx_Name.h>
+#include <ccnx/common/ccnx_KeyLocator.h>
+#include <ccnx/common/ccnx_PayloadType.h>
+
+typedef struct ccnx_contentobject_interface {
+    char               *description;      // A human-readable label for this implementation
+
+    /** @see ccnxContentObject_CreateWithNameAndPayload */
+    CCNxTlvDictionary  *(*createWithNameAndPayload)(const CCNxName * contentName,
+                                                    const CCNxPayloadType contentType,
+                                                    const PARCBuffer * payload);
+
+    /** @see ccnxContentObject_CreateWithPayload */
+    CCNxTlvDictionary  *(*createWithPayload)(const CCNxPayloadType contentType,
+                                             const PARCBuffer * payload);
+
+    /** @see ccnxContentObject_GetName */
+    CCNxName           *(*getName)(const CCNxTlvDictionary * dict);
+
+    /** @see ccnxContentObject_SetSignature */
+    bool (*setSignature)(CCNxTlvDictionary *dict,
+                         const PARCBuffer *keyId,
+                         const PARCSignature *signature,
+                         const CCNxKeyLocator *keyLocator);
+
+    /** @see ccnxContentObject_GetKeyId */
+    PARCBuffer         *(*getKeyId)(const CCNxTlvDictionary * dict);
+
+    /** @see ccnxContentObject_GetPayload */
+    PARCBuffer         *(*getPayload)(const CCNxTlvDictionary * dict);
+
+    /** @see ccnxContentObject_GetPayloadType */
+    CCNxPayloadType (*getPayloadType)(const CCNxTlvDictionary *dict);
+
+    /** @see ccnxContentObject_SetPayload */
+    bool (*setPayload)(CCNxTlvDictionary *dict, CCNxPayloadType payloadType, const PARCBuffer *payload);
+
+    /** @see ccnxContentObject_SetFinalChunkNumber */
+    bool (*setFinalChunkNumber)(CCNxTlvDictionary *dict, const uint64_t finalChunkNumber);
+
+    /** @see ccnxContentObject_GetFinalChunkNumber */
+    uint64_t (*getFinalChunkNumber)(const CCNxTlvDictionary *dict);
+
+    /** @see ccnxContentObject_HasFinalChunkNumber */
+    bool (*hasFinalChunkNumber)(const CCNxTlvDictionary *dict);
+
+    /** @see ccnxContentObject_SetExpiryTime */
+    bool (*setExpiryTime)(CCNxTlvDictionary *dict, const uint64_t expiryTime);
+
+    /** @see ccnxContentObject_GetExpiryTime */
+    uint64_t (*getExpiryTime)(const CCNxTlvDictionary *dict);
+
+    /** @see ccnxContentObject_HasExpiryTime */
+    bool (*hasExpiryTime)(const CCNxTlvDictionary *dict);
+
+    /** @see ccnxContentObject_Equals */
+    bool (*equals)(const CCNxTlvDictionary *objectA, const CCNxTlvDictionary *objectB);
+
+    /** @see ccnxContentObject_AssertValid */
+    void (*assertValid)(const CCNxTlvDictionary *dict);
+
+    /** @see ccnxContentObject_ToString */
+    char               *(*toString)(const CCNxTlvDictionary * dict);
+
+    /** @see ccnxContentObject_CreateWithPayload */
+    void (*display)(const CCNxTlvDictionary *interestDictionary, size_t indentation);
+
+    bool (*setPathLabel)(CCNxTlvDictionary *dict, const uint64_t pathLabel);
+    uint64_t (*getPathLabel)(const CCNxTlvDictionary *dict);
+    bool (*hasPathLabel)(const CCNxTlvDictionary *dict);
+} CCNxContentObjectInterface;
+
+/**
+ * The SchemaV1 ContentObject implementaton
+ */
+extern CCNxContentObjectInterface CCNxContentObjectFacadeV1_Implementation;
+
+/**
+ * Given a CCNxTlvDictionary representing a CCNxContentObject, return the address of the CCNxContentObjectInterface
+ * instance that should be used to access the ContentObject. This will also update the CCNxTlvDictionary's implementation
+ * pointer for future references.
+ *
+ * @param contentDictionary - a {@link CCNxTlvDictionary} representing a CCNxContentObject.
+ * @return the address of the `CCNxContentObjectInterface` instance that should be used to access the CCNxContentObject.
+ *
+ * Example:
+ * @code
+ * {
+ *      CCNxName *name = ccnxName_CreateFromCString("lci:/boose/roo/pie");
+ *
+ *      CCNxContentObject *contentObjectV0 =
+ *          ccnxContentObject_CreateWithImplAndPayload(&CCNxContentObjectFacadeV0_Implementation,
+ *                                                     name,
+ *                                                     CCNxPayloadType_DATA,
+ *                                                     NULL);
+ *
+ *      CCNxContentObject *contentObjectV1 =
+ *          ccnxContentObject_CreateWithImplAndPayload(&CCNxContentObjectFacadeV1_Implementation,
+ *                                                     name,
+ *                                                     CCNxPayloadType_DATA,
+ *                                                     NULL);
+ *
+ *      assertTrue(ccnxContentObjectInterface_GetInterface(contentObjectV0) == &CCNxContentObjectFacadeV0_Implementation,
+ *                 "Expected V0 Implementation");
+ *
+ *      assertTrue(ccnxContentObjectInterface_GetInterface(contentObjectV1) == &CCNxContentObjectFacadeV1_Implementation,
+ *                 "Expected V1 Implementation");
+ *
+ *      ccnxName_Release(&name);
+ *      ccnxContentObject_Release(&contentObjectV0);
+ *      ccnxContentObject_Release(&contentObjectV1);
+ * }
+ * @endcode
+ */
+CCNxContentObjectInterface *ccnxContentObjectInterface_GetInterface(const CCNxTlvDictionary *contentDictionary);
+#endif