alexaClientSDK::sampleApp::ConsoleReader Class Reference

#include <ConsoleReader.h>

Public Member Functions
	ConsoleReader ()
	Constructor. More...
	~ConsoleReader ()
	Destructor. More...
bool	read (const std::chrono::milliseconds timeout, char *data)

Detailed Description

ConsoleReader provides an alternative to std::cin where the users can specify the timeout for an input from the console.

Constructor & Destructor Documentation

ConsoleReader()

alexaClientSDK::sampleApp::ConsoleReader::ConsoleReader

(

)

Constructor.

~ConsoleReader()

alexaClientSDK::sampleApp::ConsoleReader::~ConsoleReader

(

)

Destructor.

Member Function Documentation

read()

bool alexaClientSDK::sampleApp::ConsoleReader::read	(	const std::chrono::milliseconds	timeout,
		char *	data
	)

Reads an input from the console. This is a blocking call until an input is read or until the timeout has occurred.

Parameters

	timeout	Timeout to wait for the input.
[out]	data	A pointer to a single character. It will be set to the value of the last character which was read from the console.

Returns

Returns true if a character is read from the console. false if timeout has occurred.

---

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

• /workplace/avs-device-sdk/SampleApplications/Common/LibSampleApp/include/SampleApp/ConsoleReader.h