#include "jbuffman.h"

Detailed Description

Buffer manager using doubly linked-list from the

standard library. Constructs a memory with the

requested number of buffers of the templated size

// create a memory of 256 buffers each 256 bytes long
jbuffman mem1<uint8_t, 256>(256);
 
// create a memory of 16384 buffers each 384 bytes long
jbuffman mem2<uint8_t, 384>(16384);
 
// request 20 buffers from mem1
std::list<std::array<uint8_t, 256>> buf1 = mem1.deque(20);
 
// return the buffers to the memory
mem1.enque(buf1);
 
// request 200 buffers from mem2 wrapped in a shared_ptr
std::shared_ptr<std::list<std::array<uint8_t, 384>>> buf2 = std::make_shared<std::list<std::array<uint8_t, 384>>>();
mem2.deque(200, buf2);
 
// return the 200 buffers to mem2 from the shared_ptr
mem2.enque(buf2);
 
// return number of available buffers in mem1
int numbufs = mem1.avail();

Using the buffers is simply using the functions for std::list and std::array. Iterate through the buffers in the list, write to or reading the data from the std:: array at each node. For example, to used the buf1 above to write data it would be

for(std::list<std::array<uint8_t, 256>>::iterator itr=buf1.begin(); itr!=buf1.end(); itr++) {
    std::memcpy(itr->data(), new_data.ptr(), new_data.size());
}

The "*itr->data()" returns a pointer to the first element in the std::array, perfect for use with std::memcpy. The class jbuffacc provides a wrapper to read and write data into the buffers. Click the link below to see the interface for the wrapper

For API Documentation:

See also: ProtocolPP::jbuffman; ProtocolPP::jbuffacc

For Additional Documentation:

See also: jbuffman; jbuffacc

The source code contained or described herein and all documents related to the source code (herein called "Material") are owned by John Peter Greninger and Sheila Rocha Greninger. Title to the Material remains with John Peter Greninger and Sheila Rocha Greninger. The Material contains trade secrets and proprietary and confidential information of John Peter Greninger and Sheila Rocha Greninger. The Material is protected by worldwide copyright and trade secret laws and treaty provisions. No part of the Material may be used, copied, reproduced, modified, published, uploaded, posted, transmitted, distributed, or disclosed in any way without prior express written consent of John Peter Greninger and Sheila Rocha Greninger (both are required)

No license under any patent, copyright, trade secret, or other intellectual property right is granted to or conferred upon you by disclosure or delivery of the Materials, either expressly, by implication, inducement, estoppel, or otherwise. Any license under such intellectual property rights must be express and approved by John Peter Greninger and Sheila Rocha Greninger in writing

Licensing information can be found at www.protocolpp.com/license with use of the binary forms permitted provided that the following conditions are met:

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution
Any and all modifications must be returned to John Peter Greninger at GitHub.com https://github.com/jpgreninger/protocolpp for evaluation. Inclusion of modifications in the source code shall be determined solely by John Peter Greninger. Failure to provide modifications shall render this license NULL and VOID and revoke any rights to use of Protocol++®
Commercial use (incidental or not) requires a fee-based license obtainable at www.protocolpp.com/shop
Academic or research use requires prior written and notarized permission from John Peter and Sheila Rocha Greninger

Use of the source code requires purchase of the source code. Source code can be purchased at www.protocolpp.com/shop

US Copyrights at https://www.copyright.gov/
- TXu002059872 (Version 1.0.0)
- TXu002066632 (Version 1.2.7)
- TXu002082674 (Version 1.4.0)
- TXu002097880 (Version 2.0.0)
- TXu002169236 (Version 3.0.1)
- TXu002182417 (Version 4.0.0)
- TXu002219402 (Version 5.0.0)
- TXu002272076 (Version 5.2.1)
- TXu002383571 (Version 5.4.3)

The name of its contributor may not be used to endorse or promote products derived from this software without specific prior written permission and licensing

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTOR "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE

The documentation for this class was generated from the following file:

include/jbuffman.h