Skip to content

readme_updates #781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 17, 2025
Merged

readme_updates #781

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions impl/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ Full examples:

---

## Detailed Walkthrough
## Event publish/subscribe example

We’ll coordinate two workflows—one **listens** for high temperatures and the other **emits** temperature events:

Expand All @@ -181,8 +181,8 @@ Create an application (customize thread pools, etc.). `WorkflowApplication` is `

```java
try (WorkflowApplication appl = WorkflowApplication.builder().build()) {
var listen = appl.workflowDefinition(WorkflowReader.readWorkflowFromClasspath("listen.yaml"));
var emit = appl.workflowDefinition(WorkflowReader.readWorkflowFromClasspath("emit.yaml"));
WorkflowDefinition listen = appl.workflowDefinition(WorkflowReader.readWorkflowFromClasspath("listen.yaml"));
WorkflowDefinition emit = appl.workflowDefinition(WorkflowReader.readWorkflowFromClasspath("emit.yaml"));

// Start the listener (non-blocking)
listen.instance(Map.of())
Expand All @@ -207,6 +207,12 @@ Source: `examples/events/src/main/java/events/EventExample.java`

---

## Workflow execution control

As shown in previous examples, to start a new workflow instance, first a [WorkflowInstance](https://github.com/serverlessworkflow/sdk-java/blob/main/impl/core/src/main/java/io/serverlessworkflow/impl/WorkflowInstance) is created from a [WorkflowDefinition](https://github.com/serverlessworkflow/sdk-java/blob/main/impl/core/src/main/java/io/serverlessworkflow/impl/WorkflowDefinition.java#L74), specifying the desired input, and then start method is invoked over it. Start method returns a CompletableFuture, which might be used to obtain the output, either synchronously or asynchronously.

Once started, and before it completes, a workflow instance execution can be suspended or cancelled. Once cancelled, a workflow instance is done, while a suspended one might be resumed.

## Fluent Java DSL

Prefer building workflows programmatically with type-safe builders and recipes?
Expand Down