Package com.linecorp.armeria.common.grpc

Interface GrpcJsonMarshaller

public interface GrpcJsonMarshaller

A JSON marshaller for gRPC method request or response messages to and from JSON.

See Also:

• GrpcServiceBuilder.jsonMarshallerFactory(Function)
• GrpcClientBuilder.jsonMarshallerFactory(Function)

Method Summary

Modifier and Type	Method	Description
static GrpcJsonMarshallerBuilder	builder()	Returns a new GrpcJsonMarshallerBuilder.
static GsonGrpcJsonMarshallerBuilder	builderForGson()	Returns a new GsonGrpcJsonMarshallerBuilder.
<T> T	deserializeMessage(io.grpc.MethodDescriptor.Marshaller<T> marshaller, InputStream is)	Deserializes a gRPC message from JSON.
static GrpcJsonMarshaller	of(io.grpc.ServiceDescriptor serviceDescriptor)	Returns a newly-created GrpcJsonMarshaller which serializes and deserializes a Message served by the service.
static GrpcJsonMarshaller	ofGson()	Returns a newly-created GrpcJsonMarshaller which serializes and deserializes a Message.
<T> void	serializeMessage(io.grpc.MethodDescriptor.Marshaller<T> marshaller, T message, OutputStream os)	Serializes a gRPC message into JSON.

Method Details

of

static GrpcJsonMarshaller of(io.grpc.ServiceDescriptor serviceDescriptor)

Returns a newly-created GrpcJsonMarshaller which serializes and deserializes a Message served by the service. This implementation internally uses protobuf-jackson to serialize and deserialize messages.

builder

static GrpcJsonMarshallerBuilder builder()

Returns a new GrpcJsonMarshallerBuilder. This implementation internally uses protobuf-jackson to serialize and deserialize messages.

ofGson

static GrpcJsonMarshaller ofGson()

Returns a newly-created GrpcJsonMarshaller which serializes and deserializes a Message. This implementation internally uses JsonFormat and Gson to serialize and deserialize messages. Note: JsonFormat has a known performance issue. Use this method only when 1) you're using Protobuf 2 or 2) you have an issue with protobuf-jackson.

builderForGson

static GsonGrpcJsonMarshallerBuilder builderForGson()

Returns a new GsonGrpcJsonMarshallerBuilder. This implementation internally uses JsonFormat and Gson to serialize and deserialize messages. Note: JsonFormat has a known performance issue. Use this method only when 1) you're using Protobuf 2 or 2) you have an issue with protobuf-jackson.

serializeMessage

<T> void serializeMessage(io.grpc.MethodDescriptor.Marshaller<T> marshaller,
 T message,
 OutputStream os)
                   throws IOException

Serializes a gRPC message into JSON.

Throws:

IOException

deserializeMessage

<T> T deserializeMessage(io.grpc.MethodDescriptor.Marshaller<T> marshaller,
 InputStream is)
                  throws IOException

Deserializes a gRPC message from JSON.

Throws:

IOException