Package org.apache.storm.messaging.netty
Class Client
- java.lang.Object
-
- org.apache.storm.messaging.ConnectionWithStatus
-
- org.apache.storm.messaging.netty.Client
-
- All Implemented Interfaces:
AutoCloseable,IConnection,ISaslClient
public class Client extends ConnectionWithStatus implements ISaslClient
A Netty client for sending task messages to a remote destination (Netty server).Implementation details:
Sending messages, i.e. writing to the channel, is performed asynchronously. Messages are sent in batches to optimize for network throughput at the expense of network latency. The message batch size is configurable. Connecting and reconnecting are performed asynchronously. Note: The current implementation drops any messages that are being enqueued for sending if the connection to the remote destination is currently unavailable.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.storm.messaging.ConnectionWithStatus
ConnectionWithStatus.Status
-
-
Field Summary
Fields Modifier and Type Field Description protected StringdstAddressPrefixedName
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidchannelReady(org.apache.storm.shade.io.netty.channel.Channel channel)voidclose()Gracefully close this client.Map<String,Object>getConfig()InetSocketAddressgetDstAddress()Map<Integer,Load>getLoad(Collection<Integer> tasks)Get the current load for the given tasks.intgetPort()Get the port for this connection.Stringname()StringsecretKey()voidsend(Iterator<TaskMessage> msgs)Enqueue task messages to be sent to the remote destination (cf.voidsendBackPressureStatus(BackPressureStatus bpStatus)Sends the back pressure metrics to all downstream connections.voidsendLoadMetrics(Map<Integer,Double> taskToLoad)Send load metrics to all downstream connections.ConnectionWithStatus.Statusstatus()Note: Storm will check via this method whether a worker can be activated safely during the initial startup of a topology.StringtoString()
-
-
-
Field Detail
-
dstAddressPrefixedName
protected final String dstAddressPrefixedName
-
-
Method Detail
-
status
public ConnectionWithStatus.Status status()
Note: Storm will check via this method whether a worker can be activated safely during the initial startup of a topology. The worker will only be activated once all of the its connections are ready.- Specified by:
statusin classConnectionWithStatus
-
sendLoadMetrics
public void sendLoadMetrics(Map<Integer,Double> taskToLoad)
Description copied from interface:IConnectionSend load metrics to all downstream connections.- Specified by:
sendLoadMetricsin interfaceIConnection- Parameters:
taskToLoad- a map from the task id to the load for that task.
-
sendBackPressureStatus
public void sendBackPressureStatus(BackPressureStatus bpStatus)
Description copied from interface:IConnectionSends the back pressure metrics to all downstream connections.- Specified by:
sendBackPressureStatusin interfaceIConnection
-
send
public void send(Iterator<TaskMessage> msgs)
Enqueue task messages to be sent to the remote destination (cf. `host` and `port`).- Specified by:
sendin interfaceIConnection
-
getDstAddress
public InetSocketAddress getDstAddress()
-
getPort
public int getPort()
Description copied from interface:IConnectionGet the port for this connection.- Specified by:
getPortin interfaceIConnection- Returns:
- The port this connection is using
-
close
public void close()
Gracefully close this client.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceIConnection
-
getLoad
public Map<Integer,Load> getLoad(Collection<Integer> tasks)
Description copied from interface:IConnectionGet the current load for the given tasks.- Specified by:
getLoadin interfaceIConnection- Parameters:
tasks- the tasks to look for.- Returns:
- a Load for each of the tasks it knows about.
-
channelReady
public void channelReady(org.apache.storm.shade.io.netty.channel.Channel channel)
- Specified by:
channelReadyin interfaceISaslClient
-
name
public String name()
- Specified by:
namein interfaceISaslClient
-
secretKey
public String secretKey()
- Specified by:
secretKeyin interfaceISaslClient
-
-