io.servicetalk.grpc.api

Class GrpcClientFactory<Client extends GrpcClient<BlockingClient>,BlockingClient extends BlockingGrpcClient<Client>>

Object

GrpcClientFactory<Client,BlockingClient>

Type Parameters:

Client - gRPC service that any client built from this factory represents.

BlockingClient - Blocking gRPC service that any client built from this builder represents.

public abstract class GrpcClientFactory<Client extends GrpcClient<BlockingClient>,BlockingClient extends BlockingGrpcClient<Client>>
extends Object

A factory for creating clients that follows the specified gRPC Client contract.

Constructor Summary

Constructors

Constructor and Description
GrpcClientFactory()

Method Summary

Modifier and Type	Method and Description
protected BufferDecoderGroup	bufferDecoderGroup() Get the supported BufferDecoderGroup for this client factory.
GrpcClientFactory<Client,BlockingClient>	bufferDecoderGroup(BufferDecoderGroup bufferDecoderGroup) Sets the supported BufferDecoderGroup for this client factory.
protected abstract BlockingClient	newBlockingClient(GrpcClientCallFactory clientCallFactory) Create a new client that follows the specified gRPC BlockingClient contract using the passed GrpcClientCallFactory.
BlockingClient	newBlockingClientForCallFactory(GrpcClientCallFactory clientCallFactory) Create a new client that follows the specified gRPC BlockingClient contract using the passed GrpcClientCallFactory.
protected abstract Client	newClient(GrpcClientCallFactory clientCallFactory) Create a new client that follows the specified gRPC Client contract using the passed GrpcClientCallFactory.
Client	newClientForCallFactory(GrpcClientCallFactory clientCallFactory) Create a new client that follows the specified gRPC Client contract using the passed GrpcClientCallFactory.
protected List<ContentCodec>	supportedMessageCodings() Deprecated. Use generated code methods targeting List of BufferEncoders and BufferDecoderGroup.
GrpcClientFactory<Client,BlockingClient>	supportedMessageCodings(List<ContentCodec> codings) Deprecated. Use generated code methods targeting List of BufferEncoders and BufferDecoderGroup.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GrpcClientFactory

public GrpcClientFactory()

Method Detail

newClientForCallFactory

public final Client newClientForCallFactory(GrpcClientCallFactory clientCallFactory)

Create a new client that follows the specified gRPC Client contract using the passed GrpcClientCallFactory.

Parameters:

clientCallFactory - GrpcClientCallFactory to use for creating client calls. The returned Client should own the lifecycle of this factory.

Returns:

A new gRPC client following the specified gRPC Client contract.

newBlockingClientForCallFactory

public final BlockingClient newBlockingClientForCallFactory(GrpcClientCallFactory clientCallFactory)

Create a new client that follows the specified gRPC BlockingClient contract using the passed GrpcClientCallFactory.

Parameters:

clientCallFactory - GrpcClientCallFactory to use for creating client calls. The returned Client should own the lifecycle of this factory.

Returns:

A new gRPC client following the specified gRPC BlockingClient contract.

supportedMessageCodings

@Deprecated
public GrpcClientFactory<Client,BlockingClient> supportedMessageCodings(List<ContentCodec> codings)

Deprecated. Use generated code methods targeting List of BufferEncoders and BufferDecoderGroup.

Sets the supported message encodings for this client factory. By default only Identity.identity() is supported

Parameters:

codings - The supported encodings ContentCodecs for this client.

Returns:

this

supportedMessageCodings

@Deprecated
protected List<ContentCodec> supportedMessageCodings()

Deprecated. Use generated code methods targeting List of BufferEncoders and BufferDecoderGroup.

Return the supported ContentCodecs for this client factory.

Returns:

the supported ContentCodecs for this client factory.

bufferDecoderGroup

public GrpcClientFactory<Client,BlockingClient> bufferDecoderGroup(BufferDecoderGroup bufferDecoderGroup)

Sets the supported BufferDecoderGroup for this client factory. By default only Identity.identityEncoder() is supported BufferDecoderGroup.

Parameters:

bufferDecoderGroup - The supported BufferDecoderGroup for this client.

Returns:

this

bufferDecoderGroup

protected BufferDecoderGroup bufferDecoderGroup()

Get the supported BufferDecoderGroup for this client factory.

Returns:

the supported BufferDecoderGroup for this client factory.

newClient

protected abstract Client newClient(GrpcClientCallFactory clientCallFactory)

Create a new client that follows the specified gRPC Client contract using the passed GrpcClientCallFactory.

Parameters:

clientCallFactory - GrpcClientCallFactory to use for creating client calls. The returned Client should own the lifecycle of this factory.

Returns:

A new gRPC client following the specified gRPC Client contract.

newBlockingClient

protected abstract BlockingClient newBlockingClient(GrpcClientCallFactory clientCallFactory)

Create a new client that follows the specified gRPC BlockingClient contract using the passed GrpcClientCallFactory.

Parameters:

clientCallFactory - GrpcClientCallFactory to use for creating client calls. The returned Client should own the lifecycle of this factory.

Returns:

A new gRPC client following the specified gRPC BlockingClient contract.