Hosmel Quintana
Introduction
Installation
Basic usage
Streaming Requests
Reading Events
Handling Errors
Advanced usage
Timeouts
Testing
Compatibility
View on GitHub

Introduction

SSE Saloon Plugin turns Saloon requests into Server-Sent Events streams and yields each event as the server sends it.

SSE Saloon Plugin adds Server-Sent Events (SSE) streaming to Saloon requests. Add a trait to a request, send it with your connector as usual, and iterate the events as the server sends them. PHP SSE parses the events.

Quick start

After installing the package, add the HasServerSentEvents trait to a request:

php
use HosmelQ\SSE\Saloon\Traits\HasServerSentEvents;
use Saloon\Enums\Method;
use Saloon\Http\Request;

final class StreamNotifications extends Request
{
    use HasServerSentEvents;

    protected Method $method = Method::GET;

    public function resolveEndpoint(): string
    {
        return '/notifications/stream';
    }
}

Send it and iterate the events:

php
$response = $connector->send(new StreamNotifications());

foreach ($response->asEventSource()->events() as $event) {
    echo $event->event.': '.$event->data.PHP_EOL;
}

The loop ends when the server closes the stream.

Next steps

  • Streaming Requests explains what the trait changes and how to send POST bodies.
  • Reading Events covers the response and its events.
  • Handling Errors explains which exceptions to catch.
Installation