org.bytedeco.arrow_flight

Class FlightServerBase

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow_flight.FlightServerBase

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::flight")
 @NoOffset
 @Properties(inherit=arrow_flight.class)
public class FlightServerBase
extends Pointer

\brief Skeleton RPC server implementation which can be used to create custom servers by implementing its abstract methods

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
FlightServerBase()
FlightServerBase(long size) Native array allocator.
FlightServerBase(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	DoAction(ServerCallContext context, Action action, ResultStream result) \brief Execute an action, return stream of zero or more results
Status	DoExchange(ServerCallContext context, FlightMessageReader reader, FlightMessageWriter writer) \brief Process a bidirectional stream of IPC payloads
Status	DoGet(ServerCallContext context, Ticket request, FlightDataStream stream) \brief Get a stream of IPC payloads to put on the wire
Status	DoPut(ServerCallContext context, FlightMessageReader reader, FlightMetadataWriter writer) \brief Process a stream of IPC payloads sent from a client
Status	GetFlightInfo(ServerCallContext context, FlightDescriptor request, FlightInfo info) \brief Retrieve the schema and an access plan for the indicated descriptor
FlightServerBase	getPointer(long i)
Status	GetSchema(ServerCallContext context, FlightDescriptor request, SchemaResult schema) \brief Retrieve the schema for the indicated descriptor
int	GotSignal() \brief Query whether Serve() was interrupted by a signal.
Status	Init(FlightServerOptions options) \brief Initialize a Flight server listening at the given location.
Status	ListActions(ServerCallContext context, ActionType actions) \brief Retrieve the list of available actions
Status	ListFlights(ServerCallContext context, Criteria criteria, FlightListing listings) \brief Retrieve a list of available fields given an optional opaque criteria
int	port() \brief Get the port that the Flight server is listening on.
FlightServerBase	position(long position)
Status	Serve() \brief Start serving.
Status	SetShutdownOnSignals(int[] sigs)
Status	SetShutdownOnSignals(IntBuffer sigs)
Status	SetShutdownOnSignals(IntPointer sigs) \brief Set the server to stop when receiving any of the given signal numbers.
Status	Shutdown() \brief Shut down the server.
Status	Wait() \brief Block until server is terminated with Shutdown.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FlightServerBase

public FlightServerBase(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

FlightServerBase

public FlightServerBase(long size)

Native array allocator. Access with Pointer.position(long).

FlightServerBase

public FlightServerBase()

Method Detail

position

public FlightServerBase position(long position)

Overrides:

position in class Pointer

getPointer

public FlightServerBase getPointer(long i)

Overrides:

getPointer in class Pointer

Init

@ByVal
public Status Init(@Const @ByRef
                           FlightServerOptions options)

\brief Initialize a Flight server listening at the given location. This method must be called before any other method.

Parameters:

options - [in] The configuration for this server.

port

public int port()

\brief Get the port that the Flight server is listening on. This method must only be called after Init(). Will return a non-positive value if no port exists (e.g. when listening on a domain socket).

SetShutdownOnSignals

@ByVal
public Status SetShutdownOnSignals(@StdVector
                                           IntPointer sigs)

\brief Set the server to stop when receiving any of the given signal numbers. This method must be called before Serve().

SetShutdownOnSignals

@ByVal
public Status SetShutdownOnSignals(@StdVector
                                           IntBuffer sigs)

SetShutdownOnSignals

@ByVal
public Status SetShutdownOnSignals(@StdVector
                                           int[] sigs)

Serve

@ByVal
public Status Serve()

\brief Start serving. This method blocks until either Shutdown() is called or one of the signals registered in SetShutdownOnSignals() is received.

GotSignal

public int GotSignal()

\brief Query whether Serve() was interrupted by a signal. This method must be called after Serve() has returned.

Returns:

int the signal number that interrupted Serve(), if any, otherwise 0

Shutdown

@ByVal
public Status Shutdown()

\brief Shut down the server. Can be called from signal handler or another thread while Serve() blocks. TODO(wesm): Shutdown with deadline

Wait

@ByVal
public Status Wait()

\brief Block until server is terminated with Shutdown.

ListFlights

@ByVal
public Status ListFlights(@Const @ByRef
                                  ServerCallContext context,
                                  @Const
                                  Criteria criteria,
                                  @UniquePtr
                                  FlightListing listings)

\brief Retrieve a list of available fields given an optional opaque criteria

Parameters:

context - [in] The call context.

criteria - [in] may be null

listings - [out] the returned listings iterator

Returns:

Status

GetFlightInfo

@ByVal
public Status GetFlightInfo(@Const @ByRef
                                    ServerCallContext context,
                                    @Const @ByRef
                                    FlightDescriptor request,
                                    @UniquePtr
                                    FlightInfo info)

\brief Retrieve the schema and an access plan for the indicated descriptor

Parameters:

context - [in] The call context.

request - [in] may be null

info - [out] the returned flight info provider

Returns:

Status

GetSchema

@ByVal
public Status GetSchema(@Const @ByRef
                                ServerCallContext context,
                                @Const @ByRef
                                FlightDescriptor request,
                                @UniquePtr
                                SchemaResult schema)

\brief Retrieve the schema for the indicated descriptor

Parameters:

context - [in] The call context.

request - [in] may be null

schema - [out] the returned flight schema provider

Returns:

Status

DoGet

@ByVal
public Status DoGet(@Const @ByRef
                            ServerCallContext context,
                            @Const @ByRef
                            Ticket request,
                            @UniquePtr
                            FlightDataStream stream)

\brief Get a stream of IPC payloads to put on the wire

Parameters:

context - [in] The call context.

request - [in] an opaque ticket

stream - [out] the returned stream provider

Returns:

Status

DoPut

@ByVal
public Status DoPut(@Const @ByRef
                            ServerCallContext context,
                            @UniquePtr
                            FlightMessageReader reader,
                            @UniquePtr
                            FlightMetadataWriter writer)

\brief Process a stream of IPC payloads sent from a client

Parameters:

context - [in] The call context.

reader - [in] a sequence of uploaded record batches

writer - [in] send metadata back to the client

Returns:

Status

DoExchange

@ByVal
public Status DoExchange(@Const @ByRef
                                 ServerCallContext context,
                                 @UniquePtr
                                 FlightMessageReader reader,
                                 @UniquePtr
                                 FlightMessageWriter writer)

\brief Process a bidirectional stream of IPC payloads

Parameters:

context - [in] The call context.

reader - [in] a sequence of uploaded record batches

writer - [in] send data back to the client

Returns:

Status

DoAction

@ByVal
public Status DoAction(@Const @ByRef
                               ServerCallContext context,
                               @Const @ByRef
                               Action action,
                               @UniquePtr
                               ResultStream result)

\brief Execute an action, return stream of zero or more results

Parameters:

context - [in] The call context.

action - [in] the action to execute, with type and body

result - [out] the result iterator

Returns:

Status

ListActions

@ByVal
public Status ListActions(@Const @ByRef
                                  ServerCallContext context,
                                  @StdVector
                                  ActionType actions)

\brief Retrieve the list of available actions

Parameters:

context - [in] The call context.

actions - [out] a vector of available action types

Returns:

Status