ExternIO Class Reference

#include <libmythtv/recorders/ExternalStreamHandler.h>

Collaboration diagram for ExternIO:

Public Member Functions
	ExternIO (const QString &app, const QStringList &args)
	~ExternIO (void)
bool	Ready (int fd, std::chrono::milliseconds timeout, const QString &what)
int	Read (QByteArray &buffer, int maxlen, std::chrono::milliseconds timeout=2500ms)
QByteArray	GetStatus (std::chrono::milliseconds timeout=2500ms)
int	Write (const QByteArray &buffer)
bool	Run (void)
bool	Error (void) const
QString	ErrorString (void) const
void	ClearError (void)

Static Public Member Functions
static bool	KillIfRunning (const QString &cmd)

Private Member Functions
void	Fork (void)

Private Attributes
QFileInfo	m_app
QStringList	m_args
int	m_appIn {-1}
int	m_appOut {-1}
int	m_appErr {-1}
pid_t	m_pid {-1}
QString	m_error
int	m_bufSize {0}
char *	m_buffer {nullptr}
QString	m_statusBuf
QTextStream	m_status
int	m_errCnt {0}

Static Private Attributes
static constexpr uint8_t	kMaxErrorCnt { 20 }

Detailed Description

Definition at line 29 of file ExternalStreamHandler.h.

Constructor & Destructor Documentation

ExternIO()

ExternIO::ExternIO	(	const QString &	app,
		const QStringList &	args
	)

Definition at line 40 of file ExternalStreamHandler.cpp.

~ExternIO()

ExternIO::~ExternIO

(

void

)

Definition at line 69 of file ExternalStreamHandler.cpp.

Member Function Documentation

Ready()

bool ExternIO::Ready	(	int	fd,
		std::chrono::milliseconds	timeout,
		const QString &	what
	)

Definition at line 79 of file ExternalStreamHandler.cpp.

Referenced by GetStatus(), and Read().

Read()

int ExternIO::Read	(	QByteArray &	buffer,
		int	maxlen,
		std::chrono::milliseconds	timeout = 2500ms
	)

Definition at line 113 of file ExternalStreamHandler.cpp.

Referenced by ExternalStreamHandler::PurgeBuffer(), and ExternalStreamHandler::run().

GetStatus()

QByteArray ExternIO::GetStatus

(

std::chrono::milliseconds

timeout = 2500ms

)

Definition at line 176 of file ExternalStreamHandler.cpp.

Referenced by ExternalStreamHandler::CheckForError(), ExternalStreamHandler::ProcessJson(), ExternalStreamHandler::ProcessVer1(), ExternalStreamHandler::ProcessVer2(), ExternalStreamHandler::PurgeBuffer(), and Run().

Write()

int ExternIO::Write

(

const QByteArray &

buffer

)

Definition at line 205 of file ExternalStreamHandler.cpp.

Referenced by ExternalStreamHandler::ProcessJson(), ExternalStreamHandler::ProcessVer1(), and ExternalStreamHandler::ProcessVer2().

Run()

bool ExternIO::Run

(

void

)

Definition at line 238 of file ExternalStreamHandler.cpp.

Referenced by ExternalStreamHandler::OpenApp().

Error()

bool ExternIO::Error ( void  ) const

inline

Definition at line 42 of file ExternalStreamHandler.h.

Referenced by ExternalStreamHandler::CheckForError(), Fork(), GetStatus(), ExternalStreamHandler::OpenApp(), ExternalStreamHandler::ProcessJson(), ExternalStreamHandler::ProcessVer1(), ExternalStreamHandler::ProcessVer2(), Read(), ExternalStreamHandler::run(), and Write().

ErrorString()

QString ExternIO::ErrorString ( void  ) const

inline

Definition at line 43 of file ExternalStreamHandler.h.

Referenced by ExternalStreamHandler::CheckForError(), ExternalStreamHandler::OpenApp(), ExternalStreamHandler::ProcessJson(), ExternalStreamHandler::ProcessVer1(), ExternalStreamHandler::ProcessVer2(), and ExternalStreamHandler::run().

ClearError()

void ExternIO::ClearError ( void  )

inline

Definition at line 44 of file ExternalStreamHandler.h.

KillIfRunning()

bool ExternIO::KillIfRunning ( const QString &  cmd )

static

Definition at line 249 of file ExternalStreamHandler.cpp.

Referenced by ExternalStreamHandler::CloseApp(), and Fork().

Fork()

void ExternIO::Fork ( void  )

private

Definition at line 301 of file ExternalStreamHandler.cpp.

Referenced by Run().

Member Data Documentation

kMaxErrorCnt

constexpr uint8_t ExternIO::kMaxErrorCnt { 20 }

staticconstexprprivate

Definition at line 31 of file ExternalStreamHandler.h.

Referenced by Read().

m_app

QFileInfo ExternIO::m_app

private

Definition at line 51 of file ExternalStreamHandler.h.

Referenced by ExternIO(), and Fork().

m_args

QStringList ExternIO::m_args

private

Definition at line 52 of file ExternalStreamHandler.h.

Referenced by ExternIO(), and Fork().

m_appIn

int ExternIO::m_appIn {-1}

private

Definition at line 53 of file ExternalStreamHandler.h.

Referenced by Fork(), Write(), and ~ExternIO().

m_appOut

int ExternIO::m_appOut {-1}

private

Definition at line 54 of file ExternalStreamHandler.h.

Referenced by Fork(), Read(), and ~ExternIO().

m_appErr

int ExternIO::m_appErr {-1}

private

Definition at line 55 of file ExternalStreamHandler.h.

Referenced by Fork(), GetStatus(), and ~ExternIO().

m_pid

pid_t ExternIO::m_pid {-1}

private

Definition at line 56 of file ExternalStreamHandler.h.

Referenced by Fork().

m_error

QString ExternIO::m_error

private

Definition at line 57 of file ExternalStreamHandler.h.

Referenced by ClearError(), Error(), ErrorString(), ExternIO(), Fork(), GetStatus(), Read(), Ready(), and Write().

m_bufSize

int ExternIO::m_bufSize {0}

private

Definition at line 59 of file ExternalStreamHandler.h.

Referenced by Read().

m_buffer

char* ExternIO::m_buffer {nullptr}

private

Definition at line 60 of file ExternalStreamHandler.h.

Referenced by Read(), and ~ExternIO().

m_statusBuf

QString ExternIO::m_statusBuf

private

Definition at line 62 of file ExternalStreamHandler.h.

Referenced by ExternIO().

m_status

QTextStream ExternIO::m_status

private

Definition at line 63 of file ExternalStreamHandler.h.

Referenced by ExternIO(), and GetStatus().

m_errCnt

int ExternIO::m_errCnt {0}

private

Definition at line 64 of file ExternalStreamHandler.h.

Referenced by Read().

---

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

• mythtv/libs/libmythtv/recorders/ExternalStreamHandler.h
• mythtv/libs/libmythtv/recorders/ExternalStreamHandler.cpp