head 1.4; access; symbols; locks; strict; comment @# @; 1.4 date 2002.09.07.01.50.36; author curt; state Exp; branches; next 1.3; 1.3 date 2002.08.31.19.01.50; author curt; state Exp; branches; next 1.2; 1.2 date 2002.08.31.18.53.59; author curt; state Exp; branches; next 1.1; 1.1 date 2002.02.15.17.21.54; author curt; state Exp; branches; next ; desc @@ 1.4 log @Updated doxygen docs. @ text @
Main Page Class Hierarchy Compound List File List Compound Members File Members

# SGLockedQueue< T, SGLOCK > Class Template Reference

A simple thread safe queue. More...

`#include <SGQueue.hxx>`

Inheritance diagram for SGLockedQueue< T, SGLOCK >:

List of all members.

## Public Methods
| SGLockedQueue ()
| Create a new SGLockedQueue object.
| ~SGLockedQueue ()
| Destroy this object.
virtual bool | empty ()
| Returns whether this queue is empty (contains no elements).
virtual void | push (const T &item)
| Add an item to the end of the queue.
virtual T | pop ()
| Get an item from the head of the queue.

## Detailed Description

### template<class T, class SGLOCK = SGMutex>
class SGLockedQueue< T, SGLOCK >

A simple thread safe queue.

All access functions are guarded with a mutex.

Definition at line 68 of file SGQueue.hxx.

## Member Function Documentation

template<class T, class SGLOCK = SGMutex>
virtual bool SGLockedQueue< T, SGLOCK >::empty | ( |  | ) | `[inline, virtual]`

| Returns whether this queue is empty (contains no elements). Returns: bool True if queue is empty, otherwisr false. Implements SGQueue< T >. Definition at line 87 of file SGQueue.hxx.

template<class T, class SGLOCK = SGMutex>
virtual T SGLockedQueue< T, SGLOCK >::pop | ( |  | ) | `[inline, virtual]`

| Get an item from the head of the queue. Returns: T next available object. Implements SGQueue< T >. Definition at line 107 of file SGQueue.hxx.

template<class T, class SGLOCK = SGMutex>
virtual void SGLockedQueue< T, SGLOCK >::push | ( | const T & | item | ) | `[inline, virtual]`

  | Add an item to the end of the queue. Parameters:
  T | object to add.
Implements SGQueue< T >. Definition at line 97 of file SGQueue.hxx.

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

- SGQueue.hxx

@ 1.3 log @Oops, try again. @ text @d172 1 a172 1