com.alipay.sofa.jraft.core

Class IteratorWrapper

java.lang.Object

com.alipay.sofa.jraft.core.IteratorWrapper

All Implemented Interfaces:

Iterator<ByteBuffer>

public class IteratorWrapper
extends Object
implements Iterator

Constructor Summary

Constructors

Constructor and Description
IteratorWrapper(IteratorImpl iterImpl)

Method Summary

Modifier and Type	Method and Description
boolean	commit() Commit state machine.
void	commitAndSnapshotSync(Closure done) Commit state machine, then try to save a snapshot with current log applied if commit successfully.
Closure	done() If done() is non-NULL, you must call done()->Run() after applying this task no matter this operation succeeds or fails, otherwise the corresponding resources would leak.
ByteBuffer	getData() Return the data whose content is the same as what was passed to Node#apply(Task) in the leader node.
long	getIndex() Return a unique and monotonically increasing identifier of the current task: - Uniqueness guarantees that committed tasks in different peers with the same index are always the same and kept unchanged.
long	getTerm() Returns the term of the leader which to task was applied to.
boolean	hasNext()
ByteBuffer	next()
void	setAutoCommitPerLog(boolean status) When calling #{Iterator#next}, whether to commit the state machine.
void	setErrorAndRollback(long ntail, Status st) Invoked when some critical error occurred.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

IteratorWrapper

public IteratorWrapper(IteratorImpl iterImpl)

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<ByteBuffer>

next

public ByteBuffer next()

Specified by:

next in interface Iterator<ByteBuffer>

setAutoCommitPerLog

public void setAutoCommitPerLog(boolean status)

Description copied from interface: Iterator

When calling #{Iterator#next}, whether to commit the state machine. Don't by default.

Parameters:

status - enables auto-commit mode or not, true means enable.

getData

public ByteBuffer getData()

Description copied from interface: Iterator

Return the data whose content is the same as what was passed to Node#apply(Task) in the leader node.

getIndex

public long getIndex()

Description copied from interface: Iterator

Return a unique and monotonically increasing identifier of the current task: - Uniqueness guarantees that committed tasks in different peers with the same index are always the same and kept unchanged. - Monotonicity guarantees that for any index pair i, j (i < j), task at index |i| must be applied before task at index |j| in all the peers from the group.

getTerm

public long getTerm()

Description copied from interface: Iterator

Returns the term of the leader which to task was applied to.

commit

public boolean commit()

Description copied from interface: Iterator

Commit state machine. After this invocation, we will consider that the state machine promises the last task is already applied successfully and can't be rolled back.

commitAndSnapshotSync

public void commitAndSnapshotSync(Closure done)

Description copied from interface: Iterator

Commit state machine, then try to save a snapshot with current log applied if commit successfully.

Parameters:

done - Invoked when the snapshot finishes, describing the detailed result.

See Also:

Node.snapshotSync(Closure), Iterator.commit()

done

public Closure done()

Description copied from interface: Iterator

If done() is non-NULL, you must call done()->Run() after applying this task no matter this operation succeeds or fails, otherwise the corresponding resources would leak. If this task is proposed by this Node when it was the leader of this group and the leadership has not changed before this point, done() is exactly what was passed to Node#apply(Task) which may stand for some continuation (such as respond to the client) after updating the StateMachine with the given task. Otherwise done() must be NULL.

setErrorAndRollback

public void setErrorAndRollback(long ntail,
                                Status st)

Description copied from interface: Iterator

Invoked when some critical error occurred. And we will consider the last |ntail| tasks (starting from the last iterated one) as not applied. After this point, no further changes on the StateMachine as well as the Node would be allowed and you should try to repair this replica or just drop it.

Parameters:

ntail - the number of tasks (starting from the last iterated one) considered as not to be applied.

st - Status to describe the detail of the error.