Methods
Abstract
acquireLock
- acquireLock(channelName, channelType, lockName, retry, requestId?): number
-
Parameters
-
channelName: string
-
-
lockName: string
-
retry: boolean
-
Optional
requestId: number
Returns number
- 0: Success.
- < 0: Failure.
Abstract
getLocks
- getLocks(channelName, channelType, requestId?): number
-
Parameters
-
channelName: string
-
-
Optional
requestId: number
Returns number
- 0: Success.
- < 0: Failure.
Abstract
releaseLock
- releaseLock(channelName, channelType, lockName, requestId?): number
-
Parameters
-
channelName: string
-
-
lockName: string
-
Optional
requestId: number
Returns number
- 0: Success.
- < 0: Failure.
Abstract
removeLock
- removeLock(channelName, channelType, lockName, requestId?): number
-
Parameters
-
channelName: string
-
-
lockName: string
-
Optional
requestId: number
Returns number
- 0: Success.
- < 0: Failure.
Abstract
revokeLock
- revokeLock(channelName, channelType, lockName, owner, requestId?): number
-
Parameters
-
channelName: string
-
-
lockName: string
-
owner: string
-
Optional
requestId: number
Returns number
- 0: Success.
- < 0: Failure.
Abstract
setLock
- setLock(channelName, channelType, lockName, ttl, requestId?): number
-
Parameters
-
channelName: string
-
-
lockName: string
-
ttl: number
-
Optional
requestId: number
Returns number
- 0: Success.
- < 0: Failure.
The IRtmLock class.
This class provides the rtm lock methods that can be invoked by your app.