com.connectrpc.UnaryBlockingCall.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.7.0

// Copyright 2022-2023 The Connect Authors
//
// 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 com.connectrpc

/**
 * A [UnaryBlockingCall] contains the way to make a blocking RPC call and cancelling the RPC.
 */
interface UnaryBlockingCall {
    /**
     * Execute the underlying request. Can only be called once.
     * Subsequent calls will throw IllegalStateException.
     */
    fun execute(): ResponseMessage

    /**
     * Cancel the underlying request.
     */
    fun cancel()
}