org.onosproject.store.service

Interface LockService

public interface LockService

Service interface for mutual exclusion primitives.

Method Summary

Modifier and Type	Method and Description
void	addListener(LockEventListener listener) Adds a listener to be notified of lock events.
Lock	create(String path) Creates a new lock instance.
void	removeListener(LockEventListener listener) Removes a listener that was previously added.

Method Detail

create

Lock create(String path)

Creates a new lock instance. A successful return from this method does not mean the resource guarded by the path is locked. The caller is expected to call Lock.lock() to acquire the lock.

Parameters:

path - unique lock name.

Returns:

a Lock instance that can be used to acquire the lock.

addListener

void addListener(LockEventListener listener)

Adds a listener to be notified of lock events.

Parameters:

listener - listener to be added.

removeListener

void removeListener(LockEventListener listener)

Removes a listener that was previously added.

Parameters:

listener - listener to be removed.