Package io.grpc.okhttp

Class OkHttpChannelProvider

java.lang.Object

io.grpc.ManagedChannelProvider

io.grpc.okhttp.OkHttpChannelProvider

@Internal
public final class OkHttpChannelProvider
extends ManagedChannelProvider

Provider for OkHttpChannelBuilder instances.

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.ManagedChannelProvider

ManagedChannelProvider.NewChannelBuilderResult, ManagedChannelProvider.ProviderNotFoundException

Constructor Summary

Constructors

Constructor	Description
OkHttpChannelProvider()

Method Summary

Modifier and Type	Method	Description
OkHttpChannelBuilder	builderForAddress(java.lang.String name, int port)	Creates a new builder with the given host and port.
OkHttpChannelBuilder	builderForTarget(java.lang.String target)	Creates a new builder with the given target URI.
protected java.util.Collection<java.lang.Class<? extends java.net.SocketAddress>>	getSupportedSocketAddressTypes()	Returns the SocketAddress types this ManagedChannelProvider supports.
boolean	isAvailable()	Whether this provider is available for use, taking the current environment into consideration.
ManagedChannelProvider.NewChannelBuilderResult	newChannelBuilder(java.lang.String target, ChannelCredentials creds)	Creates a new builder with the given target URI and credentials.
int	priority()	A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration.

Methods inherited from class io.grpc.ManagedChannelProvider

provider

Methods inherited from class java.lang.Object

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

Constructor Detail

OkHttpChannelProvider

public OkHttpChannelProvider()

Method Detail

isAvailable

public boolean isAvailable()

Description copied from class: ManagedChannelProvider

Whether this provider is available for use, taking the current environment into consideration. If false, no other methods are safe to be called.

Specified by:

isAvailable in class ManagedChannelProvider

priority

public int priority()

Description copied from class: ManagedChannelProvider

A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration. 5 should be considered the default, and then tweaked based on environment detection. A priority of 0 does not imply that the provider wouldn't work; just that it should be last in line.

Specified by:

priority in class ManagedChannelProvider

builderForAddress

public OkHttpChannelBuilder builderForAddress(java.lang.String name,
                                              int port)

Description copied from class: ManagedChannelProvider

Creates a new builder with the given host and port.

Specified by:

builderForAddress in class ManagedChannelProvider

builderForTarget

public OkHttpChannelBuilder builderForTarget(java.lang.String target)

Description copied from class: ManagedChannelProvider

Creates a new builder with the given target URI.

Specified by:

builderForTarget in class ManagedChannelProvider

newChannelBuilder

public ManagedChannelProvider.NewChannelBuilderResult newChannelBuilder(java.lang.String target,
                                                                        ChannelCredentials creds)

Description copied from class: ManagedChannelProvider

Creates a new builder with the given target URI and credentials. Returns an error-string result if unable to understand the credentials.

Overrides:

newChannelBuilder in class ManagedChannelProvider

getSupportedSocketAddressTypes

protected java.util.Collection<java.lang.Class<? extends java.net.SocketAddress>> getSupportedSocketAddressTypes()

Description copied from class: ManagedChannelProvider

Returns the SocketAddress types this ManagedChannelProvider supports.

Specified by:

getSupportedSocketAddressTypes in class ManagedChannelProvider