Browse Source

[1704] Add note about exception thrown

Mukund Sivaraman 13 years ago
parent
commit
e04531f570
1 changed files with 3 additions and 0 deletions
  1. 3 0
      src/lib/util/interprocess_sync_file.h

+ 3 - 0
src/lib/util/interprocess_sync_file.h

@@ -38,6 +38,9 @@ public:
 /// interprocess synchronization mechanism. Please see the
 /// InterprocessSync class documentation for usage.
 ///
+/// An InterprocessSyncFileError exception may be thrown if there is an
+/// issue opening the lock file.
+///
 /// Lock files are created typically in the local state directory
 /// (var). They are typically named like "<task_name>_lockfile".
 /// This implementation opens lock files lazily (only when