microboxlabs/quarkus-sse repository overview

⁠Quick reference

• Maintained by: Quarkus SSE Comunity⁠
• Where to get help: GitHub Issues⁠

⁠Supported tags and respective Dockerfile links

• latest, trunk Dockerfile link⁠

⁠Quick reference (cont.)

• Where to file issues: Quarkus SSE Issues⁠
• Supported architectures: amd64

⁠What is Quarkus-SSE?

Quarkus-SSE is a high-performance server built using Quarkus, optimized for real-time event streaming through Server-Sent Events (SSE). Leveraging a reactive architecture, Quarkus-SSE enables fast and scalable event-driven solutions ideal for cloud-native applications, microservices, and real-time notifications. It provides developers with a robust platform to efficiently manage and push events to clients, enhancing resource utilization and improving response times. Whether you're building complex microservices or a lightweight notification system, Quarkus-SSE simplifies the development process while ensuring scalability.

⁠How to use this image

$ docker run --name quarkus-sse -p 8080:8080 -d microboxlabs/quarkus-sse:latest

⁠Consuming the event stream

To consume the event stream, you can use curl with the following command:

$ curl -N -H "Accept:text/event-stream" http://localhost:8080/events/stream

This will start listening to the event stream. The -N flag is used to disable buffering of the output.

To consume events for a specific event type:

$ curl -N http://localhost:8080/events/stream/myEventType

To consume events for a specific tenant:

$ curl -N http://localhost:8080/events/tenant/myTenantId/stream

To consume events for a specific tenant and event type:

$ curl -N http://localhost:8080/events/tenant/myTenantId/stream/myEventType

⁠Emitting events

To emit a new event, you can use curl to send a POST request:

$ curl http://localhost:8080/events/emit \
-H "Content-Type: application/json" \
-d '{
  "id": "evt_123456",
  "eventType": "myEventType",
  "tenantId": "myTenantId",
  "payload": {
      "any": "..."
   },
  "timestamp": "2023-04-15T10:30:00Z",
  "metadata": "string"
}' 

This will emit a new event with the specified event type, tenant ID, and data.

⁠License

View license information⁠ for the software contained in this image.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.