All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.vertx.grpc.server.GrpcServerRequest Maven / Gradle / Ivy

/*
 * Copyright (c) 2011-2022 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 * which is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 */
package io.vertx.grpc.server;

import io.vertx.codegen.annotations.CacheReturn;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.Nullable;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Handler;
import io.vertx.core.Timer;
import io.vertx.core.http.HttpConnection;
import io.vertx.grpc.common.GrpcError;
import io.vertx.grpc.common.GrpcMessage;
import io.vertx.grpc.common.GrpcReadStream;
import io.vertx.grpc.common.ServiceName;

import java.time.Instant;

@VertxGen
public interface GrpcServerRequest extends GrpcReadStream {

  /**
   * @return the service name
   */
  @CacheReturn
  ServiceName serviceName();

  /**
   * @return the method name
   */
  @CacheReturn
  String methodName();

  /**
   * @return the full method name sent by the client
   */
  @CacheReturn
  String fullMethodName();

  /**
   * @return the response
   */
  @CacheReturn
  GrpcServerResponse response();

  @Override
  @Fluent
  GrpcServerRequest messageHandler(@Nullable Handler handler);

  @Override
  @Fluent
  GrpcServerRequest errorHandler(@Nullable Handler handler);

  @Override
  GrpcServerRequest exceptionHandler(@Nullable Handler handler);

  @Override
  GrpcServerRequest handler(@Nullable Handler handler);

  @Override
  GrpcServerRequest pause();

  @Override
  GrpcServerRequest resume();

  @Override
  GrpcServerRequest fetch(long amount);

  @Override
  GrpcServerRequest endHandler(@Nullable Handler endHandler);

  /**
   * @return the underlying HTTP connection
   */
  HttpConnection connection();

  /**
   * @return the request timeout sent by the client or {@code 0L} if none.
   */
  long timeout();

  /**
   * @return the request deadline or {@code null} when no deadline has been scheduled
   */
  Timer deadline();

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy