getlineWithTimeout Class Reference

#include <getlineWithTimeout.h>

Inheritance diagram for getlineWithTimeout:

Collaboration diagram for getlineWithTimeout:

Classes
class	nocopyLine

Public Member Functions
	getlineWithTimeout (std::istream &aStream, char aDelimiter)
	~getlineWithTimeout ()
bool	active ()

Private Member Functions
void	reader ()
Private Member Functions inherited from unwindCheck
	unwindCheck ()=default
	~unwindCheck ()=default
bool	isUnwinding () const

Private Attributes
std::istream &	stream
char	delimiter
bool	waitingForData
std::string	line
std::mutex	lineMutex
std::condition_variable	cv
std::thread	readerThread
bool	running

Detailed Description

Definition at line 9 of file getlineWithTimeout.h.

Constructor & Destructor Documentation

getlineWithTimeout()

getlineWithTimeout::getlineWithTimeout ( std::istream &  aStream, char  aDelimiter  )

inline

Definition at line 33 of file getlineWithTimeout.h.

                                        :
        stream(aStream), delimiter(aDelimiter), waitingForData(true) {
        running = true;
        readerThread = std::thread(&getlineWithTimeout::reader, this);
    };

References reader(), readerThread, and running.

Here is the call graph for this function:

~getlineWithTimeout()

getlineWithTimeout::~getlineWithTimeout ( )

inline

Definition at line 39 of file getlineWithTimeout.h.

                          {
        if (!isUnwinding()) {
            readerThread.join();
        }
    };

References unwindCheck::isUnwinding(), and readerThread.

Here is the call graph for this function:

Member Function Documentation

active()

bool getlineWithTimeout::active ( )

inline

Definition at line 45 of file getlineWithTimeout.h.

                  {
        return running;
    }

References running.

Referenced by followJsonRequestProvider::followStream().

Here is the caller graph for this function:

reader()

void getlineWithTimeout::reader ( )

inlineprivate

Definition at line 18 of file getlineWithTimeout.h.

                  {
        running = true;
        while (stream) {
            std::unique_lock<decltype(lineMutex)> lock(lineMutex);
            while (!waitingForData) {
                cv.wait(lock);
            }
            std::getline(stream, line, delimiter);
            waitingForData = false;
            cv.notify_all();
        }
        cv.notify_all();
        running = false;
    }

References cv, delimiter, line, lineMutex, running, stream, and waitingForData.

Referenced by getlineWithTimeout().

Here is the caller graph for this function:

Member Data Documentation

cv

std::condition_variable getlineWithTimeout::cv

private

Definition at line 15 of file getlineWithTimeout.h.

Referenced by getlineWithTimeout::nocopyLine::nocopyLine(), reader(), and getlineWithTimeout::nocopyLine::~nocopyLine().

delimiter

char getlineWithTimeout::delimiter

private

Definition at line 11 of file getlineWithTimeout.h.

Referenced by reader().

line

std::string getlineWithTimeout::line

private

Definition at line 13 of file getlineWithTimeout.h.

Referenced by getlineWithTimeout::nocopyLine::line(), and reader().

lineMutex

std::mutex getlineWithTimeout::lineMutex

private

Definition at line 14 of file getlineWithTimeout.h.

Referenced by reader().

readerThread

std::thread getlineWithTimeout::readerThread

private

Definition at line 16 of file getlineWithTimeout.h.

Referenced by getlineWithTimeout(), and ~getlineWithTimeout().

running

bool getlineWithTimeout::running

private

Definition at line 17 of file getlineWithTimeout.h.

Referenced by active(), getlineWithTimeout(), and reader().

stream

std::istream& getlineWithTimeout::stream

private

Definition at line 10 of file getlineWithTimeout.h.

Referenced by reader().

waitingForData

bool getlineWithTimeout::waitingForData

private

Definition at line 12 of file getlineWithTimeout.h.

Referenced by getlineWithTimeout::nocopyLine::nocopyLine(), reader(), getlineWithTimeout::nocopyLine::timedOut(), and getlineWithTimeout::nocopyLine::~nocopyLine().

---

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

• src/getlineWithTimeout.h (v0.19-24-g0617ca1 with changes)