com.bigdata.ha.msg.IHA2PhasePrepareMessage Maven / Gradle / Ivy
/**
Copyright (C) SYSTAP, LLC DBA Blazegraph 2006-2016. All rights reserved.
Contact:
SYSTAP, LLC DBA Blazegraph
2501 Calvert ST NW #106
Washington, DC 20008
[email protected]
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package com.bigdata.ha.msg;
import java.util.concurrent.TimeUnit;
import com.bigdata.ha.HACommitGlue;
import com.bigdata.journal.IRootBlockView;
/**
* Message used by the {@link HACommitGlue} interface to indicate that the
* recipient should save a reference to the caller's root block, flush writes to
* the backing channel and acknowledge "yes" if ready to commit. If the node can
* not prepare for any reason, then it must return "no".
*
* @author Bryan Thompson
*/
public interface IHA2PhasePrepareMessage extends IHA2PhaseCommitProtocolMessage {
/**
* The consensus release time from the GATHER.
*/
IHANotifyReleaseTimeResponse getConsensusReleaseTime();
/**
* true iff the service was recognized as being joined with the
* met quorum at the time that the GATHER message was prepared.
*
* Note: This is used to support atomic decisions about whether or not a
* service was joined with the met quorum at the time that the leader
* decided to update the consensus release time. Services that are in the
* pipeline and resynchronizing were either joined or not for the purposes
* of a given 2-phase GATHER operation based on this flag.
*/
boolean isGatherService();
/**
* true iff the service was recognized as being joined with the
* met quorum at the time that the PREPARE message was prepared.
*
* Note: This is used to support atomic decisions about whether or not a
* service was joined with the met quorum at the time that the leader
* decided to commit. Services that are in the pipeline and resynchronizing
* will either be joined or not for the purposes of a given 2-phase commit
* based on this flag.
*
* Note: A better name for this flag would be isPrepareService().
*/
boolean isJoinedService();
/**
* true if this is rootBlock0 for the leader.
*/
boolean isRootBlock0();
/**
* The new root block.
*/
IRootBlockView getRootBlock();
/**
* How long to wait for the other services to prepare.
*/
long getTimeout();
/**
* The unit for the timeout.
*/
TimeUnit getUnit();
/**
* When true, always vote note.
*
* Note: This is for unit tests only.
*/
boolean voteNo();
}