Commit 3e84f9cf authored by Steven Murray's avatar Steven Murray
Browse files

Improved comments in code surrounding the m_driveReadyDelayInSeconds attribute of CleanerSession

parent c5360cff
......@@ -31,5 +31,7 @@ message ForkCleaner {
required string vid = 5;
// Description of the cleaner job
// Warning, setting this value to 0 has the special meaning of NOT testing to
// see if the drive contains a tape.
required uint32 drivereadydelayinseconds = 6;
}
......@@ -143,6 +143,8 @@ std::auto_ptr<castor::tape::tapeserver::drive::DriveInterface>
//------------------------------------------------------------------------------
void castor::tape::tapeserver::daemon::CleanerSession::waitUntilDriveIsReady(
drive::DriveInterface &drive) {
// Warning, setting m_driveReadyDelayInSeconds to 0 has the special meaning of
// NOT testing to see if the drive contains a tape.
if(0 != m_driveReadyDelayInSeconds) {
std::list<log::Param> params;
params.push_back(log::Param("TPVID", m_vid));
......
......@@ -56,7 +56,9 @@ namespace daemon {
* @param vid The volume identifier of the mounted tape if known,
* else the empty string.
* @param driveReadyDelayInSeconds The maximum number of seconds to wait for
* the drive to be raedy with a tape inside of it.
* the drive to be ready with a tape inside of it. Warning, setting this
* value to 0 has the special meaning of NOT testing to see if the drive
* contains a tape.
*/
CleanerSession(
server::ProcessCap &capUtils,
......@@ -111,7 +113,8 @@ namespace daemon {
/**
* The maximum number of seconds to wait for the drive to be raedy with a
* tape inside of it.
* tape inside of it. Warning, setting this value to 0 has the special
* meaning of NOT testing to see if the drive contains a tape.
*/
const uint32_t m_driveReadyDelayInSeconds;
......
......@@ -82,7 +82,9 @@ public:
* identifier is known. If the volume identifier is not known then this
* parameter should be set to an empty string.
* @param driveReadyDelayInSeconds The maximum number of seconds to wait for
* the drive to be raedy with a tape inside of it.
* the drive to be ready with a tape inside of it. Warning, setting this
* value to 0 has the special meaning of NOT testing to see if the drive
* contains a tape.
* @return The process identifier of the newly forked session.
*/
virtual pid_t forkCleaner(const DriveConfig &driveConfig,
......
......@@ -88,7 +88,9 @@ public:
* identifier is known. If the volume identifier is not known then this
* parameter should be set to an empty string.
* @param driveReadyDelayInSeconds The maximum number of seconds to wait for
* the drive to be raedy with a tape inside of it.
* the drive to be ready with a tape inside of it. Warning, setting this
* value to 0 has the special meaning of NOT testing to see if the drive
* contains a tape.
* @return The process identifier of the newly forked session.
*/
pid_t forkCleaner(const DriveConfig &driveConfig,
......
......@@ -103,7 +103,9 @@ public:
* identifier is known. If the volume identifier is not known then this
* parameter should be set to an empty string.
* @param driveReadyDelayInSeconds The maximum number of seconds to wait for
* the drive to be ready with a tape inside of it.
* the drive to be ready with a tape inside of it. Warning, setting this
* value to 0 has the special meaning of NOT testing to see if the drive
* contains a tape.
* @return The process identifier of the newly forked session.
*/
pid_t forkCleaner(const DriveConfig &driveConfig,
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment