co.cask.tephra.distributed

Class PooledClientProvider

java.lang.Object

co.cask.tephra.distributed.AbstractClientProvider

co.cask.tephra.distributed.PooledClientProvider

All Implemented Interfaces:

ThriftClientProvider

public class PooledClientProvider
extends AbstractClientProvider

This is an tx client provider that uses a bounded size pool of connections.

Nested Class Summary

Nested classes/interfaces inherited from class co.cask.tephra.distributed.AbstractClientProvider

AbstractClientProvider.EndpointStrategy, AbstractClientProvider.RandomEndpointStrategy, AbstractClientProvider.TimeLimitEndpointStrategy

Field Summary

Fields inherited from class co.cask.tephra.distributed.AbstractClientProvider

initialized

Constructor Summary

Constructors

Constructor and Description
PooledClientProvider(org.apache.hadoop.conf.Configuration conf, org.apache.twill.discovery.DiscoveryServiceClient discoveryServiceClient)

Method Summary

Methods

Modifier and Type	Method and Description
void	discardClient(TransactionServiceThriftClient client) Discard an tx client from the provider's pool.
TransactionServiceThriftClient	getClient() Retrieve an tx client for exclusive use by the current thread.
void	initialize() Initialize the provider.
void	returnClient(TransactionServiceThriftClient client) Release an tx client back to the provider's pool.
String	toString()

Methods inherited from class co.cask.tephra.distributed.AbstractClientProvider

newClient, newClient

Methods inherited from class java.lang.Object

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

Constructor Detail

PooledClientProvider

public PooledClientProvider(org.apache.hadoop.conf.Configuration conf,
                    org.apache.twill.discovery.DiscoveryServiceClient discoveryServiceClient)

Method Detail

initialize

public void initialize()
                throws org.apache.thrift.TException

Description copied from interface: ThriftClientProvider

Initialize the provider. At this point, it should be verified that tx service is up and running and getClient() can create new clients when necessary.

Specified by:

initialize in interface ThriftClientProvider

Overrides:

initialize in class AbstractClientProvider

Throws:

org.apache.thrift.TException

getClient

public TransactionServiceThriftClient getClient()
                                         throws org.apache.thrift.TException

Description copied from interface: ThriftClientProvider

Retrieve an tx client for exclusive use by the current thread. The tx must be returned to the provider after use.

Returns:

an tx client, connected and fully functional

Throws:

org.apache.thrift.TException

returnClient

public void returnClient(TransactionServiceThriftClient client)

Description copied from interface: ThriftClientProvider

Release an tx client back to the provider's pool.

Parameters:

client - The client to release

discardClient

public void discardClient(TransactionServiceThriftClient client)

Description copied from interface: ThriftClientProvider

Discard an tx client from the provider's pool. This is called after a client becomes disfunctional, for instance, due to a socket exception. The provider must make sure to close the client, and it must remove the client from its arsenal and be prepared to create a new client subsequently.

Parameters:

client - The client to discard

toString

public String toString()

Overrides:

toString in class Object