Skip to content

Commit

Permalink
Merge pull request #24 from OpenLiberty/staging
Browse files Browse the repository at this point in the history
Merge staging to prod - update README.adoc
  • Loading branch information
gkwan-ibm authored Dec 16, 2022
2 parents be13694 + 9753247 commit 7dfca03
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Test application

on:
pull_request:
branches: [ draft ]
branches: [ prod, staging ]

jobs:
check-files:
Expand All @@ -27,7 +27,7 @@ jobs:
env:
VALIDATE_ALL_CODEBASE: false
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DEFAULT_BRANCH: draft # todo remove after publishing
DEFAULT_BRANCH: prod
LINTER_RULES_PATH: ./tools/pr-checker/linters/
VALIDATE_DOCKERFILE: true
VALIDATE_JAVA: true
Expand Down
4 changes: 2 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ Learn how to use Jakarta WebSocket to send and receive messages between services

== What you'll learn

Jakarta WebSocket enables two-way communication between client and server endpoints. First, each client makes an HTTP connection to a Jakarta WebSocket server. The server can then broadcast messages to the clients. link:https://openliberty.io/guides/reactive-messaging-sse.html[Server-Sent Events (SSE)] also enables a client to receive automatic updates from a server via an HTTP connection however WebSocket differs from Server-Sent Events in that SSE is unidirectional from server to client, whereas WebSocket is bidirectional. WebSocket also enables real-time updates over a smaller bandwidth than SSE. The connection isn't closed meaning that the client can continue to send and receive messages with the server, without having to poll the server to receive any replies.
Jakarta WebSocket enables two-way communication between client and server endpoints. First, each client makes an HTTP connection to a Jakarta WebSocket server. The server can then broadcast messages to the clients. link:https://openliberty.io/guides/reactive-messaging-sse.html[Server-Sent Events (SSE)^] also enables a client to receive automatic updates from a server via an HTTP connection however WebSocket differs from Server-Sent Events in that SSE is unidirectional from server to client, whereas WebSocket is bidirectional. WebSocket also enables real-time updates over a smaller bandwidth than SSE. The connection isn't closed meaning that the client can continue to send and receive messages with the server, without having to poll the server to receive any replies.

The application that you will build in this guide consists of the `client` service and the `system` server service. The following diagram depicts the application that is used in this guide.

image::architecture.png[Application architecture where system and client services use the Jakarta Websocket API to connect and communicate. align="center"]

You'll learn how to use the link:https://openliberty.io/docs/latest/reference/javadoc/liberty-jakartaee9.1-javadoc.html?package=jakarta/websocket/package-frame.html&class=overview-summary.html[Jakarta WebSocket API] to build the `system` service and the scheduler in the `client` service. The scheduler pushes messages to the system service every 10 seconds, then the system service broadcasts the messages to any connected clients. You will also learn how to use a JavaScript `WebSocket` object in an HTML file to build a WebSocket connection, subscribe to different events, and display the broadcasting messages from the `system` service in a table.
You'll learn how to use the link:https://openliberty.io/docs/latest/reference/javadoc/liberty-jakartaee9.1-javadoc.html?package=jakarta/websocket/package-frame.html&class=overview-summary.html[Jakarta WebSocket API^] to build the `system` service and the scheduler in the `client` service. The scheduler pushes messages to the system service every 10 seconds, then the system service broadcasts the messages to any connected clients. You will also learn how to use a JavaScript `WebSocket` object in an HTML file to build a WebSocket connection, subscribe to different events, and display the broadcasting messages from the `system` service in a table.

// =================================================================================================
// Getting started
Expand Down

0 comments on commit 7dfca03

Please sign in to comment.