Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413

Interface LockManagerService

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.RpcService

All Known Implementing Classes:

LockManagerServiceImpl

public interface LockManagerService
extends org.opendaylight.yangtools.yang.binding.RpcService

Interface for implementing the following YANG RPCs defined in module lock-manager

 rpc lock {
   input input {
     leaf lock-name {
       type string;
     }
   }
 }
 rpc try-lock {
   input input {
     leaf lock-name {
       type string;
     }
     leaf time {
       type uint32;
     }
     leaf time-unit {
       type time-units;
     }
   }
 }
 rpc unlock {
   input input {
     leaf lock-name {
       type string;
     }
   }
 }
 

Method Summary

Modifier and Type	Method	Description
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<LockOutput>>	lock(LockInput input)	Method that checks if its locked already.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<TryLockOutput>>	tryLock(TryLockInput input)	Method that checks if its locked already.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<UnlockOutput>>	unlock(UnlockInput input)	Method that removes the lock from the list of locks

Method Detail

lock

@CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<LockOutput>> lock(LockInput input)

Method that checks if its locked already. If not adds the lock to the list of locks. Else tries until it acquires the lock

tryLock

@CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<TryLockOutput>> tryLock(TryLockInput input)

Method that checks if its locked already. If not adds the lock to the list of locks. Else tries for the specified time

unlock

@CheckReturnValue
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<UnlockOutput>> unlock(UnlockInput input)

Method that removes the lock from the list of locks