org.apache.arrow.flight.example

Class InMemoryStore

java.lang.Object

org.apache.arrow.flight.example.InMemoryStore

All Implemented Interfaces:

AutoCloseable, FlightProducer

public class InMemoryStore
extends Object
implements FlightProducer, AutoCloseable

A FlightProducer that hosts an in memory store of Arrow buffers. Used for integration testing.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.arrow.flight.FlightProducer

FlightProducer.CallContext, FlightProducer.ServerStreamListener, FlightProducer.StreamListener<T>

Constructor Summary

Constructors

Constructor and Description
InMemoryStore(BufferAllocator allocator, Location location) Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
Runnable	acceptPut(FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream) Accept uploaded data for a particular stream.
void	close()
void	doAction(FlightProducer.CallContext context, Action action, FlightProducer.StreamListener<Result> listener) Generic handler for application-defined RPCs.
FlightInfo	getFlightInfo(FlightProducer.CallContext context, FlightDescriptor descriptor) Get information about a particular data stream.
void	getStream(FlightProducer.CallContext context, Ticket ticket, FlightProducer.ServerStreamListener listener) Return data for a stream.
Stream	getStream(Ticket t) Returns the appropriate stream given the ticket (streams are indexed by path and an ordinal).
void	listActions(FlightProducer.CallContext context, FlightProducer.StreamListener<ActionType> listener) List available application-defined RPCs.
void	listFlights(FlightProducer.CallContext context, Criteria criteria, FlightProducer.StreamListener<FlightInfo> listener) List available data streams on this service.
void	setLocation(Location location) Update the location after server start.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.arrow.flight.FlightProducer

doExchange, getSchema

Constructor Detail

InMemoryStore

public InMemoryStore(BufferAllocator allocator,
                     Location location)

Constructs a new instance.

Parameters:

allocator - The allocator for creating new Arrow buffers.

location - The location of the storage.

Method Detail

setLocation

public void setLocation(Location location)

Update the location after server start.

Useful for binding to port 0 to get a free port.

getStream

public void getStream(FlightProducer.CallContext context,
                      Ticket ticket,
                      FlightProducer.ServerStreamListener listener)

Description copied from interface: FlightProducer

Return data for a stream.

Specified by:

getStream in interface FlightProducer

Parameters:

context - Per-call context.

ticket - The application-defined ticket identifying this stream.

listener - An interface for sending data back to the client.

getStream

public Stream getStream(Ticket t)

Returns the appropriate stream given the ticket (streams are indexed by path and an ordinal).

listFlights

public void listFlights(FlightProducer.CallContext context,
                        Criteria criteria,
                        FlightProducer.StreamListener<FlightInfo> listener)

Description copied from interface: FlightProducer

List available data streams on this service.

Specified by:

listFlights in interface FlightProducer

Parameters:

context - Per-call context.

criteria - Application-defined criteria for filtering streams.

listener - An interface for sending data back to the client.

getFlightInfo

public FlightInfo getFlightInfo(FlightProducer.CallContext context,
                                FlightDescriptor descriptor)

Description copied from interface: FlightProducer

Get information about a particular data stream.

Specified by:

getFlightInfo in interface FlightProducer

Parameters:

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

acceptPut

public Runnable acceptPut(FlightProducer.CallContext context,
                          FlightStream flightStream,
                          FlightProducer.StreamListener<PutResult> ackStream)

Description copied from interface: FlightProducer

Accept uploaded data for a particular stream.

Specified by:

acceptPut in interface FlightProducer

Parameters:

context - Per-call context.

flightStream - The data stream being uploaded.

doAction

public void doAction(FlightProducer.CallContext context,
                     Action action,
                     FlightProducer.StreamListener<Result> listener)

Description copied from interface: FlightProducer

Generic handler for application-defined RPCs.

Specified by:

doAction in interface FlightProducer

Parameters:

context - Per-call context.

action - Client-supplied parameters.

listener - A stream of responses.

listActions

public void listActions(FlightProducer.CallContext context,
                        FlightProducer.StreamListener<ActionType> listener)

Description copied from interface: FlightProducer

List available application-defined RPCs.

Specified by:

listActions in interface FlightProducer

Parameters:

context - Per-call context.

listener - An interface for sending data back to the client.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception