io.grpc:grpc-api 1.60.1 · io.grpc.Grpc

Modifier and Type	Class and Description
public static @interface	Grpc.TransportAttr Annotation for transport attributes.

Modifier and Type	Field and Description
public static final Attributes.Key<SocketAddress>	TRANSPORT_ATTR_LOCAL_ADDR Attribute key for the local address of a transport.
public static final Attributes.Key<SocketAddress>	TRANSPORT_ATTR_REMOTE_ADDR Attribute key for the remote address of a transport.
public static final Attributes.Key<SSLSession>	TRANSPORT_ATTR_SSL_SESSION Attribute key for SSL session of a transport.

Access	Constructor and Description
private	Grpc()

Method Summary

Modifier and Type	Method and Description
private static String	authorityFromHostAndPort(String host, int port) Combine a host and port into an authority string.
public static ManagedChannelBuilder<?>	newChannelBuilder(String target, ChannelCredentials creds) Creates a channel builder with a target string and credentials.
public static ManagedChannelBuilder<?>	newChannelBuilderForAddress(String host, int port, ChannelCredentials creds) Creates a channel builder from a host, port, and credentials.
public static ServerBuilder<?>	newServerBuilderForPort(int the port to listen on port, ServerCredentials the server identity creds) Static factory for creating a new ServerBuilder.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

TRANSPORT_ATTR_LOCAL_ADDR	back to summary
public static final Attributes.Key<SocketAddress> TRANSPORT_ATTR_LOCAL_ADDR Attribute key for the local address of a transport. Annotations @ExperimentalApi:https://github.com/grpc/grpc-java/issues/1710 @TransportAttr

TRANSPORT_ATTR_REMOTE_ADDR	back to summary
public static final Attributes.Key<SocketAddress> TRANSPORT_ATTR_REMOTE_ADDR Attribute key for the remote address of a transport. Annotations @ExperimentalApi:https://github.com/grpc/grpc-java/issues/1710 @TransportAttr

TRANSPORT_ATTR_SSL_SESSION	back to summary
public static final Attributes.Key<SSLSession> TRANSPORT_ATTR_SSL_SESSION Attribute key for SSL session of a transport. Annotations @ExperimentalApi:https://github.com/grpc/grpc-java/issues/1710 @TransportAttr

Constructor Detail

Grpc	back to summary
private Grpc()

Method Detail

authorityFromHostAndPort	back to summary
private static String authorityFromHostAndPort(String host, int port) Combine a host and port into an authority string.

newChannelBuilder back to summary

newChannelBuilder	back to summary
public static ManagedChannelBuilder<?> newChannelBuilder(String target, ChannelCredentials creds) Creates a channel builder with a target string and credentials. The target can be either a valid `NameResolver`-compliant URI, or an authority string. A `NameResolver`-compliant URI is an absolute hierarchical URI as defined by `java.net.URI`. Example URIs: `"dns:///foo.googleapis.com:8080"` `"dns:///foo.googleapis.com"` `"dns:///%5B2001:db8:85a3:8d3:1319:8a2e:370:7348%5D:443"` `"dns://8.8.8.8/foo.googleapis.com:8080"` `"dns://8.8.8.8/foo.googleapis.com"` `"zookeeper://zk.example.com:9900/example_service"` An authority string will be converted to a `NameResolver`-compliant URI, which has the scheme from the name resolver with the highest priority (e.g. `"dns"`), no authority, and the original authority string as its path after properly escaped. We recommend libraries to specify the schema explicitly if it is known, since libraries cannot know which NameResolver will be default during runtime. Example authority strings: `"localhost"` `"127.0.0.1"` `"localhost:8080"` `"foo.googleapis.com:8080"` `"127.0.0.1:8080"` `"[2001:db8:85a3:8d3:1319:8a2e:370:7348]"` `"[2001:db8:85a3:8d3:1319:8a2e:370:7348]:443"`

public static ManagedChannelBuilder<?> newChannelBuilder(String target, ChannelCredentials creds)

Creates a channel builder with a target string and credentials. The target can be either a valid NameResolver-compliant URI, or an authority string.

A NameResolver-compliant URI is an absolute hierarchical URI as defined by java.net.URI. Example URIs:

"dns:///foo.googleapis.com:8080"
"dns:///foo.googleapis.com"
"dns:///%5B2001:db8:85a3:8d3:1319:8a2e:370:7348%5D:443"
"dns://8.8.8.8/foo.googleapis.com:8080"
"dns://8.8.8.8/foo.googleapis.com"
"zookeeper://zk.example.com:9900/example_service"

An authority string will be converted to a NameResolver-compliant URI, which has the scheme from the name resolver with the highest priority (e.g. "dns"), no authority, and the original authority string as its path after properly escaped. We recommend libraries to specify the schema explicitly if it is known, since libraries cannot know which NameResolver will be default during runtime. Example authority strings:

"localhost"
"127.0.0.1"
"localhost:8080"
"foo.googleapis.com:8080"
"127.0.0.1:8080"
"[2001:db8:85a3:8d3:1319:8a2e:370:7348]"
"[2001:db8:85a3:8d3:1319:8a2e:370:7348]:443"

newChannelBuilderForAddress	back to summary
public static ManagedChannelBuilder<?> newChannelBuilderForAddress(String host, int port, ChannelCredentials creds) Creates a channel builder from a host, port, and credentials. The host and port are combined to form an authority string and then passed to `newChannelBuilder(String, ChannelCredentials)`. IPv6 addresses are properly surrounded by square brackets ("[]").

newServerBuilderForPort	back to summary
public static ServerBuilder<?> newServerBuilderForPort(int port, ServerCredentials creds) Static factory for creating a new ServerBuilder. Parameters port:int the port to listen on creds:ServerCredentials the server identity

newServerBuilderForPort

back to summary

public static ServerBuilder<?> newServerBuilderForPort(int port, ServerCredentials creds)

Static factory for creating a new ServerBuilder.

Parameters

port:int: the port to listen on
creds:ServerCredentials: the server identity

public final Class Grpc

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public @Interface Grpc.TransportAttr

Method Summary