org.apache.arrow.driver.jdbc.utils

Class FlightEndpointDataQueue

java.lang.Object

org.apache.arrow.driver.jdbc.utils.FlightEndpointDataQueue

All Implemented Interfaces:

AutoCloseable

public class FlightEndpointDataQueue
extends Object
implements AutoCloseable

Auxiliary class used to handle consuming of multiple FlightStream.

The usage follows this routine:

1. Create a FlightStreamQueue;
2. Call enqueue(FlightStream) for all streams to be consumed;
3. Call next() to get a FlightStream that is ready to consume
4. Consume the given FlightStream and add it back to the queue - call enqueue(FlightStream)
5. Repeat from (3) until next() returns null.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FlightEndpointDataQueue(CompletionService<CloseableEndpointStreamPair> executorService) Instantiate a new FlightStreamQueue.

Method Summary

Modifier and Type	Method and Description
void	checkOpen() Checks if this queue is open.
void	close()
static FlightEndpointDataQueue	createNewQueue(ExecutorService service) Creates a new FlightEndpointDataQueue from the provided ExecutorService.
void	enqueue(CloseableEndpointStreamPair endpointRequest) Adds given FlightStream to the queue.
void	enqueue(Collection<CloseableEndpointStreamPair> endpointRequests) Readily adds given FlightStreams to the queue.
boolean	isClosed() Gets whether this queue is closed.
CloseableEndpointStreamPair	next() Blocking request to get the next ready FlightStream in queue.
CloseableEndpointStreamPair	next(long timeoutValue, TimeUnit timeoutUnit) Blocking request with timeout to get the next ready FlightStream in queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlightEndpointDataQueue

protected FlightEndpointDataQueue(CompletionService<CloseableEndpointStreamPair> executorService)

Instantiate a new FlightStreamQueue.

Method Detail

createNewQueue

public static FlightEndpointDataQueue createNewQueue(ExecutorService service)

Creates a new FlightEndpointDataQueue from the provided ExecutorService.

Parameters:

service - the service from which to create a new queue.

Returns:

a new queue.

isClosed

public boolean isClosed()

Gets whether this queue is closed.

Returns:

a boolean indicating whether this resource is closed.

next

public CloseableEndpointStreamPair next(long timeoutValue,
                                        TimeUnit timeoutUnit)
                                 throws SQLException

Blocking request with timeout to get the next ready FlightStream in queue.

Parameters:

timeoutValue - the amount of time to be waited

timeoutUnit - the timeoutValue time unit

Returns:

a FlightStream that is ready to consume or null if all FlightStreams are ended.

Throws:

SQLException

next

public CloseableEndpointStreamPair next()
                                 throws SQLException

Blocking request to get the next ready FlightStream in queue.

Returns:

a FlightStream that is ready to consume or null if all FlightStreams are ended.

Throws:

SQLException

checkOpen

public void checkOpen()

Checks if this queue is open.

enqueue

public void enqueue(Collection<CloseableEndpointStreamPair> endpointRequests)

Readily adds given FlightStreams to the queue.

enqueue

public void enqueue(CloseableEndpointStreamPair endpointRequest)

Adds given FlightStream to the queue.

close

public void close()
           throws SQLException

Specified by:

close in interface AutoCloseable

Throws:

SQLException