OSVR Framework (Internal Development Docs)  0.6-1962-g59773924
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Public Member Functions | List of all members
osvr::common::IPCRingBuffer::Options Class Reference

Public Member Functions

 Options (std::string const &name)
 
 Options (std::string const &name, BackendType backend)
 
BackendType getBackend () const
 
Options & setName (std::string const &name)
 sets the name, after sanitizing the input string. More...
 
std::string const & getName () const
 
Options & setAlignment (alignment_type alignment)
 Sets the alignment for each entry, which must be a power of 2 (rounded up to the nearest if it's not). More...
 
alignment_type getAlignment () const
 
Options & setEntries (entry_count_type entries)
 Sets the number of entries in the ring buffer. More...
 
entry_count_type getEntries () const
 
Options & setEntrySize (entry_size_type entrySize)
 Sets the size of each entry in the ring buffer. More...
 
entry_size_type getEntrySize () const
 

Detailed Description

Definition at line 72 of file IPCRingBuffer.h.

Member Function Documentation

Options& osvr::common::IPCRingBuffer::Options::setName ( std::string const &  name)

sets the name, after sanitizing the input string.

Returns
*this for chained method idiom.
Options& osvr::common::IPCRingBuffer::Options::setAlignment ( alignment_type  alignment)

Sets the alignment for each entry, which must be a power of 2 (rounded up to the nearest if it's not).

Returns
*this for chained method idiom.
Options& osvr::common::IPCRingBuffer::Options::setEntries ( entry_count_type  entries)

Sets the number of entries in the ring buffer.

Returns
*this for chained method idiom.
Options& osvr::common::IPCRingBuffer::Options::setEntrySize ( entry_size_type  entrySize)

Sets the size of each entry in the ring buffer.

Returns
*this for chained method idiom.
The documentation for this class was generated from the following file: