EventStream.php

<?php

declare(strict_types=1);

/*
 * This file is part of the Composer package "eliashaeussler/sse".
 *
 * Copyright (C) 2023-2024 Elias Häußler <elias@haeussler.dev>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

namespace EliasHaeussler\SSE\Stream;

use EliasHaeussler\SSE\Event;
use EliasHaeussler\SSE\Exception;
use JsonException;
use Psr\Http\Message;

/**
 * EventStream.
 *
 * @author Elias Häußler <elias@haeussler.dev>
 * @license GPL-3.0-or-later
 */
interface EventStream
{
    public const CONTENT_TYPE = 'text/event-stream';

    /**
     * @throws Exception\StreamIsActive
     */
    public function open(): void;

    /**
     * @throws Exception\StreamIsClosed
     * @throws Exception\StreamIsInactive
     */
    public function close(string $eventName = 'done'): void;

    /**
     * @throws Exception\StreamIsClosed
     * @throws Exception\StreamIsInactive
     * @throws JsonException
     */
    public function sendEvent(Event\Event $event): void;

    /**
     * @throws Exception\StreamIsClosed
     * @throws Exception\StreamIsInactive
     */
    public function sendMessage(string $name = 'message', bool|float|int|string|null $data = null): void;

    public function isActive(): bool;

    public static function canHandle(Message\ServerRequestInterface $request): bool;
}