Base class for application with thread. More...

#include <tf_testthread.h>

Inheritance diagram for TF_TestThread:

Public Member Functions
virtual void	CleanupInThread ()=0
	Free any resource. More...

void *	Execute ()

virtual void	GetResult ()
	Show result of test. More...

virtual void	GetResultInThread ()=0
	Show result. More...

virtual int	isComplete ()
	Return 1 when test is complete. More...

virtual int	Prepare (int cnt)
	Prepare test. More...

virtual void	PrepareInThread ()=0
	Prepare test. More...

virtual void	Run ()=0
	Main body of user test. More...

virtual void	Start ()
	Start of test. More...

virtual void	StepTable ()=0
	Show status information into test table. More...

virtual void	Stop ()
	Stop of test. More...

	TF_TestThread (TableEngine pTable, int argc, char *argv)

virtual	~TF_TestThread ()

Public Member Functions inherited from TF_Test
virtual void	StepMainThread ()
	Don't use. Reserve for future. More...

	TF_Test (TableEngine *pTable)

Static Public Member Functions
static void *	ThreadFunc (void *lpvThreadParm)

Public Attributes
pthread_attr_t	m_attrThread

int	m_CycleCnt

pthread_t	m_hThread

int	m_isComplete

int	m_isException

int	m_isPrepareComplete

int	m_isTerminate

pthread_mutex_t	m_ResultCompleteMutex

pthread_mutex_t	m_ResultStartMutex

pthread_mutex_t	m_StartMutex

pthread_mutex_t	m_ThreadExitMutex

Public Attributes inherited from TF_Test
TableEngine *	m_pTemplateEngine

Detailed Description

Base class for application with thread.

Class creates additional thread.

Definition at line 23 of file tf_testthread.h.

Constructor & Destructor Documentation

◆ TF_TestThread()

TF_TestThread::TF_TestThread	(	TableEngine *	pTable,
		int	argc,
		char **	argv
	)

Definition at line 21 of file tf_testthread.cpp.

References m_CycleCnt, m_isComplete, m_isException, m_isPrepareComplete, m_isTerminate, m_ResultCompleteMutex, m_ResultStartMutex, m_StartMutex, and m_ThreadExitMutex.

                                                                          : TF_Test( pTable )
 {
     //fprintf(stderr, "TF_TestThread::%s(): ID - %ld\n", __FUNCTION__, pthread_self());
 
     m_isPrepareComplete=0;
     m_isComplete=0;
     m_isTerminate=0;
     m_CycleCnt=0;
     m_isException=0;
 
     pthread_mutex_init(&m_ResultStartMutex, 0);
     pthread_mutex_init(&m_ResultCompleteMutex, 0);
     pthread_mutex_init(&m_StartMutex, 0);
     pthread_mutex_init(&m_ThreadExitMutex, 0);
 
     // Lock mutex for Start and GetResult
     pthread_mutex_lock(&m_ResultStartMutex);
     pthread_mutex_lock(&m_ResultCompleteMutex);
     pthread_mutex_lock(&m_StartMutex);
     //pthread_mutex_lock(&m_ThreadExitMutex);
 
 }

◆ ~TF_TestThread()

TF_TestThread::~TF_TestThread ( )

virtual

Definition at line 47 of file tf_testthread.cpp.

References m_ThreadExitMutex.

 {
     //fprintf(stderr, "TF_TestThread::%s(): ID - %ld\n", __FUNCTION__, pthread_self());
     pthread_mutex_lock(&m_ThreadExitMutex);
     //fprintf(stderr, "TF_TestThread::%s(): ID - %ld (COMPLETE)\n", __FUNCTION__, pthread_self());
 }

Member Function Documentation

◆ CleanupInThread()

virtual void TF_TestThread::CleanupInThread ( )

pure virtual

Free any resource.

Implemented in TF_CheckTransferIn, and TF_CheckTransferOut.

Referenced by Execute().

◆ Execute()

void * TF_TestThread::Execute ( )

Definition at line 102 of file tf_testthread.cpp.

References CleanupInThread(), GetResultInThread(), _except_info_t::info, m_isComplete, m_isException, m_isPrepareComplete, m_ResultCompleteMutex, m_ResultStartMutex, m_StartMutex, m_ThreadExitMutex, PrepareInThread(), and Run().

Referenced by ThreadFunc().

 {
     try
     {
         pthread_mutex_lock(&m_ThreadExitMutex);
 
         PrepareInThread();
 
 
         m_isPrepareComplete = 1;
 
         // Sleep here while TF_TestThread::Start() will be called in another thread
         pthread_mutex_lock(&m_StartMutex);
 
         //fprintf(stderr, "TF_TestThread::%s(): ID - %ld (START)\n", __FUNCTION__, pthread_self());
 
         // Working forever while m_isTerminate == 0
         Run();
 
         m_isComplete = 1;
 
         // Wait while TF_TestThread::GetResult() will be called
         pthread_mutex_lock( &m_ResultStartMutex );
 
         GetResultInThread();
 
         // Unlock mutex for complete GetResult() execution
         pthread_mutex_unlock(&m_ResultCompleteMutex);
 
         CleanupInThread();
 
         // Unlock mutex for complete TF_TestThread::~TF_TestThread() execution
         pthread_mutex_unlock(&m_ThreadExitMutex);
 
         //fprintf(stderr, "TF_TestThread::%s(): ID - %ld (COMPLETE)\n", __FUNCTION__, pthread_self());
 
     }
     catch( except_info_t err )
     {
         printf( "\n\n\n\n\n\n\n                \n Error in thread:\n%s\n                 \n", err.info.c_str());
         m_isComplete = 1;
         m_isException = 1;
         pthread_mutex_unlock(&m_ThreadExitMutex);
     }
 
     catch( ... )
     {
         printf( "\n\n\n                \n Unknow error in thread\n                 \n" );
         m_isComplete = 1;
         m_isException = 1;
         pthread_mutex_unlock(&m_ThreadExitMutex);
 
     }
 
     return 0;
 }

◆ GetResult()

void TF_TestThread::GetResult ( )

virtual

Show result of test.

Reimplemented from TF_Test.

Definition at line 188 of file tf_testthread.cpp.

References m_ResultCompleteMutex, and m_ResultStartMutex.

 {
     //fprintf(stderr, "TF_TestThread::%s(): ID - %ld (START)\n", __FUNCTION__, pthread_self());
 
     // Unlock mutex for finish Execute()
     pthread_mutex_unlock(&m_ResultStartMutex);
 
     //fprintf(stderr, "TF_TestThread::%s(): ID - %ld (Unlock m_ResultStartMutex)\n", __FUNCTION__, pthread_self());
 
     // Waiting here while GetResultInThread() will be called and complete from Execute();
     pthread_mutex_lock(&m_ResultCompleteMutex);
 
     //fprintf(stderr, "TF_TestThread::%s(): ID - %ld (COMPLETE)\n", __FUNCTION__, pthread_self());
 }

◆ GetResultInThread()

virtual void TF_TestThread::GetResultInThread ( )

pure virtual

Show result.

Implemented in TF_CheckTransferIn, and TF_CheckTransferOut.

Referenced by Execute().

◆ isComplete()

int TF_TestThread::isComplete ( )

virtual

Return 1 when test is complete.

Reimplemented from TF_Test.

Definition at line 178 of file tf_testthread.cpp.

References m_isComplete.

 {
     //if(m_isComplete > 0)
         //fprintf(stderr, "TF_TestThread::%s(): ID - %ld\n", __FUNCTION__, pthread_self());
 
     return m_isComplete;
 }

◆ Prepare()

int TF_TestThread::Prepare ( int cnt )

virtual

Prepare test.

Parameters

cnt	number of call function

Returns: 1 - prepare complete, 0 - prepare don't complete

Function is called during test preparation. Preparation of the test can be very long. When preparation is complete function must be return 1.

Preparation of the all tests is complete when all tests return 1

Implements TF_Test.

Definition at line 56 of file tf_testthread.cpp.

References except_info(), m_attrThread, m_hThread, m_isException, m_isPrepareComplete, and ThreadFunc().

 {
     if( 0==cnt )
     {
         //fprintf(stderr, "TF_TestThread::%s(): ID - %ld\n", __FUNCTION__, pthread_self());
         int res = pthread_attr_init(&m_attrThread);
         if(res != 0) {
             fprintf(stderr, "%s\n", "Stream not started");
             throw( "Stream not started" );
         }
 
         res = pthread_attr_setdetachstate(&m_attrThread, PTHREAD_CREATE_JOINABLE);
         if(res != 0) {
             fprintf(stderr, "%s\n", "Stream not started");
             throw( "Stream not started" );
         }
 
         res = pthread_create(&m_hThread, &m_attrThread, ThreadFunc, this);
         if(res != 0) {
             fprintf(stderr, "%s\n", "Stream not started");
             throw( "Stream not started" );
         }
     }
 
     int ret=m_isPrepareComplete;
 
     if( m_isException )
     {
         throw except_info( "%s - exception during execute", __FUNCTION__ );
     }
     return ret;
 }

◆ PrepareInThread()

virtual void TF_TestThread::PrepareInThread ( )

pure virtual

Prepare test.

Implemented in TF_CheckTransferIn, and TF_CheckTransferOut.

Referenced by Execute().

