flight.rst

.. default-domain:: cpp

Arrow Flight RPC

Note

Flight is currently unstable. APIs are subject to change, though we don't expect drastic changes.

.. doxygenstruct:: arrow::flight::Action
   :project: arrow_cpp
   :members:

.. doxygenstruct:: arrow::flight::ActionType
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::AddCallHeaders
   :project: arrow_cpp
   :members:

.. doxygenstruct:: arrow::flight::CallInfo
   :project: arrow_cpp
   :members:

.. doxygenstruct:: arrow::flight::Criteria
   :project: arrow_cpp
   :members:

.. doxygenstruct:: arrow::flight::FlightDescriptor
   :project: arrow_cpp
   :members:

.. doxygenstruct:: arrow::flight::FlightEndpoint
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::FlightInfo
   :project: arrow_cpp
   :members:

.. doxygenstruct:: arrow::flight::FlightPayload
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::FlightListing
   :project: arrow_cpp
   :members:

.. doxygenenum:: arrow::flight::FlightMethod
   :project: arrow_cpp

.. doxygenstruct:: arrow::flight::Location
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::MetadataRecordBatchReader
   :project: arrow_cpp
   :members:

.. doxygenstruct:: arrow::flight::Result
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::ResultStream
   :project: arrow_cpp
   :members:

.. doxygenstruct:: arrow::flight::Ticket
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::FlightClient
   :project: arrow_cpp
   :members:

.. doxygenstruct:: arrow::flight::FlightClientOptions
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::FlightCallOptions
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::ClientAuthHandler
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::ClientMiddleware
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::ClientMiddlewareFactory
   :project: arrow_cpp
   :members:

.. doxygentypedef:: arrow::flight::TimeoutDuration
   :project: arrow_cpp

.. doxygenclass:: arrow::flight::FlightStreamReader
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::FlightStreamWriter
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::FlightServerBase
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::FlightServerOptions
   :project: arrow_cpp
   :members:

.. doxygenstruct:: arrow::flight::CertKeyPair
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::FlightDataStream
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::FlightMessageReader
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::FlightMetadataWriter
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::RecordBatchStream
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::ServerAuthHandler
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::ServerCallContext
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::ServerMiddleware
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::ServerMiddlewareFactory
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::SimpleFlightListing
   :project: arrow_cpp
   :members:

.. doxygenclass:: arrow::flight::SimpleResultStream
   :project: arrow_cpp
   :members:

Error handling uses the normal :class:`arrow::Status` class, combined with a custom :class:`arrow::StatusDetail` object for Flight-specific error codes.

.. doxygenenum:: arrow::flight::FlightStatusCode
   :project: arrow_cpp

.. doxygenclass:: arrow::flight::FlightStatusDetail
   :project: arrow_cpp
   :members:

.. doxygenfunction:: arrow::flight::MakeFlightError
   :project: arrow_cpp

.. doxygenfile:: arrow/flight/transport.h
   :sections: briefdescription detaileddescription