io.inverno.mod.grpc.server.GrpcExchangeHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of inverno-grpc-server Show documentation

Inverno gRPC server module

There is a newer version: 1.12.0

/*
 * Copyright 2024 Jeremy Kuhn
 *
 * 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 io.inverno.mod.grpc.server;

import com.google.protobuf.Message;
import io.inverno.mod.grpc.base.GrpcException;
import io.inverno.mod.http.base.ExchangeContext;
import reactor.core.publisher.Mono;

/**
 * 
 * A gRPC exchange handler is used to handle gRPC server exchanges.
 * 
 * 
 * @author Jeremy Kuhn
 * @since 1.9
 * 
 * @param  The exchange context type 
 * @param  The request message type
 * @param  The response message type
 * @param  the request type
 * @param  the response type
 * @param  the gRPC exchange type
 */
@FunctionalInterface
public interface GrpcExchangeHandler, E extends GrpcResponse, F extends GrpcExchange> {

	/**
	 * 
	 * Returns a Mono that defers the processing of the exchange.
	 * 
	 * 
	 * 
	 * By default, returns a Mono that defers the execution of {@link #handle(io.inverno.mod.grpc.server.GrpcExchange) }.
	 * 
	 * 
	 * @param exchange the gRPC exchange to process
	 * 
	 * @return an empty mono that completes when the exchange has been processed
	 * 
	 * @throws GrpcException if an error occurs during the processing of the exchange
	 */
	default Mono defer(F exchange) throws GrpcException {
		return Mono.fromRunnable(() -> this.handle(exchange));
	}
	
	/**
	 * 
	 * Processes the specified server exchange.
	 * 
	 *
	 * 
	 * This method is more convenient than {@link #defer(io.inverno.mod.grpc.server.GrpcExchange) } when the handling logic does not need to be reactive.
	 * 
	 * 
	 * @param exchange the gRPC exchange to process
	 * 
	 * @throws GrpcException if an error occurs during the processing of the exchange
	 */
	void handle(F exchange) throws GrpcException;
}