diff options
author | michele papalini <micpapal+fdio@cisco.com> | 2017-02-23 17:01:34 +0100 |
---|---|---|
committer | Michele Papalini <micpapal+fdio@cisco.com> | 2017-02-23 17:23:19 +0000 |
commit | c580a00aac271a524e5a75b35f4b91c174ed227b (patch) | |
tree | feddc15a9f1a4eb319d950f8d6330ac2b91e3d99 /metis/ccnx/forwarder/metis/content_store/metis_LRUContentStore.h | |
parent | 9b30fc10fb1cbebe651e5a107e8ca5b24de54675 (diff) |
Initial commit: sb-forwarder, metis.
Change-Id: I65ee3c851a6901929ef4417ad80d34bca0dce445
Signed-off-by: michele papalini <micpapal+fdio@cisco.com>
Diffstat (limited to 'metis/ccnx/forwarder/metis/content_store/metis_LRUContentStore.h')
-rw-r--r-- | metis/ccnx/forwarder/metis/content_store/metis_LRUContentStore.h | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/metis/ccnx/forwarder/metis/content_store/metis_LRUContentStore.h b/metis/ccnx/forwarder/metis/content_store/metis_LRUContentStore.h new file mode 100644 index 00000000..36738352 --- /dev/null +++ b/metis/ccnx/forwarder/metis/content_store/metis_LRUContentStore.h @@ -0,0 +1,53 @@ +/* + * 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. + */ + + +#ifndef Metis_metis_LRUContentStore_h +#define Metis_metis_LRUContentStore_h + +#include <stdio.h> +#include <ccnx/forwarder/metis/content_store/metis_ContentStoreInterface.h> +#include <ccnx/forwarder/metis/core/metis_Logger.h> + +/** + * Create and Initialize an instance of MetisLRUContentStore. A newly allocated {@link MetisContentStoreInterface} + * object is initialized and returned. It must eventually be released by calling {@link metisContentStoreInterface_Release}. + * + * + * @param config An instance of `MetisContentStoreConfig`, specifying options to be applied + * by the underlying MetisLRUContentStore instance. + * @param logger An instance of a {@link MetisLogger} to use for logging content store events. + * + * @return a newly created MetisLRUContentStore instance. + * + * Example: + * @code + * { + * MetisContentStoreConfig config = { + * .objectCapacity = 10 + * }; + * + * MetisContentStoreInterface *store = metisLRUContentStore_Create(&config, logger); + * assertTrue(status, "Expected to init a content store"); + * + * store->Display(&store); + * metisContentStoreInterface_Release(&store); + * } + * @endcode + * @see MetisContentStoreInterface + * @see metisContentStoreInterface_Release + */ +MetisContentStoreInterface *metisLRUContentStore_Create(MetisContentStoreConfig *config, MetisLogger *logger); +#endif // Metis_metis_LRUContentStore_h |