vertx-grpc/vertx-grpc-transcoding/src/main/java/io/vertx/grpc/transcoding/TranscodingServiceMethod.java at 71c5440339c19a8c0fdd677b4058adb1a53a0b96 · eclipse-vertx/vertx-grpc · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
package io.vertx.grpc.transcoding;

import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.Unstable;
import io.vertx.grpc.common.GrpcMessageDecoder;
import io.vertx.grpc.common.GrpcMessageEncoder;
import io.vertx.grpc.common.ServiceMethod;
import io.vertx.grpc.common.ServiceName;
import io.vertx.grpc.transcoding.impl.TranscodingServiceMethodImpl;

@GenIgnore(GenIgnore.PERMITTED_TYPE)
@Unstable("Transcoding is in tech preview")
public interface TranscodingServiceMethod<I, O> extends ServiceMethod<I, O> {

  static <Req, Resp> TranscodingServiceMethod<Req, Resp> server(ServiceName serviceName,
                                                                String methodName,
                                                                GrpcMessageEncoder<Resp> encoder,
                                                                GrpcMessageDecoder<Req> decoder) {
    return new TranscodingServiceMethodImpl<>(serviceName, methodName, encoder, decoder);
  }

  static <Req, Resp> TranscodingServiceMethod<Req, Resp> server(ServiceName serviceName,
                                                                String methodName,
                                                                GrpcMessageEncoder<Resp> encoder,
                                                                GrpcMessageDecoder<Req> decoder,
                                                                MethodTranscodingOptions options) {
    return new TranscodingServiceMethodImpl<>(serviceName, methodName, encoder, decoder, options, false);
  }

  static <Req, Resp> TranscodingServiceMethod<Req, Resp> server(ServiceName serviceName,
                                                                String methodName,
                                                                GrpcMessageEncoder<Resp> encoder,
                                                                GrpcMessageDecoder<Req> decoder,
                                                                MethodTranscodingOptions options,
                                                                boolean streaming) {
    return new TranscodingServiceMethodImpl<>(serviceName, methodName, encoder, decoder, options, streaming);
  }

  static <Req, Resp> TranscodingServiceMethod<Req, Resp> server(ServiceMethod<Req, Resp> serviceMethod,
                                                                MethodTranscodingOptions options) {
    return server(serviceMethod.serviceName(), serviceMethod.methodName(), serviceMethod.encoder(), serviceMethod.decoder(), options);
  }

  MethodTranscodingOptions options();

  /**
   * @return whether the response side of the RPC is streaming (server-streaming or bidi). When {@code true} the
   * transcoder emits a JSON array of messages (one element per gRPC message) on the HTTP response, using chunked
   * transfer encoding instead of a single content-length-framed JSON object.
   */
  default boolean streaming() {
    return false;
  }

}