GrpcUtil (grpc-core 1.21.0 API)

java.lang.Object
- io.grpc.internal.GrpcUtil

public final class GrpcUtil
extends Object

Common utilities for GRPC.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GrpcUtil.Http2Error
All error codes identified by the HTTP/2 spec.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GrpcUtil.Http2Error` All error codes identified by the HTTP/2 spec.

Field Summary

Fields
Modifier and Type	Field and Description
`static com.google.common.base.Splitter`	`ACCEPT_ENCODING_SPLITTER`
`static io.grpc.CallOptions.Key<Boolean>`	`CALL_OPTIONS_RPC_OWNED_BY_BALANCER` RPCs created on the Channel returned by `LoadBalancer.Subchannel.asChannel()` will have this option with value `true`.
`static String`	`CONTENT_ACCEPT_ENCODING` The accepted content-encodings that can be used to compress the full gRPC stream.
`static io.grpc.Metadata.Key<byte[]>`	`CONTENT_ACCEPT_ENCODING_KEY` `Metadata.Key` for the stream's accepted content encoding header.
`static String`	`CONTENT_ENCODING` The content-encoding used to compress the full gRPC stream.
`static io.grpc.Metadata.Key<String>`	`CONTENT_ENCODING_KEY` `Metadata.Key` for the stream's content encoding header.
`static String`	`CONTENT_TYPE_GRPC` Content-Type used for GRPC-over-HTTP/2.
`static io.grpc.Metadata.Key<String>`	`CONTENT_TYPE_KEY` `Metadata.Key` for the Content-Type request/response header.
`static long`	`DEFAULT_KEEPALIVE_TIME_NANOS` The default delay in nanos before we send a keepalive.
`static long`	`DEFAULT_KEEPALIVE_TIMEOUT_NANOS` The default timeout in nanos for a keepalive ping request.
`static String`	`DEFAULT_LB_POLICY` The very default load-balancing policy.
`static int`	`DEFAULT_MAX_HEADER_LIST_SIZE` The default maximum size (in bytes) for inbound header/trailer.
`static int`	`DEFAULT_MAX_MESSAGE_SIZE` The default maximum uncompressed size (in bytes) for inbound messages.
`static int`	`DEFAULT_PORT_PLAINTEXT` The default port for plain-text connections.
`static int`	`DEFAULT_PORT_SSL` The default port for SSL connections.
`static io.grpc.ProxyDetector`	`DEFAULT_PROXY_DETECTOR` The default proxy detector.
`static long`	`DEFAULT_SERVER_KEEPALIVE_TIME_NANOS` The default delay in nanos for server keepalive.
`static long`	`DEFAULT_SERVER_KEEPALIVE_TIMEOUT_NANOS` The default timeout in nanos for a server keepalive ping request.
`static String`	`HTTP_METHOD` The HTTP method used for GRPC requests.
`static boolean`	`IS_RESTRICTED_APPENGINE`
`static long`	`KEEPALIVE_TIME_NANOS_DISABLED` The magic keepalive time value that disables client keepalive.
`static String`	`MESSAGE_ACCEPT_ENCODING` The accepted message encodings (i.e.
`static io.grpc.Metadata.Key<byte[]>`	`MESSAGE_ACCEPT_ENCODING_KEY` `Metadata.Key` for the accepted message encodings header.
`static String`	`MESSAGE_ENCODING` The message encoding (i.e.
`static io.grpc.Metadata.Key<String>`	`MESSAGE_ENCODING_KEY` `Metadata.Key` for the message encoding header.
`static io.grpc.ProxyDetector`	`NOOP_PROXY_DETECTOR` A proxy detector that always claims no proxy is needed.
`static long`	`SERVER_KEEPALIVE_TIME_NANOS_DISABLED` The magic keepalive time value that disables keepalive.
`static SharedResourceHolder.Resource<Executor>`	`SHARED_CHANNEL_EXECUTOR` Shared executor for channels.
`static com.google.common.base.Supplier<com.google.common.base.Stopwatch>`	`STOPWATCH_SUPPLIER` The factory of default Stopwatches.
`static io.grpc.Metadata.Key<String>`	`TE_HEADER` `Metadata.Key` for the Transfer encoding.
`static String`	`TE_TRAILERS` The TE (transport encoding) header for requests over HTTP/2.
`static String`	`TIMEOUT` The Timeout header name.
`static io.grpc.Metadata.Key<Long>`	`TIMEOUT_KEY` `Metadata.Key` for the timeout header.
`static SharedResourceHolder.Resource<ScheduledExecutorService>`	`TIMER_SERVICE` Shared single-threaded executor for managing channel timers.
`static Charset`	`US_ASCII`
`static io.grpc.Metadata.Key<String>`	`USER_AGENT_KEY` `Metadata.Key` for the Content-Type request/response header.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`authorityFromHostAndPort(String host, int port)` Combine a host and port into an authority string.
`static URI`	`authorityToUri(String authority)` Parse an authority into a URI for retrieving the host and port.
`static String`	`checkAuthority(String authority)` Verify `authority` is valid for use with gRPC.
`static void`	`closeQuietly(InputStream message)` Closes an InputStream, ignoring IOExceptions.
`static io.grpc.ProxyDetector`	`getDefaultProxyDetector()` Returns a proxy detector appropriate for the current environment.
`static String`	`getGrpcUserAgent(String transportName, String applicationUserAgent)` Gets the User-Agent string for the gRPC transport.
`static String`	`getHost(InetSocketAddress addr)` Returns the host via `InetSocketAddress.getHostString()` if it is possible, i.e.
`static ThreadFactory`	`getThreadFactory(String nameFormat, boolean daemon)` Get a `ThreadFactory` suitable for use in the current environment.
`static io.grpc.Status`	`httpStatusToGrpcStatus(int httpStatusCode)` Maps HTTP error response status codes to transport codes, as defined in http-grpc-status-mapping.md.
`static boolean`	`isGrpcContentType(String contentType)` Indicates whether or not the given value is a valid gRPC content-type.
`static boolean`	`shouldBeCountedForInUse(io.grpc.CallOptions callOptions)` Returns true if an RPC with the given properties should be counted when calculating the in-use state of a transport.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - US_ASCII
```
public static final Charset US_ASCII
```
  - IS_RESTRICTED_APPENGINE
```
public static final boolean IS_RESTRICTED_APPENGINE
```
  - TIMEOUT_KEY
```
public static final io.grpc.Metadata.Key<Long> TIMEOUT_KEY
```
    Metadata.Key for the timeout header.
  - MESSAGE_ENCODING_KEY
```
public static final io.grpc.Metadata.Key<String> MESSAGE_ENCODING_KEY
```
    Metadata.Key for the message encoding header.
  - MESSAGE_ACCEPT_ENCODING_KEY
```
public static final io.grpc.Metadata.Key<byte[]> MESSAGE_ACCEPT_ENCODING_KEY
```
    Metadata.Key for the accepted message encodings header.
  - CONTENT_ENCODING_KEY
```
public static final io.grpc.Metadata.Key<String> CONTENT_ENCODING_KEY
```
    Metadata.Key for the stream's content encoding header.
  - CONTENT_ACCEPT_ENCODING_KEY
```
public static final io.grpc.Metadata.Key<byte[]> CONTENT_ACCEPT_ENCODING_KEY
```
    Metadata.Key for the stream's accepted content encoding header.
  - CONTENT_TYPE_KEY
```
public static final io.grpc.Metadata.Key<String> CONTENT_TYPE_KEY
```
    Metadata.Key for the Content-Type request/response header.
  - TE_HEADER
```
public static final io.grpc.Metadata.Key<String> TE_HEADER
```
    Metadata.Key for the Transfer encoding.
  - USER_AGENT_KEY
```
public static final io.grpc.Metadata.Key<String> USER_AGENT_KEY
```
    Metadata.Key for the Content-Type request/response header.
  - DEFAULT_PORT_PLAINTEXT
```
public static final int DEFAULT_PORT_PLAINTEXT
```
    The default port for plain-text connections.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT_SSL
```
public static final int DEFAULT_PORT_SSL
```
    The default port for SSL connections.
    
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE_GRPC
```
public static final String CONTENT_TYPE_GRPC
```
    Content-Type used for GRPC-over-HTTP/2.
    
    See Also:
    
    Constant Field Values
  - HTTP_METHOD
```
public static final String HTTP_METHOD
```
    The HTTP method used for GRPC requests.
    
    See Also:
    
    Constant Field Values
  - TE_TRAILERS
```
public static final String TE_TRAILERS
```
    The TE (transport encoding) header for requests over HTTP/2.
    
    See Also:
    
    Constant Field Values
  - TIMEOUT
```
public static final String TIMEOUT
```
    The Timeout header name.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_ENCODING
```
public static final String MESSAGE_ENCODING
```
    The message encoding (i.e. compression) that can be used in the stream.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_ACCEPT_ENCODING
```
public static final String MESSAGE_ACCEPT_ENCODING
```
    The accepted message encodings (i.e. compression) that can be used in the stream.
    
    See Also:
    
    Constant Field Values
  - CONTENT_ENCODING
```
public static final String CONTENT_ENCODING
```
    The content-encoding used to compress the full gRPC stream.
    
    See Also:
    
    Constant Field Values
  - CONTENT_ACCEPT_ENCODING
```
public static final String CONTENT_ACCEPT_ENCODING
```
    The accepted content-encodings that can be used to compress the full gRPC stream.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_MESSAGE_SIZE
```
public static final int DEFAULT_MAX_MESSAGE_SIZE
```
    The default maximum uncompressed size (in bytes) for inbound messages. Defaults to 4 MiB.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_HEADER_LIST_SIZE
```
public static final int DEFAULT_MAX_HEADER_LIST_SIZE
```
    The default maximum size (in bytes) for inbound header/trailer.
    
    See Also:
    
    Constant Field Values
  - ACCEPT_ENCODING_SPLITTER
```
public static final com.google.common.base.Splitter ACCEPT_ENCODING_SPLITTER
```
  - DEFAULT_KEEPALIVE_TIME_NANOS
```
public static final long DEFAULT_KEEPALIVE_TIME_NANOS
```
    The default delay in nanos before we send a keepalive.
  - DEFAULT_KEEPALIVE_TIMEOUT_NANOS
```
public static final long DEFAULT_KEEPALIVE_TIMEOUT_NANOS
```
    The default timeout in nanos for a keepalive ping request.
  - KEEPALIVE_TIME_NANOS_DISABLED
```
public static final long KEEPALIVE_TIME_NANOS_DISABLED
```
    The magic keepalive time value that disables client keepalive.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SERVER_KEEPALIVE_TIME_NANOS
```
public static final long DEFAULT_SERVER_KEEPALIVE_TIME_NANOS
```
    The default delay in nanos for server keepalive.
  - DEFAULT_SERVER_KEEPALIVE_TIMEOUT_NANOS
```
public static final long DEFAULT_SERVER_KEEPALIVE_TIMEOUT_NANOS
```
    The default timeout in nanos for a server keepalive ping request.
  - SERVER_KEEPALIVE_TIME_NANOS_DISABLED
```
public static final long SERVER_KEEPALIVE_TIME_NANOS_DISABLED
```
    The magic keepalive time value that disables keepalive.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PROXY_DETECTOR
```
public static final io.grpc.ProxyDetector DEFAULT_PROXY_DETECTOR
```
    The default proxy detector.
  - NOOP_PROXY_DETECTOR
```
public static final io.grpc.ProxyDetector NOOP_PROXY_DETECTOR
```
    A proxy detector that always claims no proxy is needed.
  - DEFAULT_LB_POLICY
```
public static final String DEFAULT_LB_POLICY
```
    The very default load-balancing policy.
    
    See Also:
    
    Constant Field Values
  - CALL_OPTIONS_RPC_OWNED_BY_BALANCER
```
public static final io.grpc.CallOptions.Key<Boolean> CALL_OPTIONS_RPC_OWNED_BY_BALANCER
```
    RPCs created on the Channel returned by LoadBalancer.Subchannel.asChannel() will have this option with value true. They will be treated differently from the ones created by application.
  - SHARED_CHANNEL_EXECUTOR
```
public static final SharedResourceHolder.Resource<Executor> SHARED_CHANNEL_EXECUTOR
```
    Shared executor for channels.
  - TIMER_SERVICE
```
public static final SharedResourceHolder.Resource<ScheduledExecutorService> TIMER_SERVICE
```
    Shared single-threaded executor for managing channel timers.
  - STOPWATCH_SUPPLIER
```
public static final com.google.common.base.Supplier<com.google.common.base.Stopwatch> STOPWATCH_SUPPLIER
```
    The factory of default Stopwatches.
- Method Detail
  - shouldBeCountedForInUse
```
public static boolean shouldBeCountedForInUse(io.grpc.CallOptions callOptions)
```
    Returns true if an RPC with the given properties should be counted when calculating the in-use state of a transport.
  - getDefaultProxyDetector
```
public static io.grpc.ProxyDetector getDefaultProxyDetector()
```
    Returns a proxy detector appropriate for the current environment.
  - httpStatusToGrpcStatus
```
public static io.grpc.Status httpStatusToGrpcStatus(int httpStatusCode)
```
    Maps HTTP error response status codes to transport codes, as defined in http-grpc-status-mapping.md. Never returns a status for which status.isOk() is true.
  - isGrpcContentType
```
public static boolean isGrpcContentType(String contentType)
```
    Indicates whether or not the given value is a valid gRPC content-type.
  - getGrpcUserAgent
```
public static String getGrpcUserAgent(String transportName,
                                      @Nullable
                                      String applicationUserAgent)
