Teuchos - Trilinos Tools Package Version of the Day
Public Types | Static Public Member Functions
Teuchos::SharedAccessPolicy Class Reference

Single policy class defining an approach for sharing an integral object across threads as well as a general heavy-weight locking policy. More...

#include <Teuchos_SharedAccessPolicy.hpp>

List of all members.

Public Types

typedef ThreadLock lock_type
 
typedef ScopedThreadLock scoped_lock_type
 
typedef int atomic_integral_type
 Supported type for shared integral objects.

Static Public Member Functions

static void atomic_set (atomic_integral_type *p, const atomic_integral_type v)
 Atomic setting a shared integral object.
static const atomic_integral_type atomic_fetch (const atomic_integral_type *p)
 Atomic fetch a shared integral object.
static void atomic_increment (atomic_integral_type *p)
 Atomic increment of a shared integral object.
static void atomic_decrement (atomic_integral_type *p)
 Atomic decrement of a shared integral object.

Detailed Description

Single policy class defining an approach for sharing an integral object across threads as well as a general heavy-weight locking policy.

This policy class provides an primative integral type (atomic_integral_type) and a set of atomic primitives for incrementing/decrementing and/or setting/fetching the object.

This policy class also provides typdefs for generic heavier-weight thread locking objects that can be used for more general locking.

This class is designed, in purpose, to provide sufficient functionality to make the Teuchos MM classes thread-safe. However, the will have other uses in Teuchos and other C++ code also.

There will likely be a typedef called DefaultSharedAccessPolicy in the Teuchos namespace that will select the default global policy (i.e. the one used by the Teuchos MM classes by default). Also, there well as concrete implementations NonthreadedSharedAccessPolicy, TbbSharedAccessPolicy, PtheadsSharedAccessPolicy, and others (when support is enabled).

Definition at line 120 of file Teuchos_SharedAccessPolicy.hpp.


Member Typedef Documentation

Definition at line 123 of file Teuchos_SharedAccessPolicy.hpp.

Definition at line 125 of file Teuchos_SharedAccessPolicy.hpp.

Supported type for shared integral objects.

Definition at line 127 of file Teuchos_SharedAccessPolicy.hpp.


Member Function Documentation

static void Teuchos::SharedAccessPolicy::atomic_set ( atomic_integral_type p,
const atomic_integral_type  v 
) [inline, static]

Atomic setting a shared integral object.

static const atomic_integral_type Teuchos::SharedAccessPolicy::atomic_fetch ( const atomic_integral_type p) [inline, static]

Atomic fetch a shared integral object.

static void Teuchos::SharedAccessPolicy::atomic_increment ( atomic_integral_type p) [inline, static]

Atomic increment of a shared integral object.

static void Teuchos::SharedAccessPolicy::atomic_decrement ( atomic_integral_type p) [inline, static]

Atomic decrement of a shared integral object.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines