alshabib | ab98466 | 2014-12-04 18:56:18 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.store.service; |
Madan Jampani | f73fb04 | 2014-11-11 10:49:05 -0800 | [diff] [blame] | 17 | |
Madan Jampani | 32fe780 | 2014-11-11 11:16:47 -0800 | [diff] [blame] | 18 | /** |
| 19 | * Service interface for mutual exclusion primitives. |
| 20 | */ |
Madan Jampani | f73fb04 | 2014-11-11 10:49:05 -0800 | [diff] [blame] | 21 | public interface LockService { |
| 22 | |
| 23 | /** |
Madan Jampani | 32fe780 | 2014-11-11 11:16:47 -0800 | [diff] [blame] | 24 | * Creates a new lock instance. |
Madan Jampani | f73fb04 | 2014-11-11 10:49:05 -0800 | [diff] [blame] | 25 | * A successful return from this method does not mean the resource guarded by the path is locked. |
Madan Jampani | 32fe780 | 2014-11-11 11:16:47 -0800 | [diff] [blame] | 26 | * The caller is expected to call Lock.lock() to acquire the lock. |
Madan Jampani | f73fb04 | 2014-11-11 10:49:05 -0800 | [diff] [blame] | 27 | * @param path unique lock name. |
Madan Jampani | 32fe780 | 2014-11-11 11:16:47 -0800 | [diff] [blame] | 28 | * @return a Lock instance that can be used to acquire the lock. |
Madan Jampani | f73fb04 | 2014-11-11 10:49:05 -0800 | [diff] [blame] | 29 | */ |
| 30 | Lock create(String path); |
| 31 | |
| 32 | /** |
| 33 | * Adds a listener to be notified of lock events. |
| 34 | * @param listener listener to be added. |
| 35 | */ |
| 36 | void addListener(LockEventListener listener); |
| 37 | |
| 38 | /** |
| 39 | * Removes a listener that was previously added. |
| 40 | * @param listener listener to be removed. |
| 41 | */ |
| 42 | void removeListener(LockEventListener listener); |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 43 | } |