```
    Gets the User-Agent string for the gRPC transport.
  - authorityToUri
```
public static URI authorityToUri(String authority)
```
    Parse an authority into a URI for retrieving the host and port.
  - checkAuthority
```
public static String checkAuthority(String authority)
```
    Verify authority is valid for use with gRPC. The syntax must be valid and it must not include userinfo.
    
    Returns:
    
    the authority provided
  - authorityFromHostAndPort
```
public static String authorityFromHostAndPort(String host,
                                              int port)
```
    Combine a host and port into an authority string.
  - getThreadFactory
```
public static ThreadFactory getThreadFactory(String nameFormat,
                                             boolean daemon)
```
    Get a ThreadFactory suitable for use in the current environment.
    
    Parameters:
    
    nameFormat - to apply to threads created by the factory.
    
    daemon - true if the threads the factory creates are daemon threads, false otherwise.
    
    Returns:
    
    a ThreadFactory.
  - getHost
```
public static String getHost(InetSocketAddress addr)
```
    Returns the host via InetSocketAddress.getHostString() if it is possible, i.e. in jdk >= 7. Otherwise, return it via InetSocketAddress.getHostName() which may incur a DNS lookup.
  - closeQuietly
```
public static void closeQuietly(@Nullable
                                InputStream message)
```
    Closes an InputStream, ignoring IOExceptions. This method exists because Guava's Closeables.closeQuietly() is beta.

Class GrpcUtil

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

US_ASCII

IS_RESTRICTED_APPENGINE

TIMEOUT_KEY

MESSAGE_ENCODING_KEY

MESSAGE_ACCEPT_ENCODING_KEY

CONTENT_ENCODING_KEY

CONTENT_ACCEPT_ENCODING_KEY

CONTENT_TYPE_KEY

TE_HEADER

USER_AGENT_KEY

DEFAULT_PORT_PLAINTEXT

DEFAULT_PORT_SSL

CONTENT_TYPE_GRPC

HTTP_METHOD

TE_TRAILERS

TIMEOUT

MESSAGE_ENCODING

MESSAGE_ACCEPT_ENCODING

CONTENT_ENCODING

CONTENT_ACCEPT_ENCODING

DEFAULT_MAX_MESSAGE_SIZE

DEFAULT_MAX_HEADER_LIST_SIZE

ACCEPT_ENCODING_SPLITTER

DEFAULT_KEEPALIVE_TIME_NANOS

DEFAULT_KEEPALIVE_TIMEOUT_NANOS

KEEPALIVE_TIME_NANOS_DISABLED

DEFAULT_SERVER_KEEPALIVE_TIME_NANOS

DEFAULT_SERVER_KEEPALIVE_TIMEOUT_NANOS

SERVER_KEEPALIVE_TIME_NANOS_DISABLED

DEFAULT_PROXY_DETECTOR

NOOP_PROXY_DETECTOR

DEFAULT_LB_POLICY

CALL_OPTIONS_RPC_OWNED_BY_BALANCER

SHARED_CHANNEL_EXECUTOR

TIMER_SERVICE

STOPWATCH_SUPPLIER

Method Detail

shouldBeCountedForInUse

getDefaultProxyDetector

httpStatusToGrpcStatus

isGrpcContentType

getGrpcUserAgent

authorityToUri

checkAuthority

authorityFromHostAndPort

getThreadFactory

getHost

closeQuietly