Scroll to navigation

ost::StackPager(3) Library Functions Manual ost::StackPager(3)

NAME

ost::StackPager -
The StackPager provides a repository to stash and retrieve working data in last-in-first-out order.

SYNOPSIS

#include <misc.h>
Inherits ost::MemPager.

Public Member Functions


StackPager (size_t pagesize)
 
Create a lifo pager as a mempager. void * push (const void *object, size_t size)
 
Push an arbitrary object onto the stack. void * push (const char *string)
 
Push a string onto the stack. void * pull (void)
 
Retrieve next object from stack. void purge (void)
 
Purge the stack of all objects and memory allocations.

Additional Inherited Members

Detailed Description

The StackPager provides a repository to stash and retrieve working data in last-in-first-out order.
The use of a mempager to support it's operation allows storage of arbitrary sized objects with no fixed limit.
Author:
David Sugar dyfet@ostel.com last in first out object pager.

Constructor & Destructor Documentation

ost::StackPager::StackPager (size_tpagesize)

Create a lifo pager as a mempager.
Parameters:
pagesize for memory allocation

Member Function Documentation

void* ost::StackPager::pull (void)

Retrieve next object from stack.
Returns:
object.

void ost::StackPager::purge (void)

Purge the stack of all objects and memory allocations.

void* ost::StackPager::push (const void *object, size_tsize)

Push an arbitrary object onto the stack.
Returns:
stack memory location.
Parameters:
object pointer to data
 
size of data.

void* ost::StackPager::push (const char *string)

Push a string onto the stack.
Returns:
stack memory location.
Parameters:
string pointer.

Author

Generated automatically by Doxygen for GNU CommonC++ from the source code.
Sun Dec 29 2013 GNU CommonC++