build.buf.connect.ServerOnlyStreamInterface.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of connect-kotlin Show documentation

Simple, reliable, interoperable. A better RPC.

There is a newer version: 0.1.10

// Copyright 2022-2023 Buf Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package build.buf.connect

import kotlinx.coroutines.channels.ReceiveChannel
/**
 * Represents a server-only stream (a stream where the server streams data to the client after
 * receiving an initial request) that can send request messages.
 */
interface ServerOnlyStreamInterface {
    /**
     * The Channel for received StreamResults.
     *
     * @return ReceiveChannel for iterating over the received results.
     */
    fun resultChannel(): ReceiveChannel>

    /**
     * Send a request to the server over the stream.
     *
     * Can only be called exactly one time when starting the stream.
     *
     * @param input The request message to send.
     */
    suspend fun send(input: Input)

    /**
     * Close the stream. No calls to `send()` are valid after calling `close()`.
     */
    fun close()
}