Interface GrpcServiceClient

public interface GrpcServiceClient
Client for a single service.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    <ReqT,ResT>
    io.grpc.stub.StreamObserver<ReqT>
    bidi(String methodName, io.grpc.stub.StreamObserver<ResT> response)
    gRPC bidirectional call using StreamObserver.
    <ReqT,ResT>
    Iterator<ResT>
    bidi(String methodName, Iterator<ReqT> request)
    gRPC bidirectional call using Iterator.
    default <ReqT,ResT>
    Stream<ResT>
    bidirectional(String methodName, Stream<ReqT> requests)
    gRPC bidirectional call using resource-owning Streams.
    <ReqT,ResT>
    io.grpc.stub.StreamObserver<ReqT>
    clientStream(String methodName, io.grpc.stub.StreamObserver<ResT> response)
    Asynchronous gRPC client stream call.
    <ReqT,ResT>
    ResT
    clientStream(String methodName, Iterator<ReqT> request)
    Blocking gRPC client stream call.
    default <ReqT,ResT>
    ResT
    clientStreaming(String methodName, Stream<ReqT> requests)
    Blocking gRPC client-streaming call consuming a resource-owning Stream.
    <ReqT,ResT>
    Iterator<ResT>
    serverStream(String methodName, ReqT request)
    Blocking gRPC server stream call.
    <ReqT,ResT>
    void
    serverStream(String methodName, ReqT request, io.grpc.stub.StreamObserver<ResT> response)
    Asynchronous gRPC server stream call.
    default <ReqT,ResT>
    Stream<ResT>
    serverStreaming(String methodName, ReqT request)
    Blocking gRPC server-streaming call exposed as a resource-owning Stream.
    String
    serviceName()
    Name of the service this client was created for.
    <ReqT,ResT>
    ResT
    unary(String methodName, ReqT request)
    Blocking gRPC unary call.
    <ReqT,ResT>
    void
    unary(String methodName, ReqT request, io.grpc.stub.StreamObserver<ResT> response)
    Asynchronous gRPC unary call.

  • Method Details

    • serviceName

      String serviceName()
      Name of the service this client was created for.
      Returns:
      service name

    • unary

      <ReqT,ResT> ResT unary(String methodName, ReqT request)
      Blocking gRPC unary call.
      Type Parameters:
      ReqT - type of request
      ResT - type of response
      Parameters:
      methodName - method name
      request - the request
      Returns:
      the response

    • unary

      <ReqT,ResT> void unary(String methodName, ReqT request, io.grpc.stub.StreamObserver<ResT> response)
      Asynchronous gRPC unary call.
      Type Parameters:
      ReqT - type of request
      ResT - type of response
      Parameters:
      methodName - method name
      request - the request
      response - the response observer

    • serverStream

      <ReqT,ResT> Iterator<ResT> serverStream(String methodName, ReqT request)
      Blocking gRPC server stream call.
      Type Parameters:
      ReqT - type of request
      ResT - type of response
      Parameters:
      methodName - method name
      request - the request
      Returns:
      the response iterator

    • serverStream

      <ReqT,ResT> void serverStream(String methodName, ReqT request, io.grpc.stub.StreamObserver<ResT> response)
      Asynchronous gRPC server stream call.
      Type Parameters:
      ReqT - type of request
      ResT - type of response
      Parameters:
      methodName - method name
      request - the request
      response - the response observer

    • clientStream

      <ReqT,ResT> ResT clientStream(String methodName, Iterator<ReqT> request)
      Blocking gRPC client stream call.
      Type Parameters:
      ReqT - type of request
      ResT - type of response
      Parameters:
      methodName - method name
      request - the request iterator
      Returns:
      the response

    • clientStream

      <ReqT,ResT> io.grpc.stub.StreamObserver<ReqT> clientStream(String methodName, io.grpc.stub.StreamObserver<ResT> response)
      Asynchronous gRPC client stream call.
      Type Parameters:
      ReqT - type of request
      ResT - type of response
      Parameters:
      methodName - method name
      response - the response observer
      Returns:
      the request observer

    • bidi

      <ReqT,ResT> Iterator<ResT> bidi(String methodName, Iterator<ReqT> request)
      gRPC bidirectional call using Iterator.
      Type Parameters:
      ReqT - type of request
      ResT - type of response
      Parameters:
      methodName - method name
      request - request iterator
      Returns:
      response iterator

    • serverStreaming

      default <ReqT,ResT> Stream<ResT> serverStreaming(String methodName, ReqT request)
      Blocking gRPC server-streaming call exposed as a resource-owning Stream. Closing the returned stream cancels an active RPC. Implementations supporting resource-owning streaming calls must override this method.
      Type Parameters:
      ReqT - type of request
      ResT - type of response
      Parameters:
      methodName - method name
      request - request
      Returns:
      response stream
      Throws:
      UnsupportedOperationException - if this implementation does not support resource-owning streams

    • clientStreaming

      default <ReqT,ResT> ResT clientStreaming(String methodName, Stream<ReqT> requests)
      Blocking gRPC client-streaming call consuming a resource-owning Stream. The request stream is closed on normal completion, cancellation, or failure and must not be reused after this method is called. The calling thread consumes the request stream. If producing request elements can block, closing the stream must unblock production so this method can return promptly after an early peer termination. Implementations supporting resource-owning streaming calls must override this method.
      Type Parameters:
      ReqT - type of request
      ResT - type of response
      Parameters:
      methodName - method name
      requests - request stream
      Returns:
      response
      Throws:
      UnsupportedOperationException - if this implementation does not support resource-owning streams

    • bidirectional

      default <ReqT,ResT> Stream<ResT> bidirectional(String methodName, Stream<ReqT> requests)
      gRPC bidirectional call using resource-owning Streams. The request stream is closed on normal completion, failure, or early closure of the returned stream and must not be reused after this method is called. Closing the returned stream cancels an active RPC. Implementations supporting resource-owning streaming calls must override this method.
      Type Parameters:
      ReqT - type of request
      ResT - type of response
      Parameters:
      methodName - method name
      requests - request stream
      Returns:
      response stream
      Throws:
      UnsupportedOperationException - if this implementation does not support resource-owning streams

    • bidi

      <ReqT,ResT> io.grpc.stub.StreamObserver<ReqT> bidi(String methodName, io.grpc.stub.StreamObserver<ResT> response)
      gRPC bidirectional call using StreamObserver.
      Type Parameters:
      ReqT - type of request
      ResT - type of response
      Parameters:
      methodName - method name
      response - the response observer
      Returns:
      the request observer