#include <Thread.hh>

Inheritance diagram for Thread:

Classes
class	cancellation
class	deadlock
class	invalid_argument
class	range_error
class	Self
	Operates on current thread. More...

Public Types
enum	cancel_type { CANCEL_ABANDON , CANCEL_IGNORE , CANCEL_ASYNCHRONOUS , CANCEL_DEFERRED , CANCEL_EXCEPTION , CANCEL_BY_SIGNAL , CANCEL_UNKNOWN , CANCEL_ABANDON , CANCEL_IGNORE , CANCEL_ASYNCHRONOUS , CANCEL_DEFERRED , CANCEL_EXCEPTION , CANCEL_BY_SIGNAL , CANCEL_UNKNOWN }
enum	cancel_type { CANCEL_ABANDON , CANCEL_IGNORE , CANCEL_ASYNCHRONOUS , CANCEL_DEFERRED , CANCEL_EXCEPTION , CANCEL_BY_SIGNAL , CANCEL_UNKNOWN , CANCEL_ABANDON , CANCEL_IGNORE , CANCEL_ASYNCHRONOUS , CANCEL_DEFERRED , CANCEL_EXCEPTION , CANCEL_BY_SIGNAL , CANCEL_UNKNOWN }
typedef SignalHandler::signal_type	signal_type
typedef SignalHandler::signal_type	signal_type
typedef void(*	cleanup_function_type) (void *)
typedef void(*	cleanup_function_type) (void *)

Public Member Functions
	Thread ()
	Thread ()
virtual	~Thread ()
virtual	~Thread ()
virtual void	Cancel ()
virtual void	Cancel ()
void	CancellationCheck (const std::string &Header, const char *File, const int Line) const
	Deliver pending cancellation requests to the calling thread.
void	CancellationCheck (const std::string &Header, const char *File, const int Line) const
	Deliver pending cancellation requests to the calling thread.
void	CancellationEnable (bool Value)
void	CancellationEnable (bool Value)
cancel_type	CancellationType (signal_type &Signal) const
	Return the type of cancellation.
void	CancellationType (cancel_type Type, signal_type Signal=SignalHandler::SIGNAL_UNKNOWN)
	Establiosh the type of cancellation.
cancel_type	CancellationType (signal_type &Signal) const
	Return the type of cancellation.
void	CancellationType (cancel_type Type, signal_type Signal=SignalHandler::SIGNAL_UNKNOWN)
	Establiosh the type of cancellation.
void	Detach () const
void	Detach () const
virtual void	Join ()
virtual void	Join ()
bool	IsAlive () const
bool	IsAlive () const
bool	IsCancelled () const
	Return the cancellation state of the thread.
bool	IsCancelled () const
	Return the cancellation state of the thread.
bool	IsDetached () const
	Reports detached state.
bool	IsDetached () const
	Reports detached state.
bool	IsParentThread () const
bool	IsParentThread () const
int	Kill (signal_type Signal) const
int	Kill (signal_type Signal) const
thread_type	ParentThread () const
	Retrieve key for parent thread.
thread_type	ParentThread () const
	Retrieve key for parent thread.
virtual int	Spawn ()
virtual int	Spawn ()
void	SignalCapture (signal_type Sig)
void	SignalCapture (signal_type Sig)
void	SignalIgnore (signal_type Sig)
void	SignalIgnore (signal_type Sig)
bool	operator== (const Thread &Source) const
bool	operator== (const Thread &Source) const

Static Public Member Functions
static void	SelfCancellationCheck (const std::string &Header, const char *File, const int Line)
static void	SelfCancellationCheck (const std::string &Header, const char *File, const int Line)
static size_t	StackSizeDefault ()
static void	StackSizeDefault (size_t StackSize)
static size_t	StackSizeDefault ()
static void	StackSizeDefault (size_t StackSize)

Protected Types
typedef void (	start_function_type) (void *)
typedef void (	start_function_type) (void *)

Protected Member Functions
virtual void	action ()=0
	Job to be acomplished by the thread.
virtual void	action ()=0
	Job to be acomplished by the thread.
int	spawn (start_function_type StartFunction=(start_function_type) start_routine)
	Spawn a new thread.
