ml.shifu.guagua.io

Class HaltBytable

java.lang.Object

ml.shifu.guagua.io.HaltBytable

All Implemented Interfaces:

Bytable

public abstract class HaltBytable
extends Object
implements Bytable

Abstract Bytable implementation to read and store halt status.

Halt status is used for master or worker result to determine whether the application should be terminated.

By default master is the only one who has the right to stop the application if halt status in master result, no matter halt status in each worker is true.

One switch in GuaguaConstants#GUAGUA_WORKER_HALT_ENABLE, if enabled, application will be terminated if all workers are halted no matter what is the master halt status.

Constructor Summary

Constructors

Constructor and Description
HaltBytable()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	doReadFields(DataInput in) Read fields from in stream.
abstract void	doWrite(DataOutput out) Write fields to out stream.
boolean	isHalt() Return halt status.
void	readFields(DataInput in) De-serialize the fields of this object from in.
void	setHalt(boolean isHalt) Set status to halt if isHalt is true.
void	write(DataOutput out) Serialize the fields of this object to out.

Methods inherited from class java.lang.Object

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

Constructor Detail

HaltBytable

public HaltBytable()

Method Detail

setHalt

public void setHalt(boolean isHalt)

Set status to halt if isHalt is true.

isHalt

public boolean isHalt()

Return halt status.

write

public void write(DataOutput out)
           throws IOException

Description copied from interface: Bytable

Serialize the fields of this object to out.

Specified by:

write in interface Bytable

Parameters:

out - DataOuput to serialize this object into.

Throws:

IOException - In case of any io exception.

doWrite

public abstract void doWrite(DataOutput out)
                      throws IOException

Write fields to out stream.

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Description copied from interface: Bytable

De-serialize the fields of this object from in.

For efficiency, implementations should attempt to re-use storage in the existing object where possible.

Specified by:

readFields in interface Bytable

Parameters:

in - DataInput to de-seriablize this object from.

Throws:

IOException - In case of any io exception.

doReadFields

public abstract void doReadFields(DataInput in)
                           throws IOException

Read fields from in stream.

Throws:

IOException