001/*
002 * Copyright 2022-2026 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.soklet;
018
019import org.jspecify.annotations.NonNull;
020
021import javax.annotation.concurrent.ThreadSafe;
022
023/**
024 * Checked setup or catch-up work for an accepted Server-Sent Event client.
025 * <p>
026 * Events and comments queued by the initializer are delivered only after it returns successfully, subject to
027 * {@link SseServer.Builder#connectionQueueCapacity(Integer)}. Initialization must be bounded; this callback
028 * is not an indefinite producer running after connection activation. An initializer failure terminates the
029 * connection; queued writes are discarded. The accepted response has already been written, so an initializer
030 * exception is reported by the stream-termination callbacks with {@link StreamTerminationReason#PRODUCER_FAILED}
031 * and its cause. Queue overflow elects {@link StreamTerminationReason#BACKPRESSURE}, even when caught by
032 * the initializer. An earlier termination reason still wins. Establishment observation precedes termination
033 * observation even if initialization never activates the connection. Do not retain the unicaster after this callback returns.
034 * Peer disconnection or server shutdown can prevent an initializer from entering or interrupt one already
035 * in progress. Initialization should cooperate with interruption; its lifecycle capacity remains reserved
036 * until the callback physically returns.
037 * <p>
038 * One initializer instance may be reused concurrently for different clients. Captured application state must
039 * support that reuse.
040 *
041 * @author <a href="https://www.revetkn.com">Mark Allen</a>
042 */
043@ThreadSafe
044@FunctionalInterface
045public interface SseClientInitializer {
046        /**
047         * Initializes an accepted client before its queued writes are delivered.
048         *
049         * @param sseUnicaster the unicaster for this one-time initialization
050         * @throws Exception if initialization fails
051         */
052        void initialize(@NonNull SseUnicaster sseUnicaster) throws Exception;
053}