isc::log::interprocess::InterprocessSyncNull Class Reference

Null Interprocess Sync Class. More...

#include <interprocess_sync_null.h>

Inheritance diagram for isc::log::interprocess::InterprocessSyncNull:

Public Member Functions
	InterprocessSyncNull (const std::string &task_name)
	Constructor.
virtual	~InterprocessSyncNull ()
	Destructor.
Public Member Functions inherited from isc::log::interprocess::InterprocessSync
	InterprocessSync (const std::string &task_name)
	Constructor.
virtual	~InterprocessSync ()
	Destructor.

Protected Member Functions
bool	lock ()
	Acquire the lock (never blocks)
bool	tryLock ()
	Try to acquire a lock (doesn't block)
bool	unlock ()
	Release the lock.
Protected Member Functions inherited from isc::log::interprocess::InterprocessSync

Additional Inherited Members
Protected Attributes inherited from isc::log::interprocess::InterprocessSync
bool	is_locked_
	Is the lock taken?
const std::string	task_name_
	The task name.

Detailed Description

Null Interprocess Sync Class.

This class specifies a concrete implementation for a null (no effect) interprocess synchronization mechanism. Please see the InterprocessSync class documentation for usage.

Definition at line 21 of file interprocess_sync_null.h.

Constructor & Destructor Documentation

InterprocessSyncNull()

isc::log::interprocess::InterprocessSyncNull::InterprocessSyncNull ( const std::string & task_name )

inline

Constructor.

Creates a null interprocess synchronization object

Parameters

task_name

Name of the synchronization task. This has to be identical among the various processes that need to be synchronized for the same task.

Definition at line 30 of file interprocess_sync_null.h.

~InterprocessSyncNull()

isc::log::interprocess::InterprocessSyncNull::~InterprocessSyncNull ( )

virtual

Destructor.

Definition at line 15 of file interprocess_sync_null.cc.

Member Function Documentation

lock()

bool isc::log::interprocess::InterprocessSyncNull::lock ( )

protectedvirtual

Acquire the lock (never blocks)

Returns

Always returns true

Implements isc::log::interprocess::InterprocessSync.

Definition at line 19 of file interprocess_sync_null.cc.

References isc::log::interprocess::InterprocessSync::is_locked_.

tryLock()

bool isc::log::interprocess::InterprocessSyncNull::tryLock ( )

protectedvirtual

Try to acquire a lock (doesn't block)

Returns

Always returns true

Implements isc::log::interprocess::InterprocessSync.

Definition at line 25 of file interprocess_sync_null.cc.

References isc::log::interprocess::InterprocessSync::is_locked_.

unlock()

bool isc::log::interprocess::InterprocessSyncNull::unlock ( )

protectedvirtual

Release the lock.

Returns

Always returns true

Implements isc::log::interprocess::InterprocessSync.

Definition at line 31 of file interprocess_sync_null.cc.

References isc::log::interprocess::InterprocessSync::is_locked_.

---

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

• interprocess_sync_null.h
• interprocess_sync_null.cc