Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id B0A7A200CCF for ; Mon, 24 Jul 2017 21:08:13 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id AF1B81651BF; Mon, 24 Jul 2017 19:08:13 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 880EB16397E for ; Mon, 24 Jul 2017 21:08:11 +0200 (CEST) Received: (qmail 22577 invoked by uid 500); 24 Jul 2017 19:08:07 -0000 Mailing-List: contact commits-help@hbase.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@hbase.apache.org Delivered-To: mailing list commits@hbase.apache.org Received: (qmail 20186 invoked by uid 99); 24 Jul 2017 19:08:06 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 24 Jul 2017 19:08:06 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 9AD9FF32D3; Mon, 24 Jul 2017 19:08:04 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: git-site-role@apache.org To: commits@hbase.apache.org Date: Mon, 24 Jul 2017 19:08:38 -0000 Message-Id: <01a580f64fae42e69239a6e6112e334f@git.apache.org> In-Reply-To: <73c89cd8b4b0477088a5e6701bc60f7c@git.apache.org> References: <73c89cd8b4b0477088a5e6701bc60f7c@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [36/51] [partial] hbase-site git commit: Published site at 82d554e3783372cc6b05489452c815b57c06f6cd. archived-at: Mon, 24 Jul 2017 19:08:13 -0000 http://git-wip-us.apache.org/repos/asf/hbase-site/blob/2d5075d7/devapidocs/org/apache/hadoop/hbase/procedure2/Procedure.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/procedure2/Procedure.html b/devapidocs/org/apache/hadoop/hbase/procedure2/Procedure.html index b6faee5..a4e6eac 100644 --- a/devapidocs/org/apache/hadoop/hbase/procedure2/Procedure.html +++ b/devapidocs/org/apache/hadoop/hbase/procedure2/Procedure.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":6,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":6,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":9,"i24":10,"i25":9,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":9,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":6,"i51":6,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10}; +var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":6,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":6,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":9,"i24":10,"i25":10,"i26":9,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":9,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":6,"i52":6,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10,"i81":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
Direct Known Subclasses:
-
LockProcedure, OnePhaseProcedure, ProcedureInMemoryChore, RegionTransitionProcedure, SequentialProcedure, StateMachineProcedur e, TwoPhaseProcedure
+
LockProcedure, OnePhaseProcedure, ProcedureExecutor.FailedProcedure, ProcedureInMemoryChore, RegionTransitionProcedure, SequentialProcedure, StateMachineProcedure, TwoPhaseProcedure

