eapi

Warning

doxygenfile: Cannot find file “eos/eapi.h

Type definitions in eapi

namespace eos

class eapi_response_t

#include <eapi.h>

An eAPI response from the Cli server.

Public Functions

eapi_response_t()

Default constructor.

eapi_response_t(bool success, uint32_t error_code, std::string const & error_message, std::vector< std::string > const & responses)

Full constructor.

bool success() const

Getter for ‘success’: indicates if a response was received.

uint32_t error_code() const

Getter for ‘error_code’: error code from eAPI response.

std::string error_message() const

Getter for ‘error_message’: error message from response.

std::vector< std::string > const & responses() const

Getter for ‘responses’: the set of strings that constitute an eAPI response.

std::string raw_response() const

Getter for ‘raw_response’: raw eAPI response (if requested).

std::string to_string() const

Returns a string representation of the current object’s values.

Private Members

bool success_

uint32_t error_code_

std::string error_message_

std::vector< std::string > responses_

std::string raw_response_

Friends

friend std::ostream & operator<<

A utility stream operator that adds a string representation of eapi_response_t to the ostream.