jami::ThreadLoop Class Reference

#include <threadloop.h>

Inheritance diagram for jami::ThreadLoop:

Collaboration diagram for jami::ThreadLoop:

Public Types
enum class	ThreadState : uint8_t { READY , RUNNING , STOPPING }

Public Member Functions
void	exit ()
std::thread::id	get_id () const noexcept
bool	isRunning () const noexcept
bool	isStopping () const noexcept
void	join ()
void	start ()
virtual void	stop ()
	ThreadLoop (const std::function< bool()> &setup, const std::function< void()> &process, const std::function< void()> &cleanup)
void	waitForCompletion ()
virtual	~ThreadLoop ()

Detailed Description

Definition at line 35 of file threadloop.h.

Member Enumeration Documentation

ThreadState

enum class jami::ThreadLoop::ThreadState : uint8_t

strong

Enumerator
READY
RUNNING
STOPPING

Definition at line 38 of file threadloop.h.

Constructor & Destructor Documentation

ThreadLoop()

jami::ThreadLoop::ThreadLoop	(	const std::function< bool()> &	setup,
		const std::function< void()> &	process,
		const std::function< void()> &	cleanup
	)

Definition at line 46 of file threadloop.cpp.

~ThreadLoop()

jami::ThreadLoop::~ThreadLoop ( )

virtual

Definition at line 55 of file threadloop.cpp.

References isRunning(), JAMI_ERR, and join().

Here is the call graph for this function:

Member Function Documentation

exit()

void jami::ThreadLoop::exit

(

)

Definition at line 107 of file threadloop.cpp.

References stop().

Here is the call graph for this function:

get_id()

std::thread::id jami::ThreadLoop::get_id ( ) const

inlinenoexcept

Definition at line 53 of file threadloop.h.

Referenced by jami::InterruptedThreadLoop::wait(), jami::InterruptedThreadLoop::wait_for(), and jami::InterruptedThreadLoop::wait_for().

isRunning()

bool jami::ThreadLoop::isRunning ( ) const

noexcept

Definition at line 114 of file threadloop.cpp.

References jami::emitSignal(), and RUNNING.

Referenced by jami::video::VideoReceiveThread::decodeFrame(), jami::AudioInput::isCapturing(), jami::video::VideoReceiveThread::startSink(), jami::video::VideoReceiveThread::stopSink(), jami::AudioInput::switchInput(), and ~ThreadLoop().

Here is the call graph for this function:

isStopping()

bool jami::ThreadLoop::isStopping ( ) const

inlinenoexcept

Definition at line 52 of file threadloop.h.

References STOPPING.

Referenced by jami::video::VideoInput::restart(), jami::video::VideoReceiveThread::stopLoop(), jami::InterruptedThreadLoop::wait(), jami::InterruptedThreadLoop::wait_for(), and jami::InterruptedThreadLoop::wait_for().

join()

void jami::ThreadLoop::join

(

)

Definition at line 92 of file threadloop.cpp.

References stop().

Referenced by jami::AudioRtpSession::stop(), jami::video::VideoRtpSession::stop(), jami::video::VideoReceiveThread::stopLoop(), jami::AudioInput::~AudioInput(), jami::AudioReceiveThread::~AudioReceiveThread(), jami::MediaPlayer::~MediaPlayer(), ~ThreadLoop(), jami::video::VideoInput::~VideoInput(), jami::video::VideoMixer::~VideoMixer(), and jami::video::VideoReceiveThread::~VideoReceiveThread().

Here is the call graph for this function:

start()

void jami::ThreadLoop::start

(

)

Definition at line 64 of file threadloop.cpp.

References jami::emitSignal(), JAMI_DBG, JAMI_ERR, RUNNING, and STOPPING.

Referenced by jami::AudioInput::configureFilePlayback(), jami::video::VideoInput::configureFilePlayback(), jami::AudioInput::start(), jami::video::VideoReceiveThread::startLoop(), jami::AudioReceiveThread::startReceiver(), and jami::AudioInput::switchInput().

Here is the call graph for this function:

stop()

void jami::ThreadLoop::stop ( )

virtual

Reimplemented in jami::InterruptedThreadLoop.

Definition at line 85 of file threadloop.cpp.

References jami::emitSignal(), RUNNING, and STOPPING.

Referenced by jami::video::VideoReceiveThread::decodeFrame(), exit(), join(), jami::InterruptedThreadLoop::stop(), jami::video::VideoReceiveThread::stopLoop(), and jami::AudioReceiveThread::stopReceiver().

Here is the call graph for this function:

waitForCompletion()

void jami::ThreadLoop::waitForCompletion

(

)

Definition at line 100 of file threadloop.cpp.

---

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

• threadloop.h
• threadloop.cpp