@@ -431,276 +431,280 @@ implements +String +getProcName()  + + byte[] getResult()  - + protected static Long getRootProcedureId(Map<Long,Procedure> procedures, Procedure<?> proc)  - + long getRootProcId()  - + protected int[] getStackIndexes()  - -protected org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureState + +org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureState getState()  - + long getSubmittedTime()  - + int getTimeout()  - + protected long getTimeoutTimestamp()
Timeout of the next timeout.
- + protected boolean hasChildren()  - + boolean hasException()  - + protected boolean hasLock(TEnvironment env)
This is used in conjunction with holdLock(Object).
- + boolean hasOwner()  - + boolean hasParent()  - + boolean hasTimeout()  - + static boolean haveSameParent(Procedure<?> a, Procedure<?> b)  - + protected boolean holdLock(TEnvironment env)
Used to keep the procedure lock even when the procedure is yielding or suspended.
- + protected void incChildrenLatch()
Called by the ProcedureExecutor on procedure-load to restore the latch state
- + boolean isFailed()  - + boolean isFinished()  - + boolean isInitializing()  - -protected boolean + +boolean isRunnable()  - + boolean isSuccess()  - + boolean isWaiting()  - + protected boolean isYieldAfterExecutionStep(TEnvironment env)
By default, the procedure framework/executor will try to run procedures start to finish.
- + protected void releaseLock(TEnvironment env)
The user should override this method, and release lock if necessary.
- + protected boolean removeStackIndex()  - + protected abstract void rollback(TEnvironment env)
The code to undo what was done by the execute() code.
- + protected abstract void serializeStateData(OutputStream stream)
The user-level code of the procedure may have some state to persist (e.g.
- + protected void setAbortFailure(String source, String msg)  - + protected void setChildrenLatch(int numChildren)
Called by the ProcedureExecutor on procedure-load to restore the latch state
- + protected void setFailure(RemoteProcedureException exception)  - + protected void setFailure(String source, Throwable cause)  - + protected void setLastUpdate(long lastUpdate)
Called on store load to initialize the Procedure internals after the creation/deserialization.
- + protected void setNonceKey(NonceKey nonceKey)
Called by the ProcedureExecutor to set the value to the newly created procedure.
- + void setOwner(String owner)  - + void setOwner(User owner)  - + protected void setParentProcId(long parentProcId)
Called by the ProcedureExecutor to assign the parent to the newly created procedure.
- + protected void setProcId(long procId)
Called by the ProcedureExecutor to assign the ID to the newly created procedure.
- + protected void setResult(byte[] result)
The procedure may leave a "result" on completion.
- + protected void setRootProcId(long rootProcId)  - + protected void setStackIndexes(List<Integer> stackIndexes)
Called on store load to initialize the Procedure internals after the creation/deserialization.
- + protected void setState(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureState state)  - + protected void setSubmittedTime(long submittedTime)
Called on store load to initialize the Procedure internals after the creation/deserialization.
- + protected void setTimeout(int timeout)  - + protected boolean setTimeoutFailure(TEnvironment env)
Called by the ProcedureExecutor when the timeout set by setTimeout() is expired.
- + protected boolean shouldWaitClientAck(TEnvironment env)
By default, the executor will keep the procedure result around util the eviction TTL is expired.
- + String toString()  - + protected String toStringClass()  - + protected void toStringClassDetails(StringBuilder builder)
Extend the toString() information with the procedure details e.g.
- + String toStringDetails()
Extend the toString() information with more procedure details
- + protected StringBuilder toStringSimpleSB()
Build the StringBuilder for the simple form of procedure string.
- + protected void toStringState(StringBuilder builder)
Called from toString() when interpolating Procedure State.
- + (package private) boolean tryRunnable()
Try to set this procedure into RUNNABLE state.
- + protected void updateMetricsOnFinish(TEnvironment env, long runtime, @@ -708,19 +712,19 @@ implements This function will be called just after procedure execution is finished. - + protected void updateMetricsOnSubmit(TEnvironment env)
This function will be called just when procedure is submitted for execution.
- + protected void updateTimestamp()
Called by ProcedureExecutor after each time a procedure step is executed.
- + protected boolean wasExecuted()  @@ -1048,7 +1052,7 @@ implements execute(Object). It calls releaseLock(Object) after the call to execute. - +

If you need to hold the lock for the life of the Procdure -- i.e. you do not want any other Procedure interfering while this Procedure is running, see holdLock(Object). @@ -1386,13 +1390,22 @@ implements getRootProcId() + + + +

@@ -1401,7 +1414,7 @@ implements

  • getSubmittedTime

    -
    public long getSubmittedTime()
    +
    public long getSubmittedTime()
    • @@ -1410,7 +1423,7 @@ implements

  • getOwner

    -
    public String getOwner()
    +
    public String getOwner()
    • @@ -1419,7 +1432,7 @@ implements

  • hasOwner

    -
    public boolean hasOwner()
    +
    public boolean hasOwner()
    • @@ -1429,7 +1442,7 @@ implements

    setProcId

    @InterfaceAudience.Private
-protected void setProcId(long procId)
    +protected void setProcId(long procId)
    Called by the ProcedureExecutor to assign the ID to the newly created procedure.
    @@ -1440,7 +1453,7 @@ protected void 

    setParentProcId

    @InterfaceAudience.Private
-protected void setParentProcId(long parentProcId)
    +protected void setParentProcId(long parentProcId)
    Called by the ProcedureExecutor to assign the parent to the newly created procedure.
    @@ -1451,7 +1464,7 @@ protected void 

    setRootProcId

    @InterfaceAudience.Private
-protected void setRootProcId(long rootProcId)
    +protected void setRootProcId(long rootProcId) @@ -1461,7 +1474,7 @@ protected void 

    setNonceKey

    @InterfaceAudience.Private
-protected void setNonceKey(NonceKey nonceKey)
    +protected void setNonceKey(NonceKey nonceKey)
    Called by the ProcedureExecutor to set the value to the newly created procedure.
    @@ -1472,7 +1485,7 @@ protected void 

    setOwner

    @InterfaceAudience.Private
-public void setOwner(String owner)
    +public void setOwner(String owner) @@ -1481,7 +1494,7 @@ public void 

  • setOwner

    -
    public void setOwner(User owner)
    +
    public void setOwner(User owner)
    • @@ -1491,7 +1504,7 @@ public void 

    setSubmittedTime

    @InterfaceAudience.Private
-protected void setSubmittedTime(long submittedTime)
    +protected void setSubmittedTime(long submittedTime)
    Called on store load to initialize the Procedure internals after the creation/deserialization.
    @@ -1502,7 +1515,7 @@ protected void 

  • setTimeout

    -
    protected void setTimeout(int timeout)
    +
    protected void setTimeout(int timeout)
    Parameters:
    timeout - timeout interval in msec
    @@ -1515,7 +1528,7 @@ protected void 

  • hasTimeout

    -
    public boolean hasTimeout()
    +
    public boolean hasTimeout()
    • @@ -1524,7 +1537,7 @@ protected void 

  • getTimeout

    -
    public int getTimeout()
    +
    public int getTimeout()
    Returns:
    the timeout in msec
    @@ -1538,7 +1551,7 @@ protected void 

    setLastUpdate

    @InterfaceAudience.Private
-protected void setLastUpdate(long lastUpdate)
    +protected void setLastUpdate(long lastUpdate)
    Called on store load to initialize the Procedure internals after the creation/deserialization.
    • @@ -1550,7 +1563,7 @@ protected void 

    updateTimestamp

    @InterfaceAudience.Private
-protected void updateTimestamp()
    +protected void updateTimestamp()
    Called by ProcedureExecutor after each time a procedure step is executed.
    • @@ -1560,7 +1573,7 @@ protected void 

  • getLastUpdate

    -
    public long getLastUpdate()
    +
    public long getLastUpdate()
    • @@ -1570,7 +1583,7 @@ protected void 

    getTimeoutTimestamp

    @InterfaceAudience.Private
-protected long getTimeoutTimestamp()
    +protected long getTimeoutTimestamp()
    Timeout of the next timeout. Called by the ProcedureExecutor if the procedure has timeout set and the procedure is in the waiting queue.
    @@ -1586,7 +1599,7 @@ protected long 

  • elapsedTime

    -
    public long elapsedTime()
    +
    public long elapsedTime()
    Returns:
    the time elapsed between the last update and the start time of the procedure.
    @@ -1599,7 +1612,7 @@ protected long 

  • getResult

    -
    public byte[] getResult()
    +
    public byte[] getResult()
    Returns:
    the serialized result if any, otherwise null
    @@ -1612,7 +1625,7 @@ protected long 

  • setResult

    -
    protected void setResult(byte[] result)
    +
    protected void setResult(byte[] result)
    The procedure may leave a "result" on completion.
    Parameters:
    @@ -1626,7 +1639,7 @@ protected long 

  • isRunnable

    -
    protected boolean isRunnable()
    +
    public boolean isRunnable()
    Returns:
    true if the procedure is in a RUNNABLE state.
    @@ -1639,7 +1652,7 @@ protected long 

  • isInitializing

    -
    public boolean isInitializing()
    +
    public boolean isInitializing()
    • @@ -1648,7 +1661,7 @@ protected long 

  • isFailed

    -
    public boolean isFailed()
    +
    public boolean isFailed()
    Returns:
    true if the procedure has failed. It may or may not have rolled back.
    @@ -1661,7 +1674,7 @@ protected long 

  • isSuccess

    -
    public boolean isSuccess()
    +
    public boolean isSuccess()
    Returns:
    true if the procedure is finished successfully.
    @@ -1674,7 +1687,7 @@ protected long 

  • isFinished

    -
    public boolean isFinished()
    +
    public boolean isFinished()
    Returns:
    true if the procedure is finished. The Procedure may be completed successfully or @@ -1688,7 +1701,7 @@ protected long 

  • isWaiting

    -
    public boolean isWaiting()
    +
    public boolean isWaiting()
    Returns:
    true if the procedure is waiting for a child to finish or for an external event.
    @@ -1702,7 +1715,7 @@ protected long 

    setState

    @InterfaceAudience.Private
-protected void setState(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureState state)
    +protected void setState(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureState state)
    • @@ -1712,7 +1725,7 @@ protected void 

    getState

    @InterfaceAudience.Private
-protected org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureState getState()
    +public org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureState getState()
    • @@ -1721,7 +1734,7 @@ protected org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos @@ -1731,7 +1744,7 @@ protected org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos @@ -1740,7 +1753,7 @@ protected org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos @@ -1752,7 +1765,7 @@ protected org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos @@ -1797,7 +1810,7 @@ protected void 

    incChildrenLatch

    @InterfaceAudience.Private
-protected void incChildrenLatch()
    +protected void incChildrenLatch()
    Called by the ProcedureExecutor on procedure-load to restore the latch state
    • @@ -1808,7 +1821,7 @@ protected void 

    childrenCountDown

    @InterfaceAudience.Private
-private boolean childrenCountDown()
    +private boolean childrenCountDown()
    Called by the ProcedureExecutor to notify that one of the sub-procedures has completed.
    • @@ -1818,7 +1831,7 @@ private boolean 

  • tryRunnable

    -
    boolean tryRunnable()
    +
    boolean tryRunnable()
    Try to set this procedure into RUNNABLE state. Succeeds if all subprocedures/children are done.
    @@ -1834,7 +1847,7 @@ private boolean 

    hasChildren

    @InterfaceAudience.Private
-protected boolean hasChildren()
    +protected boolean hasChildren()
    • @@ -1844,7 +1857,7 @@ protected boolean 

    getChildrenLatch

    @InterfaceAudience.Private
-protected int getChildrenLatch()
    +protected int getChildrenLatch()
    • @@ -1854,7 +1867,7 @@ protected int 

    addStackIndex

    @InterfaceAudience.Private
-protected void addStackIndex(int index)
    +protected void addStackIndex(int index)
    Called by the RootProcedureState on procedure execution. Each procedure store its stack-index positions.
    • @@ -1866,7 +1879,7 @@ protected void 

    removeStackIndex

    @InterfaceAudience.Private
-protected boolean removeStackIndex()
    +protected boolean removeStackIndex()
    • @@ -1876,7 +1889,7 @@ protected boolean 

    setStackIndexes

    @InterfaceAudience.Private
-protected void setStackIndexes(List<Integer> stackIndexes)
    +protected void setStackIndexes(List<Integer> stackIndexes)
    Called on store load to initialize the Procedure internals after the creation/deserialization.
    • @@ -1888,7 +1901,7 @@ protected void 

    wasExecuted

    @InterfaceAudience.Private
-protected boolean wasExecuted()
    +protected boolean wasExecuted() @@ -1898,7 +1911,7 @@ protected boolean 

    getStackIndexes

    @InterfaceAudience.Private
-protected int[] getStackIndexes()
    +protected int[] getStackIndexes() @@ -1910,7 +1923,7 @@ protected int[] 

    doExecute

    @InterfaceAudience.Private
-protected Procedure<TEnvironment>[] doExecute(TEnvironment env)
+protected Procedure<TEnvironment>[] doExecute(TEnvironment env)
                                                                   throws ProcedureYieldException,
                                                                          ProcedureSuspendedException,
                                                                          InterruptedException
    @@ -1933,7 +1946,7 @@ protected 

    doRollback

    @InterfaceAudience.Private
-protected void doRollback(TEnvironment env)
+protected void doRollback(TEnvironment env)
                                               throws IOException,
                                                      InterruptedException
    Internal method called by the ProcedureExecutor that starts the user-level code rollback().
    @@ -1953,7 +1966,7 @@ protected void 

    doAcquireLock

    @InterfaceAudience.Private
-protected Procedure.LockState doAcquireLock(TEnvironment env)
    +protected Procedure.LockState doAcquireLock(TEnvironment env)
    Internal method called by the ProcedureExecutor that starts the user-level code acquireLock().
    @@ -1966,7 +1979,7 @@ protected 

    doReleaseLock

    @InterfaceAudience.Private
-protected void doReleaseLock(TEnvironment env)
    +protected void doReleaseLock(TEnvironment env)
    Internal method called by the ProcedureExecutor that starts the user-level code releaseLock().
    @@ -1976,7 +1989,7 @@ protected void 

  • compareTo

    -
    public int compareTo(Procedure<TEnvironment> other)
    +
    public int compareTo(Procedure<TEnvironment> other)
    Specified by:
    compareTo in interface Comparable<Procedure<TEnvironment>>
    @@ -1989,7 +2002,7 @@ protected void 

  • getProcIdHashCode

    -
    public static long getProcIdHashCode(long procId)
    +
    public static long getProcIdHashCode(long procId)
    Get an hashcode for the specified Procedure ID
    Returns:
    @@ -2004,7 +2017,7 @@ protected void 

    getRootProcedureId

    @InterfaceAudience.Private
-protected static Long getRootProcedureId(Map<Long,Procedure> procedures,
+protected static Long getRootProcedureId(Map<Long,Procedure> procedures,
                                                                     Procedure<?> proc)
    • @@ -2014,7 +2027,7 @@ protected static 

  • haveSameParent

    -
    public static boolean haveSameParent(Procedure<?> a,
+
    public static boolean haveSameParent(Procedure<?> a,
                                      Procedure<?> b)
    
 
    
 
    Parameters: