Future< T > Class Template Reference

#include <concurrency.h>

Inheritance diagram for Future< T >:

Collaboration diagram for Future< T >:

Public Member Functions
	Future ()
virtual	~Future ()
void	Set (const T &object)
T &	Get ()
const T &	Get () const

Protected Member Functions
void	Wait () const

Private Attributes
T	object_
pthread_mutex_t	mutex_
pthread_cond_t	object_set_
bool	object_was_set_

Additional Inherited Members
Private Member Functions inherited from SingleCopy
	SingleCopy ()

Detailed Description

template<typename T>
class Future< T >

This is a simple implementation of a Future wrapper template. It is used as a proxy for results that are computed asynchronously and might not be available on the first access. Since this is a very simple implementation one needs to use the Future's Get() and Set() methods to obtain the containing data resp. to write it. Note: More than a single call to Set() is prohibited! If Get() is called before Set() the calling thread will block until the value has been set by a different thread.

Parameters

T	the value type wrapped by this Future template

Definition at line 67 of file concurrency.h.

Constructor & Destructor Documentation

template<typename T >

Future< T >::Future

(

)

This file is part of the CernVM File System.

Definition at line 21 of file concurrency_impl.h.

Here is the call graph for this function:

template<typename T >

Future< T >::~Future ( )

virtual

Definition at line 29 of file concurrency_impl.h.

Member Function Documentation

template<typename T >

T & Future< T >::Get

(

)

Retrieves the wrapped value object. If the value is not yet available it will automatically block until a different thread calls Set().

Returns

the containing value object

Definition at line 56 of file concurrency_impl.h.

Referenced by swissknife::CommandTag::CloseAndPublishHistory(), swissknife::CommandMigrate::DoMigrationAndCommit(), upload::SessionContextBase::Finalize(), swissknife::CommandMigrate::MigrationWorker_20x::FixNestedCatalogTransitionPoints(), swissknife::CommandMigrate::MigrationWorker_20x::GenerateCatalogStatistics(), swissknife::CommandMigrate::MigrationWorker_217::GenerateNewStatisticsCounters(), swissknife::CommandMigrate::MigrationWorker_20x::MigrateNestedCatalogMountPoints(), swissknife::CommandMigrate::StatsMigrationWorker::RepairStatisticsCounters(), SigningTool::Run(), catalog::WritableCatalogManager::SnapshotCatalogs(), swissknife::CommandMigrate::AbstractMigrationWorker< DerivedT >::UpdateNestedCatalogReferences(), swissknife::CommandMigrate::UpdateUndoTags(), and swissknife::CommandTag::UploadCatalogAndUpdateManifest().

Here is the caller graph for this function:

template<typename T >

const T & Future< T >::Get

(

)

const

Definition at line 63 of file concurrency_impl.h.

template<typename T>

void Future< T >::Set

(

const T &

object

)

Save an asynchronously computed value into the Future. This potentially unblocks threads that already wait for the value.

Parameters

object

the value object to be set

Definition at line 36 of file concurrency_impl.h.

Referenced by SigningTool::CertificateUploadCallback(), swissknife::CommandMigrate::MigrationWorker_20x::FindRootEntryInformation(), swissknife::CommandMigrate::MigrationWorker_20x::GenerateCatalogStatistics(), swissknife::CommandMigrate::MigrationWorker_217::GenerateNewStatisticsCounters(), SigningTool::MetainfoUploadCallback(), swissknife::CommandMigrate::MigrationCallback(), swissknife::CommandMigrate::StatsMigrationWorker::RepairStatisticsCounters(), swissknife::CommandMigrate::UploadCallback(), swissknife::CommandTag::UploadClosure(), swissknife::CommandMigrate::UploadHistoryClosure(), and upload::SessionContext::UploadLoop().

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T >

void Future< T >::Wait ( ) const

protected

Definition at line 46 of file concurrency_impl.h.

Here is the call graph for this function:

Member Data Documentation

template<typename T>

pthread_mutex_t Future< T >::mutex_

mutableprivate

Definition at line 92 of file concurrency.h.

Referenced by Future< T >::Future().

template<typename T>

T Future< T >::object_

private

Definition at line 91 of file concurrency.h.

template<typename T>

pthread_cond_t Future< T >::object_set_

mutableprivate

Definition at line 93 of file concurrency.h.

Referenced by Future< T >::Future().

template<typename T>

bool Future< T >::object_was_set_

private

Definition at line 94 of file concurrency.h.

---

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

• /home/sftnight/jenkins/workspace/CvmfsDoxygen/label/docker-x86_64/cvmfs/cvmfs/util/concurrency.h
• /home/sftnight/jenkins/workspace/CvmfsDoxygen/label/docker-x86_64/cvmfs/cvmfs/util/concurrency_impl.h