Package io.agora.rtm

Class RtmLock

java.lang.Object

io.agora.rtm.RtmLock

public abstract class RtmLock
extends Object

The RtmLock class. This class provides the rtm lock methods that can be invoked by your app.

Constructor Summary

Constructors

Constructor	Description
RtmLock()

Method Summary

Modifier and Type	Method	Description
abstract void	acquireLock(String channelName, RtmConstants.RtmChannelType channelType, String lockName, boolean retry, ResultCallback<Void> resultCallback)	acquires a lock
abstract void	getLocks(String channelName, RtmConstants.RtmChannelType channelType, ResultCallback<ArrayList<LockDetail>> resultCallback)	gets locks in the channel.
abstract void	releaseLock(String channelName, RtmConstants.RtmChannelType channelType, String lockName, ResultCallback<Void> resultCallback)	releases a lock
abstract void	removeLock(String channelName, RtmConstants.RtmChannelType channelType, String lockName, ResultCallback<Void> resultCallback)	removes a lock.
abstract void	revokeLock(String channelName, RtmConstants.RtmChannelType channelType, String lockName, String owner, ResultCallback<Void> resultCallback)	disables a lock
abstract void	setLock(String channelName, RtmConstants.RtmChannelType channelType, String lockName, long ttl, ResultCallback<Void> resultCallback)	sets a lock.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RtmLock

public RtmLock()

Method Details

setLock

public abstract void setLock(String channelName,
 RtmConstants.RtmChannelType channelType,
 String lockName,
 long ttl,
 ResultCallback<Void> resultCallback)

sets a lock.

Parameters:

channelName - The name of the channel.

channelType - The type of the channel.

lockName - The name of the lock.

ttl - The lock ttl.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

getLocks

public abstract void getLocks(String channelName,
 RtmConstants.RtmChannelType channelType,
 ResultCallback<ArrayList<LockDetail>> resultCallback)

gets locks in the channel.

Parameters:

channelName - The name of the channel.

channelType - The type of the channel.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

removeLock

public abstract void removeLock(String channelName,
 RtmConstants.RtmChannelType channelType,
 String lockName,
 ResultCallback<Void> resultCallback)

removes a lock.

Parameters:

channelName - The name of the channel.

channelType - The type of the channel.

lockName - The name of the lock.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

acquireLock

public abstract void acquireLock(String channelName,
 RtmConstants.RtmChannelType channelType,
 String lockName,
 boolean retry,
 ResultCallback<Void> resultCallback)

acquires a lock

Parameters:

channelName - The name of the channel.

channelType - The type of the channel.

lockName - The name of the lock.

retry - Whether to automatically retry when acquires lock failed

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

releaseLock

public abstract void releaseLock(String channelName,
 RtmConstants.RtmChannelType channelType,
 String lockName,
 ResultCallback<Void> resultCallback)

releases a lock

Parameters:

channelName - The name of the channel.

channelType - The type of the channel.

lockName - The name of the lock.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

revokeLock

public abstract void revokeLock(String channelName,
 RtmConstants.RtmChannelType channelType,
 String lockName,
 String owner,
 ResultCallback<Void> resultCallback)

disables a lock

Parameters:

channelName - The name of the channel.

channelType - The type of the channel.

lockName - The name of the lock.

owner - The lock owner.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.