◆ Run()

virtual void TF_TestThread::Run ( )

pure virtual

Main body of user test.

Implemented in TF_CheckTransferIn, and TF_CheckTransferOut.

Referenced by Execute().

◆ Start()

void TF_TestThread::Start ( )

virtual

Start of test.

Implements TF_Test.

Definition at line 161 of file tf_testthread.cpp.

References m_StartMutex.

 {
     // Unlock mutex for unblock TF_TestThread::Execute() function
     pthread_mutex_unlock(&m_StartMutex);
     //fprintf(stderr, "TF_TestThread::%s(): ID - %ld\n", __FUNCTION__, pthread_self());
 }

◆ StepTable()

virtual void TF_TestThread::StepTable ( )

pure virtual

Show status information into test table.

Reimplemented from TF_Test.

Implemented in TF_CheckTransferIn, and TF_CheckTransferOut.

◆ Stop()

void TF_TestThread::Stop ( )

virtual

Stop of test.

Reimplemented from TF_Test.

Definition at line 170 of file tf_testthread.cpp.

References m_isTerminate.

 {
     m_isTerminate = 1;
     //fprintf(stderr, "TF_TestThread::%s(): ID - %ld\n", __FUNCTION__, pthread_self());
 }

◆ ThreadFunc()

void * TF_TestThread::ThreadFunc ( void * lpvThreadParm )

static

Definition at line 91 of file tf_testthread.cpp.

References Execute().

Referenced by Prepare().

 {
     TF_TestThread *test=(TF_TestThread*)lpvThreadParm;
     if(!test)
         return 0;
     //fprintf(stderr, "TF_TestThread::%s(): ID - %ld\n", __FUNCTION__, pthread_self());
     return test->Execute();
 }

Member Data Documentation

◆ m_attrThread

pthread_attr_t TF_TestThread::m_attrThread

Definition at line 67 of file tf_testthread.h.

Referenced by Prepare().

◆ m_CycleCnt

int TF_TestThread::m_CycleCnt

Definition at line 58 of file tf_testthread.h.

Referenced by TF_TestThread().

◆ m_hThread

pthread_t TF_TestThread::m_hThread

Definition at line 66 of file tf_testthread.h.

Referenced by Prepare().

◆ m_isComplete

int TF_TestThread::m_isComplete

Definition at line 56 of file tf_testthread.h.

Referenced by Execute(), isComplete(), and TF_TestThread().

◆ m_isException

int TF_TestThread::m_isException

Definition at line 59 of file tf_testthread.h.

Referenced by Execute(), Prepare(), and TF_TestThread().

◆ m_isPrepareComplete

int TF_TestThread::m_isPrepareComplete

Definition at line 55 of file tf_testthread.h.

Referenced by Execute(), Prepare(), and TF_TestThread().

◆ m_isTerminate

int TF_TestThread::m_isTerminate

Definition at line 57 of file tf_testthread.h.

Referenced by TF_CheckTransferIn::Run(), TF_CheckTransferOut::Run(), Stop(), and TF_TestThread().

◆ m_ResultCompleteMutex

pthread_mutex_t TF_TestThread::m_ResultCompleteMutex

Definition at line 62 of file tf_testthread.h.

Referenced by Execute(), GetResult(), and TF_TestThread().

◆ m_ResultStartMutex

pthread_mutex_t TF_TestThread::m_ResultStartMutex

Definition at line 61 of file tf_testthread.h.

Referenced by Execute(), GetResult(), and TF_TestThread().

◆ m_StartMutex

pthread_mutex_t TF_TestThread::m_StartMutex

Definition at line 63 of file tf_testthread.h.

Referenced by Execute(), Start(), and TF_TestThread().

◆ m_ThreadExitMutex

pthread_mutex_t TF_TestThread::m_ThreadExitMutex

Definition at line 64 of file tf_testthread.h.

Referenced by Execute(), TF_TestThread(), and ~TF_TestThread().

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

host_util/tf_testthread.h
host_util/tf_testthread.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TF_TestThread()

◆ ~TF_TestThread()

Member Function Documentation

◆ CleanupInThread()

◆ Execute()

◆ GetResult()

◆ GetResultInThread()

◆ isComplete()

◆ Prepare()

◆ PrepareInThread()

◆ Run()

◆ Start()

◆ StepTable()

◆ Stop()

◆ ThreadFunc()

Member Data Documentation

◆ m_attrThread

◆ m_CycleCnt

◆ m_hThread

◆ m_isComplete

◆ m_isException

◆ m_isPrepareComplete

◆ m_isTerminate

◆ m_ResultCompleteMutex

◆ m_ResultStartMutex

◆ m_StartMutex

◆ m_ThreadExitMutex