Module org.apache.arrow.flight.core

Package org.apache.arrow.flight

Class FlightServer

java.lang.Object

org.apache.arrow.flight.FlightServer

All Implemented Interfaces:

AutoCloseable

public class FlightServer
extends Object
implements AutoCloseable

Generic server of flight data that is customized via construction with delegate classes for the actual logic. The server currently uses GRPC as its transport mechanism.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FlightServer.Builder	A builder for Flight servers.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_BACKPRESSURE_THRESHOLD	The default number of bytes that can be queued on an output stream before blocking.

Method Summary

Modifier and Type	Method	Description
void	awaitTermination()	Block until the server shuts down.
boolean	awaitTermination(long timeout, TimeUnit unit)	Wait for the server to shut down with a timeout.
static FlightServer.Builder	builder()	Create a builder for a Flight server.
static FlightServer.Builder	builder(BufferAllocator allocator, Location location, FlightProducer producer)	Create a builder for a Flight server.
void	close()	Shutdown the server, waits for up to 6 seconds for successful shutdown before returning.
Location	getLocation()	Get the location for this server.
int	getPort()	Get the port the server is running on (if applicable).
void	shutdown()	Request that the server shut down.
FlightServer	start()	Start the server.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BACKPRESSURE_THRESHOLD

public static final int DEFAULT_BACKPRESSURE_THRESHOLD

The default number of bytes that can be queued on an output stream before blocking.

See Also:

• Constant Field Values

Method Details

start

public FlightServer start()
                   throws IOException

Start the server.

Throws:

IOException

getPort

public int getPort()

Get the port the server is running on (if applicable).

getLocation

public Location getLocation()

Get the location for this server.

awaitTermination

public void awaitTermination()
                      throws InterruptedException

Block until the server shuts down.

Throws:

InterruptedException

shutdown

public void shutdown()

Request that the server shut down.

awaitTermination

public boolean awaitTermination(long timeout,
 TimeUnit unit)
                         throws InterruptedException

Wait for the server to shut down with a timeout.

Returns:

true if the server shut down successfully.

Throws:

InterruptedException

close

public void close()
           throws InterruptedException

Shutdown the server, waits for up to 6 seconds for successful shutdown before returning.

Specified by:

close in interface AutoCloseable

Throws:

InterruptedException

builder

public static FlightServer.Builder builder()

Create a builder for a Flight server.

builder

public static FlightServer.Builder builder(BufferAllocator allocator,
 Location location,
 FlightProducer producer)

Create a builder for a Flight server.