int	spawn (start_function_type StartFunction=(start_function_type) start_routine)
	Spawn a new thread.
thread_type	threadId () const
thread_type	threadId () const

Static Protected Member Functions
static void	cancelCleanup (Thread *Source)
	Perform cleanup of a cancelled thread.
static void	cancelCleanup (Thread *Source)
	Perform cleanup of a cancelled thread.

Private Member Functions
void	cancellation_enable (bool Value)
void	cancellation_enable (bool Value)
void	set_cancelled_state ()
void	set_cancelled_state ()

Static Private Member Functions
static Thread *	start_routine (Thread *ThreadSource)
static Thread *	start_routine (Thread *ThreadSource)

Private Attributes
boost::shared_ptr< impl >	p
signal_type	m_cancel_via_signal
	Signal to use for cancelation.
bool	m_cancel_state
	Enable or disable the cancellability of a thread.
bool	m_cancel_thread
	Conditional state of thread being cancelled.
cancel_type	m_cancellation_type
	Method used for thread cancellation.
bool	detached
	State of detached.

Member Typedef Documentation

◆ cleanup_function_type [1/2]

typedef void(* LDASTools::AL::Thread::cleanup_function_type) (void *)

◆ cleanup_function_type [2/2]

typedef void(* LDASTools::AL::Thread::cleanup_function_type) (void *)

◆ signal_type [1/2]

typedef SignalHandler::signal_type LDASTools::AL::Thread::signal_type

◆ signal_type [2/2]

typedef SignalHandler::signal_type LDASTools::AL::Thread::signal_type

◆ start_function_type [1/2]

typedef void *(* LDASTools::AL::Thread::start_function_type) (void *)

protected

◆ start_function_type [2/2]

typedef void *(* LDASTools::AL::Thread::start_function_type) (void *)

protected

Member Enumeration Documentation

◆ cancel_type [1/2]

enum LDASTools::AL::Thread::cancel_type

Enumerator
CANCEL_ABANDON
CANCEL_IGNORE
CANCEL_ASYNCHRONOUS
CANCEL_DEFERRED
CANCEL_EXCEPTION
CANCEL_BY_SIGNAL
CANCEL_UNKNOWN
CANCEL_ABANDON
CANCEL_IGNORE
CANCEL_ASYNCHRONOUS
CANCEL_DEFERRED
CANCEL_EXCEPTION
CANCEL_BY_SIGNAL
CANCEL_UNKNOWN

◆ cancel_type [2/2]

enum LDASTools::AL::Thread::cancel_type

Enumerator
CANCEL_ABANDON
CANCEL_IGNORE
CANCEL_ASYNCHRONOUS
CANCEL_DEFERRED
CANCEL_EXCEPTION
CANCEL_BY_SIGNAL
CANCEL_UNKNOWN
CANCEL_ABANDON
CANCEL_IGNORE
CANCEL_ASYNCHRONOUS
CANCEL_DEFERRED
CANCEL_EXCEPTION
CANCEL_BY_SIGNAL
CANCEL_UNKNOWN

Constructor & Destructor Documentation

◆ Thread() [1/2]

LDASTools::AL::Thread::Thread ( )

◆ Thread() [2/2]

LDASTools::AL::Thread::Thread ( )

◆ ~Thread() [1/2]

LDASTools::AL::Thread::~Thread ( )

virtual

◆ ~Thread() [2/2]

virtual LDASTools::AL::Thread::~Thread ( )

virtual

Member Function Documentation

◆ action() [1/2]

virtual void LDASTools::AL::Thread::action ( )

protectedpure virtual

Job to be acomplished by the thread.

◆ action() [2/2]

virtual void LDASTools::AL::Thread::action ( )

protectedpure virtual

Job to be acomplished by the thread.

◆ Cancel() [1/2]

void LDASTools::AL::Thread::Cancel ( )

virtual

◆ Cancel() [2/2]

virtual void LDASTools::AL::Thread::Cancel ( )

virtual

◆ cancelCleanup() [1/2]

void LDASTools::AL::Thread::cancelCleanup ( Thread * Source )

staticprotected

Perform cleanup of a cancelled thread.

Parameters

[in] Source The thread being cancelled.

◆ cancelCleanup() [2/2]

void LDASTools::AL::Thread::cancelCleanup ( Thread * Source )

staticprotected

Perform cleanup of a cancelled thread.

Parameters

[in] Source The thread being cancelled.

◆ cancellation_enable() [1/2]

void LDASTools::AL::Thread::cancellation_enable ( bool Value )

private

Establish the cancellability of a thread. If a Value of true is passed, then the thread will allow cancellation as determined by the call to CancellationType.

Note: This call must only be made by a child thread.

See also: CancellationType

◆ cancellation_enable() [2/2]

void LDASTools::AL::Thread::cancellation_enable ( bool Value )

private

◆ CancellationCheck() [1/2]

void LDASTools::AL::Thread::CancellationCheck	(	const std::string &	Header,
		const char *	File,
		const int	Line ) const

Deliver pending cancellation requests to the calling thread.

Parameters

[in]	Header	Description of the method from which the request was made
[in]	File	Filename from where the request was made.
[in]	Line	Line number in Filename from where the request was made.

Deliver any pending cancellation requests to the calling thread. If cancellation is to be done via exception, then a cancellation exception is throw. If not, then a call to the appropriate thread library's cancellation routine is made.

Note: This call must only be made by a child thread.

◆ CancellationCheck() [2/2]

void LDASTools::AL::Thread::CancellationCheck	(	const std::string &	Header,
		const char *	File,
		const int	Line ) const

Deliver pending cancellation requests to the calling thread.

Parameters

[in]	Header	Description of the method from which the request was made
[in]	File	Filename from where the request was made.
[in]	Line	Line number in Filename from where the request was made.

◆ CancellationEnable() [1/2]

void LDASTools::AL::Thread::CancellationEnable ( bool Value )

◆ CancellationEnable() [2/2]

void LDASTools::AL::Thread::CancellationEnable ( bool Value )

◆ CancellationType() [1/4]

void LDASTools::AL::Thread::CancellationType	(	cancel_type	Type,
		signal_type	Signal = SignalHandler::SIGNAL_UNKNOWN )

Establiosh the type of cancellation.

Parameters

[in]	Type	The type of cancellation.
[in]	Signal	Any auxiliary information associated with the cancellation type.

Sets a how a thread can be cancelled.

CANCEL_ASYNCHRONOUS A cancellation request is immediated delivered to the thread.
CANCEL_DEFERRED A cancellation request is marked pending for the thread and the thread is cancelled when it gets to a system cancellation point or when CancellationCheck is called.
CANCEL_EXCEPTION A cancellation request is marked pending for the thread and the thread throws a cancellation exception upon calling CancellationCheck.

Note: This call must only be made by a chivld thread.

See also: CancellationEnable, CancellationCheck

◆ CancellationType() [2/4]

void LDASTools::AL::Thread::CancellationType	(	cancel_type	Type,
		signal_type	Signal = SignalHandler::SIGNAL_UNKNOWN )

Establiosh the type of cancellation.

Parameters

[in]	Type	The type of cancellation.
[in]	Signal	Any auxiliary information associated with the cancellation type.

◆ CancellationType() [3/4]

Thread::cancel_type LDASTools::AL::Thread::CancellationType ( signal_type & Signal ) const

Return the type of cancellation.

Parameters

[out] Signal Any auxiliary information associated with the cancellation type

Returns: The type of cancellation.

See also: cancel_type

◆ CancellationType() [4/4]

cancel_type LDASTools::AL::Thread::CancellationType ( signal_type & Signal ) const

Return the type of cancellation.

Parameters

[out] Signal Any auxiliary information associated with the cancellation type

Returns: The type of cancellation.

See also: cancel_type

◆ Detach() [1/2]

void LDASTools::AL::Thread::Detach ( ) const

◆ Detach() [2/2]

void LDASTools::AL::Thread::Detach ( ) const

◆ IsAlive() [1/2]

bool LDASTools::AL::Thread::IsAlive ( ) const

◆ IsAlive() [2/2]

bool LDASTools::AL::Thread::IsAlive ( ) const

