// Copyright (C) 2012-2015 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
#ifndef INTERPROCESS_SYNC_NULL_H
#define INTERPROCESS_SYNC_NULL_H
#include <log/interprocess/interprocess_sync.h>
namespace isc {
namespace log {
namespace interprocess {
/// \brief 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.
class InterprocessSyncNull : public InterprocessSync {
public:
/// \brief Constructor
///
/// Creates a null interprocess synchronization object
///
/// \param 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.
InterprocessSyncNull(const std::string& task_name) :<--- Class 'InterprocessSyncNull' has a constructor with 1 argument that is not explicit. [+]Class 'InterprocessSyncNull' has a constructor with 1 argument that is not explicit. Such, so called "Converting constructors", should in general be explicit for type safety reasons as that prevents unintended implicit conversions.
InterprocessSync(task_name)
{}
/// \brief Destructor
virtual ~InterprocessSyncNull();<--- Destructor in derived class
protected:
/// \brief Acquire the lock (never blocks)
///
/// \return Always returns true
bool lock();<--- Function in derived class
/// \brief Try to acquire a lock (doesn't block)
///
/// \return Always returns true
bool tryLock();<--- Function in derived class
/// \brief Release the lock
///
/// \return Always returns true
bool unlock();<--- Function in derived class
};
} // namespace interprocess
} // namespace log
} // namespace isc
#endif // INTERPROCESS_SYNC_NULL_H