RWAtomicCounter

Threads Module Reference Guide
Rogue Wave web site: Home Page | Main Documentation Page

RWAtomicCounter

Module: Threads Package: Smart Pointer


Does not inherit

Local Index
Header File
Description
Example
Public Constructors
Public Member Functions
Public Operators
See Also

Local Index

Members

addReference()
operator

references()
removeReference()

RWAtomicCounter()

Header File

#include <rw/pointer/RWAtomicCounter.h>

Description

RWAtomicCounter is a class for maintaining a reference count. It can be safely used in a multithreaded environment. If multithread safety is not an issue, use an RWUnsafeCounter. On systems that support atomic integer operations, this class is more efficient than the equivalent RWTCounter<RWMutexLock>.

Example

#include <rw/pointer/RWTCountedPointer.h>
#include <rw/pointer/RWAtomicCounter.h>
#include <rw/sync/RWMutexLock.h>
#include <iostream.h>

class Foo : public RWAtomicCounter
{
  public:
    void bar(void)
    {
      cout << "I'm a foo example" << endl;
    }
};

typedef RWTCountedPointer<Foo> FooPointer;

int main(void)
{
    try
    {
      FooPointer p1(new Foo);
      p1->bar();
    }
    catch(RWxmsg& msg)
    {
      cout << msg.why() << endl;
    }
    return 0;
}

Public Constructors

RWAtomicCounter(RWStaticCtor);

Constructs a static instance (does not initialize the reference count). Throws no exceptions.

RWAtomicCounter(unsigned initCount = 0);

Constructs a default instance (initializes the reference count). Throws no exceptions.

RWAtomicCounter(const RWAtomicCounter& second);

Default-initializes the internal count to zero.

Public Member Functions

unsigned
addReference();

Increments and returns the reference count.

unsigned
references() const;

Queries the current reference count. Throws no exceptions.

unsigned
removeReference();

Decrements and returns the reference count.

Public Operators

RWAtomicCounter&
operator=(const RWAtomicCounter&);

Copy assignment operator. Does nothing. Returns *this.