Liking cljdoc? Tell your friends :D

jdk.util.concurrent.atomic.AtomicMarkableReference

An AtomicMarkableReference maintains an object reference along with a mark bit, that can be updated atomically.

Implementation note: This implementation maintains markable references by creating internal objects representing "boxed" [reference, boolean] pairs.

An AtomicMarkableReference maintains an object reference
along with a mark bit, that can be updated atomically.

Implementation note: This implementation maintains markable
references by creating internal objects representing "boxed"
[reference, boolean] pairs.
raw docstring

->atomic-markable-referenceclj

(->atomic-markable-reference initial-ref initial-mark)

Constructor.

Creates a new AtomicMarkableReference with the given initial values.

initial-ref - the initial reference - V initial-mark - the initial mark - boolean

Constructor.

Creates a new AtomicMarkableReference with the given
 initial values.

initial-ref - the initial reference - `V`
initial-mark - the initial mark - `boolean`
raw docstring

attempt-markclj

(attempt-mark this expected-reference new-mark)

Atomically sets the value of the mark to the given update value if the current reference is == to the expected reference. Any given invocation of this operation may fail (return false) spuriously, but repeated invocation when the current value holds the expected value and no other thread is also attempting to set the value will eventually succeed.

expected-reference - the expected value of the reference - V new-mark - the new value for the mark - boolean

returns: true if successful - boolean

Atomically sets the value of the mark to the given update value
 if the current reference is == to the expected
 reference.  Any given invocation of this operation may fail
 (return false) spuriously, but repeated invocation
 when the current value holds the expected value and no other
 thread is also attempting to set the value will eventually
 succeed.

expected-reference - the expected value of the reference - `V`
new-mark - the new value for the mark - `boolean`

returns: true if successful - `boolean`
raw docstring

compare-and-setclj

(compare-and-set this expected-reference new-reference expected-mark new-mark)

Atomically sets the value of both the reference and mark to the given update values if the current reference is == to the expected reference and the current mark is equal to the expected mark.

expected-reference - the expected value of the reference - V new-reference - the new value for the reference - V expected-mark - the expected value of the mark - boolean new-mark - the new value for the mark - boolean

returns: true if successful - boolean

Atomically sets the value of both the reference and mark
 to the given update values if the
 current reference is == to the expected reference
 and the current mark is equal to the expected mark.

expected-reference - the expected value of the reference - `V`
new-reference - the new value for the reference - `V`
expected-mark - the expected value of the mark - `boolean`
new-mark - the new value for the mark - `boolean`

returns: true if successful - `boolean`
raw docstring

getclj

(get this mark-holder)

Returns the current values of both the reference and the mark. Typical usage is boolean[1] holder; ref = v.get(holder); .

mark-holder - an array of size of at least one. On return, markholder[0] will hold the value of the mark. - boolean[]

returns: the current value of the reference - V

Returns the current values of both the reference and the mark.
 Typical usage is boolean[1] holder; ref = v.get(holder); .

mark-holder - an array of size of at least one. On return, markholder[0] will hold the value of the mark. - `boolean[]`

returns: the current value of the reference - `V`
raw docstring

get-referenceclj

(get-reference this)

Returns the current value of the reference.

returns: the current value of the reference - V

Returns the current value of the reference.

returns: the current value of the reference - `V`
raw docstring

marked?clj

(marked? this)

Returns the current value of the mark.

returns: the current value of the mark - boolean

Returns the current value of the mark.

returns: the current value of the mark - `boolean`
raw docstring

setclj

(set this new-reference new-mark)

Unconditionally sets the value of both the reference and mark.

new-reference - the new value for the reference - V new-mark - the new value for the mark - boolean

Unconditionally sets the value of both the reference and mark.

new-reference - the new value for the reference - `V`
new-mark - the new value for the mark - `boolean`
raw docstring

weak-compare-and-setclj

(weak-compare-and-set this
                      expected-reference
                      new-reference
                      expected-mark
                      new-mark)

Atomically sets the value of both the reference and mark to the given update values if the current reference is == to the expected reference and the current mark is equal to the expected mark.

May fail spuriously and does not provide ordering guarantees, so is only rarely an appropriate alternative to compareAndSet.

expected-reference - the expected value of the reference - V new-reference - the new value for the reference - V expected-mark - the expected value of the mark - boolean new-mark - the new value for the mark - boolean

returns: true if successful - boolean

Atomically sets the value of both the reference and mark
 to the given update values if the
 current reference is == to the expected reference
 and the current mark is equal to the expected mark.

 May fail
 spuriously and does not provide ordering guarantees, so is
 only rarely an appropriate alternative to compareAndSet.

expected-reference - the expected value of the reference - `V`
new-reference - the new value for the reference - `V`
expected-mark - the expected value of the mark - `boolean`
new-mark - the new value for the mark - `boolean`

returns: true if successful - `boolean`
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close