Skip to content

Commit 4d08834

Browse files
committed
Update docs for deadlock detection timeout
1 parent 91a92e8 commit 4d08834

4 files changed

Lines changed: 9 additions & 9 deletions

File tree

temporal-sdk/src/main/java/io/temporal/internal/sync/DeterministicRunner.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ static DeterministicRunner newRunner(
5252
* completed or blocked.
5353
*
5454
* @throws Throwable if one of the threads didn't handle an exception.
55-
* @param deadlockDetectionTimeout the maximum time in milliseconds a thread can run without
56-
* calling yield.
55+
* @param deadlockDetectionTimeout the maximum time in milliseconds after a thread is
56+
* scheduled until it yields or completes.
5757
*/
5858
void runUntilAllBlocked(long deadlockDetectionTimeout);
5959

temporal-sdk/src/main/java/io/temporal/internal/sync/WorkflowThread.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ static WorkflowThread newThread(Runnable runnable, boolean detached, String name
6565
SyncWorkflowContext getWorkflowContext();
6666

6767
/**
68-
* @param deadlockDetectionTimeoutMs maximum time in milliseconds the thread can run before
69-
* calling yield.
68+
* @param deadlockDetectionTimeoutMs the maximum time in milliseconds after a thread is
69+
* scheduled until it yields or completes.
7070
* @return true if coroutine made some progress.
7171
*/
7272
boolean runUntilBlocked(long deadlockDetectionTimeoutMs);

temporal-sdk/src/main/java/io/temporal/internal/sync/WorkflowThreadContext.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,8 +210,8 @@ public String getYieldReason() {
210210
}
211211

212212
/**
213-
* @param deadlockDetectionTimeoutMs maximum time in milliseconds the thread can run before
214-
* calling yield. Discarded if {@code TEMPORAL_DEBUG} env variable is set.
213+
* @param deadlockDetectionTimeoutMs the maximum time in milliseconds after a thread is scheduled
214+
* until it yields or completes. Discarded if {@code TEMPORAL_DEBUG} env variable is set.
215215
* @return true if thread made some progress. Which is await was unblocked and some code after it
216216
* * was executed.
217217
*/

temporal-sdk/src/main/java/io/temporal/worker/WorkerOptions.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -327,9 +327,9 @@ public Builder setLocalActivityWorkerOnly(boolean localActivityWorkerOnly) {
327327
/**
328328
* @param defaultDeadlockDetectionTimeoutMs time period in ms that will be used to detect
329329
* workflows deadlock. Default is 1000ms, which is chosen if set to zero.
330-
* <p>Specifies an amount of time in milliseconds that workflow tasks are allowed to execute
331-
* without interruption. If workflow task runs longer than specified interval without
332-
* yielding (like calling an Activity), it will fail automatically.
330+
* <p>Specifies a time interval in milliseconds within which a workflow task must
331+
* yield (like calling an Activity) or complete. If a workflow task runs longer than
332+
* the specified interval or takes too long to begin running, it will fail automatically.
333333
* @return {@code this}
334334
* @see io.temporal.internal.sync.PotentialDeadlockException
335335
*/

0 commit comments

Comments
 (0)