Bell Class Reference

Synchronization object allowing to sleep for given timespan. More...

#include <sync/bell.h>

Inheritance diagram for Bell:

Collaboration diagram for Bell:

Public Member Functions
	Bell ()
	Constructor.
void	ring ()
	Ring the bell.
unsigned int	residual ()
	Returns the residual waiting time.
void	set (unsigned int ms)
	Set the bell's waiting time.
void	sleep ()
	Sleep until the bell rings.
Public Member Functions inherited from Waitingroom
	Waitingroom ()
	Constructor.
virtual	~Waitingroom ()
	Destructor.
virtual void	remove (Thread *customer)
	Remove a given thread prematurely from the Waitingroom.
Public Member Functions inherited from Queue< T, ContainerType >
	Queue ()
	Default constructor; initialized the queue as empty.
void	enqueue (T *item)
	Enqueues the provided item at the end of the queue.
T *	dequeue ()
	Removes the first element in the queue and returns it.
Iterator	begin ()
Iterator	end ()
T *	remove (T *item, bool(*cmp)(T *, T *)=[](T *a, T *b) {return a==b;})
	Removes and returns a single element from the queue.
void	insertFirst (T *item)
	Adds item to the beginning of the queue.
void	insertAfter (T *old_item, T *new_item)
	Inserts the element new_item directly after old_item.
T *	first ()
	Returns the first element in the queue without removing it.
T *	next (T *o)
	Returns the next element in the queue for a given element.

Static Public Member Functions
static void	sleep (unsigned int ms)
	Creates a temporary bell object and sleeps for the given timespan.

Private Member Functions
	Bell (const Bell &)=delete
Bell &	operator= (const Bell &)=delete

Private Attributes
unsigned int	counter
	Internal counter for managing bell objects in the Bellringer.

Friends
class	Bellringer

Additional Inherited Members
Protected Member Functions inherited from Queue< T, ContainerType >::Node
	Node ()

Detailed Description

Synchronization object allowing to sleep for given timespan.

A bell is a synchronization object enabling one thread to sleep for a particular timespan.

Constructor & Destructor Documentation

Bell() [1/2]

Bell::Bell ( const Bell &  )

privatedelete

Bell() [2/2]

Bell::Bell ( )

inline

Constructor.

Constructs a new bell; the newly created bell is, at first, disabled.

Member Function Documentation

operator=()

Bell & Bell::operator= ( const Bell &  )

privatedelete

ring()

void Bell::ring

(

)

Ring the bell.

Method called by the Bellringer once the waiting time passed. Wakes up the sleeping thread(s).

residual()

unsigned int Bell::residual

(

)

Returns the residual waiting time.

Will use Bellringer::residual().

Returns

Time in milliseconds until the bell rings

Optional:

Implement Method

set()

void Bell::set

(

unsigned int

ms

)

Set the bell's waiting time.

This method can be used to set the desired waiting time.

Parameters

ms	Time in milliseconds; will be passed to Bellringer::job()

Optional:

Implement Method

sleep() [1/2]

void Bell::sleep

(

)

Sleep until the bell rings.

The bell needs to be configured via Bell::set() prior to calling this method and should not have rung already. (see Bell::residual()).

Optional:

Implement Method

sleep() [2/2]

void Bell::sleep ( unsigned int  ms )

static

Creates a temporary bell object and sleeps for the given timespan.

Parameters

ms	time in milliseconds

Friends And Related Symbol Documentation

Bellringer

friend class Bellringer

friend

Member Data Documentation

counter

unsigned int Bell::counter

private

Internal counter for managing bell objects in the Bellringer.

---

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

• sync/bell.h
• sync/bell.cc