summaryrefslogtreecommitdiffstats
path: root/src/arrow/docs/source/cpp/api/flight.rst
diff options
context:
space:
mode:
Diffstat (limited to 'src/arrow/docs/source/cpp/api/flight.rst')
-rw-r--r--src/arrow/docs/source/cpp/api/flight.rst202
1 files changed, 202 insertions, 0 deletions
diff --git a/src/arrow/docs/source/cpp/api/flight.rst b/src/arrow/docs/source/cpp/api/flight.rst
new file mode 100644
index 000000000..7cefd66ef
--- /dev/null
+++ b/src/arrow/docs/source/cpp/api/flight.rst
@@ -0,0 +1,202 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+.. or more contributor license agreements. See the NOTICE file
+.. distributed with this work for additional information
+.. regarding copyright ownership. The ASF licenses this file
+.. to you under the Apache License, Version 2.0 (the
+.. "License"); you may not use this file except in compliance
+.. with the License. You may obtain a copy of the License at
+
+.. http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing,
+.. software distributed under the License is distributed on an
+.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.. KIND, either express or implied. See the License for the
+.. specific language governing permissions and limitations
+.. under the License.
+
+.. default-domain:: cpp
+.. highlight:: cpp
+
+================
+Arrow Flight RPC
+================
+
+.. note:: Flight is currently unstable. APIs are subject to change,
+ though we don't expect drastic changes.
+
+Common Types
+============
+
+.. 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:
+
+Clients
+=======
+
+.. 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:
+
+Servers
+=======
+
+.. 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
+==============
+
+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