---
name: "ACE_TPQ_Iterator"
section: "3"
platform: "linux"
package: "libace-doc"
version: "5.0.7-4"
release: "Debian 2.2 (Potato)"
platforms: ["linux"]
url: "https://new.carta.tech/ACE_TPQ_Iterator"
---

# ACE\_TPQ\_Iterator(3)

Iterates through ACE\_Token\_Proxy\_Queues.

## NAME

ACE\_TPQ\_Iterator -  Iterates through ACE\_Token\_Proxy\_Queues.

## SYNOPSIS

```
#include <ace/Local_Tokens.h>
class ACE_TPQ_Iterator
{
  public:
    ACE_TPQ_Iterator (ACE_Token_Proxy_Queue &q);
    ~ACE_TPQ_Iterator (void);
    int next (ACE_TPQ_Entry *&next_item);
    int done (void) const;
    void advance (void);
    void dump (void) const;
  private:
    ACE_TPQ_Entry *current_;
};
```

## DESCRIPTION

This file contains definitions for the following classes:

public:\
   7\. ACE\_Token\_Proxy\
   8\. ACE\_Null\_Token : public ACE\_Token\_Proxy\
   9\. ACE\_Local\_Mutex : public ACE\_Token\_Proxy\
   \*. ACE\_Local\_RLock : public ACE\_Local\_Mutex\
   &. ACE\_Local\_WLock : public ACE\_Local\_Mutex private:\
   1\. ACE\_TOKEN\_CONST\
   3\. ACE\_TPQ\_Entry\
   b. ACE\_TSS\_TPQ\_Entry\
   c. ACE\_TPQ\_Iterator\
   4\. ACE\_Token\_Proxy\_Queue\
   5\. ACE\_Tokens\
   6\. ACE\_Mutex\_Token : public ACE\_Tokens\
   12\. ACE\_RW\_Token : public ACE\_Tokens\
   a. ACE\_Token\_Name

 Note that the locking classes defined in this file are \*not\*\
  intended to be used as general-purpose synchronization\
  mechanisms, such as mutexes or semaphores.  Instead, you should\
  use the ACE\_Recursive\_Thread\_Mutex, ACE\_Thread\_Mutex,\
  ACE\_Thread\_Semaphore, etc., that are defined in\
  $ACE\_ROOT/ace/Synch.h and $ACE\_ROOT/ace/Synch\_T.h or the\
  ACE\_Token that's defined in $ACE\_ROOT/ace/Token.h.

## PUBLIC MEMBERS

```
ACE_TPQ_Iterator (ACE_Token_Proxy_Queue &q);
```

Construction.

```
~ACE_TPQ_Iterator (void);
```

Destructor.

```
int next (ACE_TPQ_Entry *&next_item);
```

Pass back the next\_item.

```
int done (void) const;
```

Returns 1 when all items have been seen, else 0.

```
void advance (void);
```

Move forward by one element in the queue.

```
void dump (void) const;
```

Dump the state of an object.

## PRIVATE MEMBERS

```
ACE_TPQ_Entry *current_;
```

## AUTHOR

Karl-Heinz Dorn kdorn@erlh.siemens.de, Douglas C. Schmidt schmidt@cs.wustl.edu, and Tim Harrison harrison@cs.wustl.edu

## LIBRARY

ace