diff options
author | Luca Muscariello <lumuscar+fdio@cisco.com> | 2017-02-23 20:44:26 +0100 |
---|---|---|
committer | Luca Muscariello <lumuscar+fdio@cisco.com> | 2017-02-23 19:51:14 +0000 |
commit | d18ae43123fcd7604d1c36a1ec8450dbe6071824 (patch) | |
tree | 2d49fc3aabd0f2607251c854565648d47b56b2e9 /libccnx-common/ccnx/common/internal/ccnx_InterestReturnInterface.h | |
parent | 9b30fc10fb1cbebe651e5a107e8ca5b24de54675 (diff) |
Initial commit: ccnxlibs.
Change-Id: I1b376527a7dd01a6b9e083a6cb646955902f45c0
Signed-off-by: Luca Muscariello <lumuscar+fdio@cisco.com>
Diffstat (limited to 'libccnx-common/ccnx/common/internal/ccnx_InterestReturnInterface.h')
-rw-r--r-- | libccnx-common/ccnx/common/internal/ccnx_InterestReturnInterface.h | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/libccnx-common/ccnx/common/internal/ccnx_InterestReturnInterface.h b/libccnx-common/ccnx/common/internal/ccnx_InterestReturnInterface.h new file mode 100644 index 00000000..3f36fb90 --- /dev/null +++ b/libccnx-common/ccnx/common/internal/ccnx_InterestReturnInterface.h @@ -0,0 +1,71 @@ +/* + * 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 <#Brief Description#> + * + * <#Detailed Description#> + * + */ + +#ifndef CCNx_Common_ccnx_internal_InterestReturnInterface_h +#define CCNx_Common_ccnx_internal_InterestReturnInterface_h + +#include <ccnx/common/internal/ccnx_TlvDictionary.h> +#include <ccnx/common/ccnx_InterestReturn.h> +#include <ccnx/common/ccnx_Interest.h> + + +typedef struct ccnx_interest_return_interface { + CCNxInterestInterface interestImpl; + + CCNxTlvDictionary *(*Create)(const CCNxInterest * interest, CCNxInterestReturn_ReturnCode code); + + bool (*Equals)(const CCNxTlvDictionary *objectA, const CCNxTlvDictionary *objectB); + void (*AssertValid)(const CCNxTlvDictionary *dict); + char *(*ToString)(const CCNxTlvDictionary * dict); + + uint32_t (*GetReturnCode)(const CCNxTlvDictionary *dict); +} CCNxInterestReturnInterface; + +extern CCNxInterestReturnInterface CCNxInterestReturnFacadeV1_Implementation; + +/** + * Given a CCNxTlvDictionary representing a CCNxInterestReturn, return the address of the CCNxInterestReturnInterface + * instance that should be used to access the InterestReturn. + * + * @param interestDictionary - a {@link CCNxTlvDictionary} representing a CCNxInterestReturn. + * @return the address of the `CCNxInterestReturnInterface` instance that should be used to access the CCNxInterestReturn. + * + * Example: + * @code + * { + * + * CCNxInterest *interest = ...; + * CCNxInterestReturn *interestReturn = + * ccnxInterestReturn_Create(interest, CCNxInterestReturn_ReturnCode_NoRoute); + * + * //V1 test + * if (ccnxInterestReturnInterface_GetInterface(interestReturn) == &CCNxInterestReturnFacadeV1_Implementation) { + * printf("Using a V1 CCNxInterestReturnInterface \n"); + * } + * + * ... + * + * ccnxInterestReturn_Release(&interestReturn); + * } * @endcode + */ +CCNxInterestReturnInterface *ccnxInterestReturnInterface_GetInterface(const CCNxTlvDictionary *interestDictionary); +#endif |