◆ IsCancelled() [1/2]

bool LDASTools::AL::Thread::IsCancelled ( ) const

Return the cancellation state of the thread.

Returns: Returns true if the thread has been cancelled, false otherwise.

◆ IsCancelled() [2/2]

bool LDASTools::AL::Thread::IsCancelled ( ) const

Return the cancellation state of the thread.

Returns: Returns true if the thread has been cancelled, false otherwise.

◆ IsDetached() [1/2]

bool LDASTools::AL::Thread::IsDetached ( ) const

Reports detached state.

Returns: Returns true if the thread has been detached, false otherwise

◆ IsDetached() [2/2]

bool LDASTools::AL::Thread::IsDetached ( ) const

Reports detached state.

Returns: Returns true if the thread has been detached, false otherwise

◆ IsParentThread() [1/2]

bool LDASTools::AL::Thread::IsParentThread ( ) const

◆ IsParentThread() [2/2]

bool LDASTools::AL::Thread::IsParentThread ( ) const

◆ Join() [1/2]

void LDASTools::AL::Thread::Join ( )

virtual

◆ Join() [2/2]

virtual void LDASTools::AL::Thread::Join ( )

virtual

◆ Kill() [1/2]

int LDASTools::AL::Thread::Kill ( signal_type Signal ) const

◆ Kill() [2/2]

int LDASTools::AL::Thread::Kill ( signal_type Signal ) const

◆ operator==() [1/2]

bool LDASTools::AL::Thread::operator== ( const Thread & Source ) const

◆ operator==() [2/2]

bool LDASTools::AL::Thread::operator== ( const Thread & Source ) const

◆ ParentThread() [1/2]

Thread::thread_type LDASTools::AL::Thread::ParentThread ( ) const

inline

Retrieve key for parent thread.

◆ ParentThread() [2/2]

thread_type LDASTools::AL::Thread::ParentThread ( ) const

Retrieve key for parent thread.

◆ SelfCancellationCheck() [1/2]

void LDASTools::AL::Thread::SelfCancellationCheck	(	const std::string &	Header,
		const char *	File,
		const int	Line )

static

◆ SelfCancellationCheck() [2/2]

void LDASTools::AL::Thread::SelfCancellationCheck	(	const std::string &	Header,
		const char *	File,
		const int	Line )

static

◆ set_cancelled_state() [1/2]

void LDASTools::AL::Thread::set_cancelled_state ( )

private

◆ set_cancelled_state() [2/2]

void LDASTools::AL::Thread::set_cancelled_state ( )

private

◆ SignalCapture() [1/2]

void LDASTools::AL::Thread::SignalCapture ( SignalHandler::signal_type Sig )

◆ SignalCapture() [2/2]

void LDASTools::AL::Thread::SignalCapture ( signal_type Sig )

◆ SignalIgnore() [1/2]

void LDASTools::AL::Thread::SignalIgnore ( SignalHandler::signal_type Sig )

◆ SignalIgnore() [2/2]

void LDASTools::AL::Thread::SignalIgnore ( signal_type Sig )

◆ Spawn() [1/2]

int LDASTools::AL::Thread::Spawn ( )

virtual

◆ Spawn() [2/2]

virtual int LDASTools::AL::Thread::Spawn ( )

virtual

◆ spawn() [1/2]

int LDASTools::AL::Thread::spawn ( start_function_type StartFunction = (start_function_type) start_routine )

protected

Spawn a new thread.

Parameters

[in] StartFunction The routine for the new thread to start.

◆ spawn() [2/2]

int LDASTools::AL::Thread::spawn ( start_function_type StartFunction = (start_function_type) start_routine )

protected

Spawn a new thread.

Parameters

[in] StartFunction The routine for the new thread to start.

◆ StackSizeDefault() [1/4]

size_t LDASTools::AL::Thread::StackSizeDefault ( )

inlinestatic

◆ StackSizeDefault() [2/4]

size_t LDASTools::AL::Thread::StackSizeDefault ( )

static

◆ StackSizeDefault() [3/4]

void LDASTools::AL::Thread::StackSizeDefault ( size_t StackSize )

static

