diff options
author | Michele Papalini <micpapal+fdio@cisco.com> | 2017-02-24 08:00:33 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@fd.io> | 2017-02-24 08:00:33 +0000 |
commit | 4df7f4cc98b6288177df256e1db70ddc3f7d00db (patch) | |
tree | 55e71277b419e4830ae641868ab8e751c8b86972 /libparc/examples/How To Create an Object Pool/parc_SimpleBufferPool.h | |
parent | f28308bd99381ef5f1e178e2e1f870f245e35873 (diff) | |
parent | ec688b4723a041044226358bcd4dd6e2da39da49 (diff) |
Merge "Initial commit: cframework. Longbow and Libparc" into cframework/master
Diffstat (limited to 'libparc/examples/How To Create an Object Pool/parc_SimpleBufferPool.h')
-rw-r--r-- | libparc/examples/How To Create an Object Pool/parc_SimpleBufferPool.h | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/libparc/examples/How To Create an Object Pool/parc_SimpleBufferPool.h b/libparc/examples/How To Create an Object Pool/parc_SimpleBufferPool.h new file mode 100644 index 00000000..fe8ddf4a --- /dev/null +++ b/libparc/examples/How To Create an Object Pool/parc_SimpleBufferPool.h @@ -0,0 +1,100 @@ +/* + * 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 parc_BufferPool.h + * @brief <#Brief Description#> + * + * <#Detailed Description#> + * + */ +#ifndef PARCLibrary_parc_BufferPool +#define PARCLibrary_parc_BufferPool +#include <stdbool.h> + +#include <parc/algol/parc_Object.h> + +parcObject_Declare(PARCSimpleBufferPool); + +/** + * Increase the number of references to a `PARCBufferPool` instance. + * + * Note that new `PARCBufferPool` is not created, + * only that the given `PARCBufferPool` reference count is incremented. + * Discard the reference by invoking `parcSimpleBufferPool_Release`. + * + * @param [in] instance A pointer to a valid PARCBufferPool instance. + * + * @return The same value as @p instance. + * + * Example: + * @code + * { + * PARCBufferPool *a = parcSimpleBufferPool_Create(); + * + * PARCBufferPool *b = parcSimpleBufferPool_Acquire(); + * + * parcSimpleBufferPool_Release(&a); + * parcSimpleBufferPool_Release(&b); + * } + * @endcode + */ +PARCSimpleBufferPool *parcSimpleBufferPool_Acquire(const PARCSimpleBufferPool *instance); + +/** + * Create an instance of PARCBufferPool + * + * <#Paragraphs Of Explanation#> + * + * @return non-NULL A pointer to a valid PARCBufferPool instance. + * @return NULL An error occurred. + * + * Example: + * @code + * { + * PARCBufferPool *a = parcSimpleBufferPool_Create(); + * + * parcSimpleBufferPool_Release(&a); + * } + * @endcode + */ +PARCSimpleBufferPool *parcSimpleBufferPool_Create(size_t highWater, size_t bufferSize); + +/** + * Release a previously acquired reference to the given `PARCBufferPool` instance, + * decrementing the reference count for the instance. + * + * The pointer to the instance is set to NULL as a side-effect of this function. + * + * If the invocation causes the last reference to the instance to be released, + * the instance is deallocated and the instance's implementation will perform + * additional cleanup and release other privately held references. + * + * @param [in,out] instancePtr A pointer to a pointer to the instance to release. + * + * Example: + * @code + * { + * PARCSimpleBufferPool *a = parcSimpleBufferPool_Create(); + * + * parcSimpleBufferPool_Release(&a); + * } + * @endcode + */ +void parcSimpleBufferPool_Release(PARCSimpleBufferPool **instancePtr); + +PARCBuffer *parcSimpleBufferPool_GetInstance(PARCSimpleBufferPool *bufferPool); + +#endif |