peak::core::BufferChunk Class Reference

Represents a buffer chunk. More...

#include <peak/buffer/peak_buffer_chunk.hpp>

Public Member Functions
	BufferChunk ()=delete
	~BufferChunk ()
	BufferChunk (const BufferChunk &other)=delete
BufferChunk &	operator= (const BufferChunk &other)=delete
	BufferChunk (BufferChunk &&other)=delete
BufferChunk &	operator= (BufferChunk &&other)=delete
uint64_t	ID () const
	Returns the ID.
void *	BasePtr () const
	Returns the base pointer.
size_t	Size () const
	Returns the size.
std::shared_ptr< Buffer >	ParentBuffer () const
	Returns the parent buffer.

Detailed Description

Represents a buffer chunk.

This class allows to query information about a buffer chunk.

Constructor & Destructor Documentation

BufferChunk() [1/3]

peak::core::BufferChunk::BufferChunk ( )

delete

~BufferChunk()

peak::core::BufferChunk::~BufferChunk ( )

inline

BufferChunk() [2/3]

peak::core::BufferChunk::BufferChunk ( const BufferChunk & other )

delete

BufferChunk() [3/3]

peak::core::BufferChunk::BufferChunk ( BufferChunk && other )

delete

Member Function Documentation

BasePtr()

void * peak::core::BufferChunk::BasePtr ( ) const

inline

Returns the base pointer.

Returns

Base pointer

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

ID()

uint64_t peak::core::BufferChunk::ID ( ) const

inline

Returns the ID.

Returns

ID

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

operator=() [1/2]

BufferChunk & peak::core::BufferChunk::operator= ( BufferChunk && other )

delete

operator=() [2/2]

BufferChunk & peak::core::BufferChunk::operator= ( const BufferChunk & other )

delete

ParentBuffer()

std::shared_ptr< Buffer > peak::core::BufferChunk::ParentBuffer ( ) const

inline

Returns the parent buffer.

Returns

Parent buffer

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

Size()

size_t peak::core::BufferChunk::Size ( ) const

inline

Returns the size.

Returns

Size

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

---

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

• peak/buffer/peak_buffer_chunk.hpp