exception

Defines

noexcept

namespace eos

class error

#include <exception.h>

Base exception type for all SDK-reported exceptions.

Public Functions

virtual ~error()

error(std::string const & msg)

std::string const & msg() const

virtual const char * what() const

virtual void raise() const = 0

Throws this exception.

Private Members

std::string msg_

class invalid_argument_error

#include <exception.h>

Base exception for all cases where an attempt was made to configure the system with completely invalid arguments for example, an out-of-range VLAN ID (>4095).

Public Functions

virtual ~invalid_argument_error()

invalid_argument_error(std::string const & argument_name)

invalid_argument_error(std::string const & argument_name, std::string const & error_details)

virtual void raise() const

Throws this exception.

std::string argument_name() const

Private Members

std::string argument_name_

class invalid_range_error

#include <exception.h>

The given argument was outside of the legal range of values for that argument (e.g., VLAN IDs must be between 1 and 4094).

Public Functions

virtual ~invalid_range_error()

invalid_range_error(std::string const & argument_name, uint32_t min_valid, uint32_t max_valid)

virtual void raise() const

Throws this exception.

uint32_t min_valid() const

uint32_t max_valid() const

Private Members

uint32_t min_valid_

uint32_t max_valid_

class configuration_error

#include <exception.h>

Base exception type for all cases where the configuration requested could not be accepted because it’s impossible or invalid.

The configuration may be invalid because of other conflicting configuration. For instance if a VLAN ID is already used as an internal VLAN on a routed port, trying to manually configure this VLAN ID on a trunk port would fail until the requested VLAN ID is no longer used as an internal VLAN on the routed port.

Public Functions

virtual ~configuration_error()

configuration_error(std::string const & msg)

virtual void raise() const

Throws this exception.

class unconfigured_agent_error

#include <exception.h>

The given agent has not been configured.

Public Functions

virtual ~unconfigured_agent_error()

unconfigured_agent_error(std::string const & agent_name)

virtual void raise() const

Throws this exception.

std::string agent_name() const

Private Members

std::string agent_name_

class unsupported_error

#include <exception.h>

Base class for “unsupported” errors.

Public Functions

virtual ~unsupported_error()

unsupported_error(std::string const & msg)

virtual void raise() const

Throws this exception.

Private Members

std::string msg_

class no_scoped_lock_obtained_error

#include <exception.h>

The class for “No scoped lock obtained” errors.

Public Functions

virtual ~no_scoped_lock_obtained_error()

no_scoped_lock_obtained_error()

virtual void raise() const

Throws this exception.