Auxiliary library for creating memory blobs, for instance to recycle or share native resources.
Some concurrency primitives are provided, built upon concurrentqueue and libcuckoo.
To use the plugin, add the following in build.settings:
plugins = {
["plugin.MemoryBlob"] = { publisherId = "com.xibalbastudios" }
}Sample code is available here.
Once this plugin has been loaded, native plugins may create and manage blobs via the BlobXS API. Until then, any calls to the API will be suitable no-ops. (Documentation is lacking at the moment!)
Blobs implement the ByteReader protocol.
The Bytes type—specified in a few of the blob methods—may be any object that implements ByteReader, including strings.
Functions and sections that begin with (WIP) describe work in progress. These features are not considered stable, but give a reasonable idea of what to expect.
From concurrentqueue's page:
I'm releasing the source of this repository... under a simplified BSD license. I'm also dual-licensing under the Boost Software License. See the LICENSE.md file for more details.
From libcuckoo's license:
Copyright (C) 2013, Carnegie Mellon University and Intel Corporation
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
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.
From the license of CityHash (used by libcuckoo):
Copyright (c) 2011 Google, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Modules
| core | Various free functions used by memory blobs. |
Classes
| ConsumerQueueRef | TODO! |
| MemoryBlob | An object that represents a memory blob, with various useful operations. |
| ProducerQueueRef | TODO! |
| QueueRef | TODO |