public class LoadBalancingRpcClient extends AbstractRpcClient
An implementation of RpcClient interface that uses NettyAvroRpcClient instances to load-balance the requests over many different hosts. This implementation supports a round-robin scheme or random scheme of doing load balancing over the various hosts. To specify round-robin scheme set the value of the configuration property load-balance-type to round_robin. Similarly, for random scheme this value should be set to random, and for a custom scheme the full class name of the class that implements the HostSelector interface.
This implementation also performs basic failover in case the randomly selected host is not available for receiving the event.
| Modifier and Type | Class and Description |
|---|---|
static interface |
LoadBalancingRpcClient.HostSelector |
batchSize, connectTimeout, requestTimeout| Constructor and Description |
|---|
LoadBalancingRpcClient() |
| Modifier and Type | Method and Description |
|---|---|
void |
append(Event event)
Send a single
Event to the associated Flume source. |
void |
appendBatch(List<Event> events)
Send a list of events to the associated Flume source.
|
void |
close()
Immediately closes the client so that it may no longer be used.
|
protected void |
configure(Properties properties)
Configure the client using the given properties object.
|
boolean |
isActive()
Returns
true if this object appears to be in a usable state, and
it returns false if this object is permanently disabled. |
getBatchSizepublic void append(Event event) throws EventDeliveryException
RpcClientSend a single Event to the associated Flume source.
This method blocks until the RPC returns or until the request times out.
Note: If this method throws an
EventDeliveryException, there is no way to recover and the
application must invoke RpcClient.close() on this object to clean up system
resources.
append in interface RpcClientappend in class AbstractRpcClientEventDeliveryException - when an error prevents event delivery.public void appendBatch(List<Event> events) throws EventDeliveryException
RpcClientSend a list of events to the associated Flume source.
This method blocks until the RPC returns or until the request times out.
It is strongly recommended that the number of events in the List be no
more than RpcClient.getBatchSize(). If it is more, multiple RPC calls will
be required, and the likelihood of duplicate Events being stored will
increase.
Note: If this method throws an
EventDeliveryException, there is no way to recover and the
application must invoke RpcClient.close() on this object to clean up system
resources.
appendBatch in interface RpcClientappendBatch in class AbstractRpcClientevents - List of events to sendEventDeliveryException - when an error prevents event delivery.public boolean isActive()
RpcClientReturns true if this object appears to be in a usable state, and
it returns false if this object is permanently disabled.
If this method returns false, an application must call
RpcClient.close() on this object to clean up system resources.
isActive in interface RpcClientisActive in class AbstractRpcClientpublic void close()
throws FlumeException
RpcClientImmediately closes the client so that it may no longer be used.
Note: This method MUST be called by applications when they are done using the RPC client in order to clean up resources.
Multi-threaded applications may want to gracefully stop making
RPC calls before calling close(). Otherwise, they risk getting
EventDeliveryException thrown from their in-flight calls when the
underlying connection is disabled.
close in interface RpcClientclose in class AbstractRpcClientFlumeExceptionprotected void configure(Properties properties) throws FlumeException
AbstractRpcClientconfigure in class AbstractRpcClientFlumeException - if the client can not be configured using this
method, or if the client was already configured once.Copyright © 2009-2019 Apache Software Foundation. All Rights Reserved.