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
021/**
022 * Callback that writes a streaming HTTP response body.
023 *
024 * @author <a href="https://www.revetkn.com">Mark Allen</a>
025 */
026@FunctionalInterface
027public interface StreamingResponseWriter {
028        /**
029         * Writes response bytes to the provided output stream.
030         *
031         * @param output  the response stream
032         * @param context runtime context for this streaming response
033         * @throws Exception if the stream producer fails
034         */
035        void writeTo(@NonNull ResponseStream output,
036                                                         @NonNull StreamingResponseContext context) throws Exception;
037}