GrpcChannelKey (Alluxio Parent 2.1.3-SNAPSHOT API)

java.lang.Object
- alluxio.grpc.GrpcChannelKey

public class GrpcChannelKey
extends Object

Used to identify a unique GrpcChannel.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`GrpcChannelKey.IdentityField`
`static class`	`GrpcChannelKey.PoolingStrategy` Enumeration to determine the pooling strategy.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GrpcChannelKey`	`create(AlluxioConfiguration conf)` Creates a `GrpcChannelKey`.
`boolean`	`equals(Object other)`
`UUID`	`getChannelId()`
`Optional<String>`	`getChannelName()`
`Optional<Class<? extends io.netty.channel.Channel>>`	`getChannelType()`
`Optional<io.netty.channel.EventLoopGroup>`	`getEventLoopGroup()`
`Optional<Integer>`	`getFlowControlWindow()`
`Optional<Pair<Long,TimeUnit>>`	`getKeepAliveTime()`
`Optional<Pair<Long,TimeUnit>>`	`getKeepAliveTimeout()`
`Optional<Integer>`	`getMaxInboundMessageSize()`
`GrpcServerAddress`	`getServerAddress()`
`int`	`hashCode()`
`GrpcChannelKey`	`setChannelType(Class<? extends io.netty.channel.Channel> channelType)`
`GrpcChannelKey`	`setClientType(String clientType)` Sets human readable name for the channel's client.
`GrpcChannelKey`	`setEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)`
`GrpcChannelKey`	`setFlowControlWindow(int flowControlWindow)`
`GrpcChannelKey`	`setKeepAliveTime(long keepAliveTime, TimeUnit timeUnit)`
`GrpcChannelKey`	`setKeepAliveTimeout(long keepAliveTimeout, TimeUnit timeUnit)`
`GrpcChannelKey`	`setMaxInboundMessageSize(int maxInboundMessageSize)`
`GrpcChannelKey`	`setPoolingStrategy(GrpcChannelKey.PoolingStrategy strategy)`
`GrpcChannelKey`	`setServerAddress(GrpcServerAddress address)`
`String`	`toString()`
`String`	`toStringShort()`

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

- Method Detail
  - create
```
public static GrpcChannelKey create(AlluxioConfiguration conf)
```
    Creates a GrpcChannelKey.
    
    Parameters:
    
    conf - the Alluxio configuration
    
    Returns:
    
    the created instance
  - getChannelId
```
public UUID getChannelId()
```
    Returns:
    
    unique identifier for the channel
  - getServerAddress
```
public GrpcServerAddress getServerAddress()
```
    Returns:
    
    destination address of the channel
  - setServerAddress
```
public GrpcChannelKey setServerAddress(GrpcServerAddress address)
```
    Parameters:
    
    address - destination address of the channel
    
    Returns:
    
    the modified GrpcChannelKey
  - getMaxInboundMessageSize
```
public Optional<Integer> getMaxInboundMessageSize()
```
    Returns:
    
    max inbound message size for the underlying channel
  - setMaxInboundMessageSize
```
public GrpcChannelKey setMaxInboundMessageSize(int maxInboundMessageSize)
```
    Parameters:
    
    maxInboundMessageSize - max inbound message size for the underlying channel
    
    Returns:
    
    the modified GrpcChannelKey
  - getFlowControlWindow
```
public Optional<Integer> getFlowControlWindow()
```
    Returns:
    
    flow control window value for the underlying channel
  - setFlowControlWindow
```
public GrpcChannelKey setFlowControlWindow(int flowControlWindow)
```
    Parameters:
    
    flowControlWindow - flow control window value for the underlying channel
    
    Returns:
    
    the modified GrpcChannelKey
  - getChannelType
```
public Optional<Class<? extends io.netty.channel.Channel>> getChannelType()
```
    Returns:
    
    channel type for the underlying channel
  - setChannelType
```
public GrpcChannelKey setChannelType(Class<? extends io.netty.channel.Channel> channelType)
```
    Parameters:
    
    channelType - channel type for the underlying channel
    
    Returns:
    
    the modified GrpcChannelKey
  - getEventLoopGroup
```
public Optional<io.netty.channel.EventLoopGroup> getEventLoopGroup()
```
    Returns:
    
    event loop group for the underlying channel
  - setEventLoopGroup
```
public GrpcChannelKey setEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)
```
    Parameters:
    
    eventLoopGroup - event loop group for the underlying channel
    
    Returns:
    
    the modified GrpcChannelKey
  - getChannelName
```
public Optional<String> getChannelName()
```
    Returns:
    
    human readable name for the channel
  - setClientType
```
public GrpcChannelKey setClientType(String clientType)
```
    Sets human readable name for the channel's client.
    
    Parameters:
    
    clientType - channel client type
    
    Returns:
    
    the modified GrpcChannelKey
  - getKeepAliveTime
```
public Optional<Pair<Long,TimeUnit>> getKeepAliveTime()
```
    Returns:
    
    keep alive time for the underlying channel
  - setKeepAliveTime
```
public GrpcChannelKey setKeepAliveTime(long keepAliveTime,
                                       TimeUnit timeUnit)
```
    Parameters:
    
    keepAliveTime - keep alive time for the underlying channel
    
    timeUnit - time unit for the keepAliveTime parameter
    
    Returns:
    
    the modified GrpcChannelKey
  - getKeepAliveTimeout
```
public Optional<Pair<Long,TimeUnit>> getKeepAliveTimeout()
```
    Returns:
    
    keep alive timeout for the underlying channel
  - setKeepAliveTimeout
```
public GrpcChannelKey setKeepAliveTimeout(long keepAliveTimeout,
                                          TimeUnit timeUnit)
```
    Parameters:
    
    keepAliveTimeout - keep alive timeout for the underlying channel
    
    timeUnit - time unit for the keepAliveTimeout parameter
    
    Returns:
    
    the modified GrpcChannelKey
  - setPoolingStrategy
```
public GrpcChannelKey setPoolingStrategy(GrpcChannelKey.PoolingStrategy strategy)
```
    Parameters:
    
    strategy - the pooling strategy
    
    Returns:
    
    the modified GrpcChannelKey
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toStringShort
```
public String toStringShort()
```
    Returns:
    
    short representation of this channel key

Class GrpcChannelKey

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

getChannelId

getServerAddress

setServerAddress

getMaxInboundMessageSize

setMaxInboundMessageSize

getFlowControlWindow

setFlowControlWindow

getChannelType

setChannelType

getEventLoopGroup

setEventLoopGroup

getChannelName

setClientType

getKeepAliveTime

setKeepAliveTime

getKeepAliveTimeout

setKeepAliveTimeout

setPoolingStrategy

hashCode

equals

toString

toStringShort