io.grpc

Class LoadBalancer2.Subchannel

java.lang.Object

io.grpc.LoadBalancer2.Subchannel

Enclosing class:

LoadBalancer2

@ThreadSafe
public abstract static class LoadBalancer2.Subchannel
extends Object

A logical connection to a server, or a group of equivalent servers represented by an EquivalentAddressGroup.

It maintains at most one physical connection (aka transport) for sending new RPCs, while also keeps track of previous transports that has been shut down but not terminated yet.

If there isn't an active transport yet, and an RPC is assigned to the Subchannel, it will create a new transport. It won't actively create transports otherwise. requestConnection() can be used to ask Subchannel to create a transport if there isn't any.

Constructor Summary

Constructors

Constructor and Description
Subchannel()

Method Summary

Modifier and Type	Method and Description
abstract EquivalentAddressGroup	getAddresses() Returns the addresses that this Subchannel is bound to.
abstract Attributes	getAttributes() The same attributes passed to Helper.createSubchannel().
abstract void	requestConnection() Asks the Subchannel to create a connection (aka transport), if there isn't an active one.
abstract void	shutdown() Shuts down the Subchannel.

Methods inherited from class java.lang.Object

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

Constructor Detail

Subchannel

public Subchannel()

Method Detail

shutdown

public abstract void shutdown()

Shuts down the Subchannel. After this method is called, this Subchannel should no longer be returned by the latest picker, and can be safely discarded.

requestConnection

public abstract void requestConnection()

Asks the Subchannel to create a connection (aka transport), if there isn't an active one.

getAddresses

public abstract EquivalentAddressGroup getAddresses()

Returns the addresses that this Subchannel is bound to.

getAttributes

public abstract Attributes getAttributes()

The same attributes passed to Helper.createSubchannel(). LoadBalancer can use it to attach additional information here, e.g., the shard this Subchannel belongs to.