omega-red.lock — org.clojars.lukaszkorecki/omega-red 2.5.0

create clj

(create {:keys [lock-key lock-id expiry-ms acquire-timeout-ms
                acquire-resolution-ms]
         :or {expiry-ms default-expiry-ms
              acquire-timeout-ms default-acquire-timeout-ms
              acquire-resolution-ms default-acquire-resolution-ms}})

get-lock-holder-id* clj

(get-lock-holder-id* conn {:keys [lock-key]})

lock-expiry-in-ms* clj

(lock-expiry-in-ms* conn {:keys [lock-key]})

lock-script clj

RedLock clj protocol

acquire clj

(acquire this)

(acquire this opts)

Acquire the lock. Returns true if acquired, false otherwise.

acquire-with-timeout clj

(acquire-with-timeout this)

(acquire-with-timeout this opts)

Like acquire but will wait for the lock to be available up to acquire-timeout-ms milliseconds. If the lock is not acquired within that time, returns false.

get-id clj

(get-id this)

Get ID of the lock holder. Returns the ID of the lock holder.

get-lock-holder-id clj

(get-lock-holder-id this)

Get ID of the lock holder. Returns the ID of the lock holder.

is-lock-holder? clj

(is-lock-holder? this)

Check if this instance is the lock holder. Returns true if it is, false otherwise.

lock-expiry-in-ms clj

(lock-expiry-in-ms this)

Returns number of milliseconds until the lock expires. Nil if lock doesn't exist

release clj

(release this)

Release the lock. Returns true if released, false otherwise.

renew clj

(renew this)

Renew the lock. Returns true if renewed, false otherwise.

release* clj

(release* conn {:keys [lock-key lock-id expiry-ms]})

release-script clj

renew* clj

(renew* conn {:keys [lock-key lock-id expiry-ms]})

renew-script clj

try-acquire* clj

(try-acquire* conn {:keys [lock-key lock-id expiry-ms]})

Try acquiring a lock, doesn't use timeouts - so it either acquires the lock or fails immediately. Returns true if acquired, false otherwise.

try-acquire-with-timeout* clj

(try-acquire-with-timeout* conn
                           {:keys [lock-key lock-id expiry-ms acquire-timeout-ms
                                   acquire-resolution-ms]})

Try acquiring a lock, with a timeout options

with-lock clj macro

(with-lock lock & body)