mirror of
https://github.com/OpenHFT/Chronicle-Map.git
synced 2021-09-13 01:26:12 +00:00
Improved locking documentation
This commit is contained in:
@@ -10,7 +10,14 @@ package net.openhft.chronicle.hash;
|
||||
public interface ExternalHashQueryContext<K> extends HashQueryContext<K>, AutoCloseable {
|
||||
|
||||
/**
|
||||
* Could throw only unchecked exception.
|
||||
* Closes the query context, automatically releases all locks and disposes all resources,
|
||||
* acquired during the query operation. I. e. you shouldn't release locks manually in the end
|
||||
* of try-with-resources statement: <pre>{@code
|
||||
* try (ExternalHashQueryContext<K> q = hash.queryContext(key))
|
||||
* q.writeLock().lock();
|
||||
* // ...make a query under exclusive lock
|
||||
* // NOT NEEDED - q.readLock().unlock();
|
||||
* }}</pre>
|
||||
*/
|
||||
@Override
|
||||
void close();
|
||||
|
||||
Reference in New Issue
Block a user