RTC Toolkit  1.0.0
Public Member Functions | Protected Attributes | List of all members
rtctk::componentFramework::BufferTooSmall Class Reference

The BufferTooSmall is thrown when an API call fails because the provided buffer is not big enough to hold the data. More...

#include <exceptions.hpp>

Inheritance diagram for rtctk::componentFramework::BufferTooSmall:
rtctk::componentFramework::RtctkException

Public Member Functions

 BufferTooSmall (const std::size_t actual, const std::size_t expected)
 
std::size_t GetActualBufferSize () const
 
std::size_t GetExpectedBufferSize () const
 
- Public Member Functions inherited from rtctk::componentFramework::RtctkException
 RtctkException () noexcept
 
 RtctkException (const std::string &msg)
 
 RtctkException (const RtctkException &other) noexcept
 
virtual ~RtctkException () override=default
 

Protected Attributes

std::size_t m_actual
 
std::size_t m_expected
 

Detailed Description

The BufferTooSmall is thrown when an API call fails because the provided buffer is not big enough to hold the data.

Constructor & Destructor Documentation

◆ BufferTooSmall()

rtctk::componentFramework::BufferTooSmall::BufferTooSmall ( const std::size_t  actual,
const std::size_t  expected 
)
explicit

Member Function Documentation

◆ GetActualBufferSize()

std::size_t rtctk::componentFramework::BufferTooSmall::GetActualBufferSize ( ) const
inline

◆ GetExpectedBufferSize()

std::size_t rtctk::componentFramework::BufferTooSmall::GetExpectedBufferSize ( ) const
inline

Member Data Documentation

◆ m_actual

std::size_t rtctk::componentFramework::BufferTooSmall::m_actual
protected

◆ m_expected

std::size_t rtctk::componentFramework::BufferTooSmall::m_expected
protected

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