diff options
author | Luca Muscariello <lumuscar+fdio@cisco.com> | 2017-02-24 07:59:45 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@fd.io> | 2017-02-24 07:59:45 +0000 |
commit | e0ec678c016fbce560e7f94973d4fada3ba5e799 (patch) | |
tree | a171ed331a830510f3064a6ad99b296ac1b2d2bc /metis/ccnx/forwarder/metis/tlv/metis_TlvSchemaV1.h | |
parent | f28308bd99381ef5f1e178e2e1f870f245e35873 (diff) | |
parent | c580a00aac271a524e5a75b35f4b91c174ed227b (diff) |
Merge "Initial commit: sb-forwarder, metis." into sb-forwarder/master
Diffstat (limited to 'metis/ccnx/forwarder/metis/tlv/metis_TlvSchemaV1.h')
-rw-r--r-- | metis/ccnx/forwarder/metis/tlv/metis_TlvSchemaV1.h | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/metis/ccnx/forwarder/metis/tlv/metis_TlvSchemaV1.h b/metis/ccnx/forwarder/metis/tlv/metis_TlvSchemaV1.h new file mode 100644 index 00000000..628bc556 --- /dev/null +++ b/metis/ccnx/forwarder/metis/tlv/metis_TlvSchemaV1.h @@ -0,0 +1,49 @@ +/* + * 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 metis_TlvSchemaV1.h + * @brief API to handle the v1 packet format + * + * Defines the operations for parsing a V1 schema name + * + */ + +#ifndef Metis_metis_TlvSchemaV1 +#define Metis_metis_TlvSchemaV1 + +#include <ccnx/forwarder/metis/tlv/metis_TlvOps.h> + +/** + * Defines the TLV Operations for the V1 Schema + * + * Example: + * @code + * { + * uint8_t *packet = // read a packet from the network + * MetisTlvSkeleton skeleton; + * bool success = MetisTlvSchemaV1_Ops.parseSkeleton(packet, &skeleton); + * if (success) { + * if (MetisTlvSchemaV1_Ops.isPacketTypeInterest(packet)) { + * // parse interest + * } + * } + * @endcode + */ +extern const MetisTlvOps MetisTlvSchemaV1_Ops; + + +#endif // Metis_metis_TlvSchemaV1 + |