Semaphore Class Reference

#include <kaldi-semaphore.h>

Collaboration diagram for Semaphore:

Public Member Functions
	Semaphore (int32 count=0)
	~Semaphore ()
bool	TryWait ()
	Returns true if Wait() goes through. More...
void	Wait ()
	decrease the counter More...
void	Signal ()
	increase the counter More...

Private Member Functions
	KALDI_DISALLOW_COPY_AND_ASSIGN (Semaphore)

Private Attributes
int32	count_
	the semaphore counter, 0 means block on Wait() More...
std::mutex	mutex_
std::condition_variable	condition_variable_

Detailed Description

Definition at line 30 of file kaldi-semaphore.h.

Constructor & Destructor Documentation

Semaphore()

Semaphore

(

int32

count = 0

)

Definition at line 28 of file kaldi-semaphore.cc.

References count, Semaphore::count_, and KALDI_ASSERT.

                                {
  KALDI_ASSERT(count >= 0);
  count_ = count;
}

~Semaphore()

~Semaphore

(

)

Definition at line 33 of file kaldi-semaphore.cc.

{}

Member Function Documentation

KALDI_DISALLOW_COPY_AND_ASSIGN()

KALDI_DISALLOW_COPY_AND_ASSIGN ( Semaphore  )

private

Signal()

void Signal

(

)

increase the counter

Definition at line 51 of file kaldi-semaphore.cc.

References Semaphore::condition_variable_, Semaphore::count_, and Semaphore::mutex_.

Referenced by DiscriminativeExamplesRepository::AcceptExample(), NnetBatchInference::AcceptInput(), NnetBatchDecoder::AcceptInput(), NnetBatchDecoder::Decode(), DiscriminativeExamplesRepository::ExamplesDone(), NnetBatchInference::Finished(), NnetBatchDecoder::Finished(), NnetExampleBackgroundReader::GetNextMinibatch(), NnetExampleBackgroundReader::NnetExampleBackgroundReader(), DiscriminativeExamplesRepository::ProvideExample(), NnetExampleBackgroundReader::ReadExamples(), TaskSequencer< C >::RunTask(), ThreadSynchronizer::SetAbort(), ThreadSynchronizer::ThreadSynchronizer(), and ThreadSynchronizer::UnlockSuccess().

                       {
  std::unique_lock<std::mutex> lock(mutex_);
  count_++;
  condition_variable_.notify_one();
}

TryWait()

bool TryWait

(

)

Returns true if Wait() goes through.

Definition at line 35 of file kaldi-semaphore.cc.

References Semaphore::count_, and Semaphore::mutex_.

Referenced by NnetBatchInference::GetOutput().

                        {
  std::unique_lock<std::mutex> lock(mutex_);
  if(count_) {
      count_--;
      return true;
  }
  return false;
}

Wait()

void Wait

(

)

decrease the counter

Definition at line 44 of file kaldi-semaphore.cc.

References Semaphore::condition_variable_, Semaphore::count_, and Semaphore::mutex_.

Referenced by DiscriminativeExamplesRepository::AcceptExample(), NnetBatchDecoder::AcceptInput(), NnetBatchInference::Compute(), NnetBatchDecoder::Compute(), NnetBatchDecoder::Decode(), DiscriminativeExamplesRepository::ExamplesDone(), NnetExampleBackgroundReader::GetNextMinibatch(), NnetBatchInference::GetOutput(), ThreadSynchronizer::Lock(), DiscriminativeExamplesRepository::ProvideExample(), and NnetExampleBackgroundReader::ReadExamples().

                     {
  std::unique_lock<std::mutex> lock(mutex_);
  while(!count_)
    condition_variable_.wait(lock);
  count_--;
}

Member Data Documentation

condition_variable_

std::condition_variable condition_variable_

private

Definition at line 44 of file kaldi-semaphore.h.

Referenced by Semaphore::Signal(), and Semaphore::Wait().

count_

int32 count_

private

the semaphore counter, 0 means block on Wait()

Definition at line 41 of file kaldi-semaphore.h.

Referenced by Semaphore::Semaphore(), Semaphore::Signal(), Semaphore::TryWait(), and Semaphore::Wait().

mutex_

std::mutex mutex_

private

Definition at line 43 of file kaldi-semaphore.h.

Referenced by Semaphore::Signal(), Semaphore::TryWait(), and Semaphore::Wait().

---

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

• util/kaldi-semaphore.h
• util/kaldi-semaphore.cc