water

Class Lockable<T extends Lockable<T>>

java.lang.Object

water.Iced

water.Lockable<T>

All Implemented Interfaces:

java.lang.Cloneable, Freezable

Direct Known Subclasses:

Frame, Model, OldModel, ValueArray

public abstract class Lockable<T extends Lockable<T>>
extends Iced

Lockable Keys - locked during long running jobs, to prevent overwriting in-use keys. e.g. model-building: expected to read-lock input ValueArray and Frames, and write-lock the output Model. Parser should write-lock the output VA/Frame, to guard against double-parsing. Supports: lock-and-delete-old-and-update (for new Keys) lock-and-delete (for removing old Keys) unlock

Field Summary

Fields

Modifier and Type	Field and Description
Key	_key The Key being locked
Key[]	_lockers Write-locker job is in _jobs[0 ].
static DocGen.FieldDoc[]	DOC_FIELDS

Constructor Summary

Constructors

Constructor and Description
Lockable(Key key)

Method Summary

Methods

Modifier and Type	Method and Description
T	delete_and_lock(Key job_key)
protected abstract Futures	delete_impl(Futures fs)
void	delete()
static void	delete(Key k)
void	delete(Key job_key, float dummy)
static void	delete(Key k, Key job_key)
protected abstract java.lang.String	errStr()
protected boolean	is_unlocked()
protected boolean	is_wlocked()
void	read_lock(Key job_key)
static void	read_lock(Key k, Key job_key)
void	unlock_all()
void	unlock(Key job_key)
void	update(Key job_key)
Lockable	write_lock(Key job_key)

Methods inherited from class water.Iced

clone, frozenType, init, newInstance, read, toDocField, write, writeJSON, writeJSONFields

Methods inherited from class java.lang.Object

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

Field Detail

DOC_FIELDS

public static DocGen.FieldDoc[] DOC_FIELDS

_key

@Request.API(help="My Key")
public final Key _key

The Key being locked

_lockers

@Request.API(help="Jobs locking this key")
public transient Key[] _lockers

Write-locker job is in _jobs[0 ]. Can be null locker. Read -locker jobs are in _jobs[1+]. Unlocked has _jobs equal to null. Only 1 situation will be true at a time; atomically updated. Transient, because this data is only valid on the master node.

Constructor Detail

Lockable

public Lockable(Key key)

Method Detail

write_lock

public Lockable write_lock(Key job_key)

delete_and_lock

public T delete_and_lock(Key job_key)

delete

public static void delete(Key k)

delete

public static void delete(Key k,
          Key job_key)

delete

public void delete()

delete

public void delete(Key job_key,
          float dummy)

read_lock

public static void read_lock(Key k,
             Key job_key)

read_lock

public void read_lock(Key job_key)

update

public void update(Key job_key)

unlock

public void unlock(Key job_key)

is_wlocked

protected boolean is_wlocked()

is_unlocked

protected boolean is_unlocked()

unlock_all

public void unlock_all()

delete_impl

protected abstract Futures delete_impl(Futures fs)

errStr

protected abstract java.lang.String errStr()