Establish the default value of the stack size used when creating new threads. This routine does validate the requested value..

◆ StackSizeDefault() [4/4]

void LDASTools::AL::Thread::StackSizeDefault ( size_t StackSize )

static

◆ start_routine() [1/2]

Thread * LDASTools::AL::Thread::start_routine ( Thread * ThreadSource )

staticprivate

◆ start_routine() [2/2]

Thread * LDASTools::AL::Thread::start_routine ( Thread * ThreadSource )

staticprivate

◆ threadId() [1/2]

Thread::thread_type LDASTools::AL::Thread::threadId ( ) const

inlineprotected

◆ threadId() [2/2]

thread_type LDASTools::AL::Thread::threadId ( ) const

protected

Member Data Documentation

◆ detached

bool LDASTools::AL::Thread::detached

mutableprivate

State of detached.

◆ m_cancel_state

bool LDASTools::AL::Thread::m_cancel_state

mutableprivate

Enable or disable the cancellability of a thread.

◆ m_cancel_thread

bool LDASTools::AL::Thread::m_cancel_thread

mutableprivate

Conditional state of thread being cancelled.

◆ m_cancel_via_signal

signal_type LDASTools::AL::Thread::m_cancel_via_signal

private

Signal to use for cancelation.

◆ m_cancellation_type

cancel_type LDASTools::AL::Thread::m_cancellation_type

mutableprivate

Method used for thread cancellation.

◆ p

boost::shared_ptr< impl > LDASTools::AL::Thread::p

private

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

/home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/build/include/ldastoolsal/Thread.hh
/home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/src/Thread.hh
/home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/src/Thread.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Member Typedef Documentation

◆ cleanup_function_type [1/2]

◆ cleanup_function_type [2/2]

◆ signal_type [1/2]

◆ signal_type [2/2]

◆ start_function_type [1/2]

◆ start_function_type [2/2]

Member Enumeration Documentation

◆ cancel_type [1/2]

◆ cancel_type [2/2]

Constructor & Destructor Documentation

◆ Thread() [1/2]

◆ Thread() [2/2]

◆ ~Thread() [1/2]

◆ ~Thread() [2/2]

Member Function Documentation

◆ action() [1/2]

◆ action() [2/2]

◆ Cancel() [1/2]

◆ Cancel() [2/2]

◆ cancelCleanup() [1/2]

◆ cancelCleanup() [2/2]

◆ cancellation_enable() [1/2]

◆ cancellation_enable() [2/2]

◆ CancellationCheck() [1/2]

◆ CancellationCheck() [2/2]

◆ CancellationEnable() [1/2]

◆ CancellationEnable() [2/2]

◆ CancellationType() [1/4]

◆ CancellationType() [2/4]

◆ CancellationType() [3/4]

◆ CancellationType() [4/4]

◆ Detach() [1/2]

◆ Detach() [2/2]

◆ IsAlive() [1/2]

◆ IsAlive() [2/2]

◆ IsCancelled() [1/2]

◆ IsCancelled() [2/2]

◆ IsDetached() [1/2]

◆ IsDetached() [2/2]

◆ IsParentThread() [1/2]

◆ IsParentThread() [2/2]

◆ Join() [1/2]

◆ Join() [2/2]

◆ Kill() [1/2]

◆ Kill() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ ParentThread() [1/2]

◆ ParentThread() [2/2]

◆ SelfCancellationCheck() [1/2]

◆ SelfCancellationCheck() [2/2]

◆ set_cancelled_state() [1/2]

◆ set_cancelled_state() [2/2]

◆ SignalCapture() [1/2]

◆ SignalCapture() [2/2]

◆ SignalIgnore() [1/2]

◆ SignalIgnore() [2/2]

◆ Spawn() [1/2]

◆ Spawn() [2/2]

◆ spawn() [1/2]

◆ spawn() [2/2]

◆ StackSizeDefault() [1/4]

◆ StackSizeDefault() [2/4]

◆ StackSizeDefault() [3/4]

◆ StackSizeDefault() [4/4]

◆ start_routine() [1/2]

◆ start_routine() [2/2]

◆ threadId() [1/2]

◆ threadId() [2/2]