| |
| |
| <!DOCTYPE html> |
| |
| |
| <html lang="en" data-content_root="" > |
| |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> |
| |
| <title>Arrow Flight RPC — Apache Arrow v17.0.0.dev52</title> |
| |
| |
| |
| <script data-cfasync="false"> |
| document.documentElement.dataset.mode = localStorage.getItem("mode") || ""; |
| document.documentElement.dataset.theme = localStorage.getItem("theme") || "light"; |
| </script> |
| |
| <!-- Loaded before other Sphinx assets --> |
| <link href="../../_static/styles/theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| <link href="../../_static/styles/bootstrap.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| <link href="../../_static/styles/pydata-sphinx-theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| |
| |
| <link href="../../_static/vendor/fontawesome/6.5.1/css/all.min.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2" /> |
| |
| <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/theme_overrides.css" /> |
| |
| <!-- Pre-loaded scripts that we'll load fully later --> |
| <link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae" /> |
| <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" /> |
| <script src="../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script> |
| |
| <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <script src="../../_static/sphinx_highlight.js"></script> |
| <script src="../../_static/clipboard.min.js"></script> |
| <script src="../../_static/copybutton.js"></script> |
| <script src="../../_static/design-tabs.js"></script> |
| <script>DOCUMENTATION_OPTIONS.pagename = 'cpp/api/flight';</script> |
| <script> |
| DOCUMENTATION_OPTIONS.theme_version = '0.15.2'; |
| DOCUMENTATION_OPTIONS.theme_switcher_json_url = '/docs/_static/versions.json'; |
| DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'dev/'; |
| DOCUMENTATION_OPTIONS.show_version_warning_banner = true; |
| </script> |
| <link rel="canonical" href="https://arrow.apache.org/docs/cpp/api/flight.html" /> |
| <link rel="icon" href="../../_static/favicon.ico"/> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="Arrow Flight SQL" href="flightsql.html" /> |
| <link rel="prev" title="CUDA support" href="cuda.html" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <meta name="docsearch:language" content="en"/> |
| |
| <!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| /* We explicitly disable cookie tracking to avoid privacy issues */ |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '20']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo Code --> |
| |
| </head> |
| |
| |
| <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode=""> |
| |
| |
| |
| <a id="pst-skip-link" class="skip-link" href="#main-content">Skip to main content</a> |
| |
| <div id="pst-scroll-pixel-helper"></div> |
| |
| <button type="button" class="btn rounded-pill" id="pst-back-to-top"> |
| <i class="fa-solid fa-arrow-up"></i> |
| Back to top |
| </button> |
| |
| |
| <input type="checkbox" |
| class="sidebar-toggle" |
| name="__primary" |
| id="__primary"/> |
| <label class="overlay overlay-primary" for="__primary"></label> |
| |
| <input type="checkbox" |
| class="sidebar-toggle" |
| name="__secondary" |
| id="__secondary"/> |
| <label class="overlay overlay-secondary" for="__secondary"></label> |
| |
| <div class="search-button__wrapper"> |
| <div class="search-button__overlay"></div> |
| <div class="search-button__search-container"> |
| <form class="bd-search d-flex align-items-center" |
| action="../../search.html" |
| method="get"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <input type="search" |
| class="form-control" |
| name="q" |
| id="search-input" |
| placeholder="Search the docs ..." |
| aria-label="Search the docs ..." |
| autocomplete="off" |
| autocorrect="off" |
| autocapitalize="off" |
| spellcheck="false"/> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> |
| </form></div> |
| </div> |
| |
| <header class="bd-header navbar navbar-expand-lg bd-navbar"> |
| <div class="bd-header__inner bd-page-width"> |
| <label class="sidebar-toggle primary-toggle" for="__primary"> |
| <span class="fa-solid fa-bars"></span> |
| </label> |
| |
| |
| <div class="col-lg-3 navbar-header-items__start"> |
| |
| <div class="navbar-item"> |
| |
| |
| |
| <a class="navbar-brand logo" href="../../index.html"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <img src="../../_static/arrow.png" class="logo__image only-light" alt="Apache Arrow v17.0.0.dev52 - Home"/> |
| <script>document.write(`<img src="../../_static/arrow-dark.png" class="logo__image only-dark" alt="Apache Arrow v17.0.0.dev52 - Home"/>`);</script> |
| |
| |
| </a></div> |
| |
| </div> |
| |
| <div class="col-lg-9 navbar-header-items"> |
| |
| <div class="me-auto navbar-header-items__center"> |
| |
| <div class="navbar-item"> |
| <nav class="navbar-nav"> |
| <ul class="bd-navbar-elements navbar-nav"> |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../format/index.html"> |
| Specifications |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../developers/index.html"> |
| Development |
| </a> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links"> |
| Implementations |
| </button> |
| <ul id="pst-nav-more-links" class="dropdown-menu"> |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../c_glib/index.html"> |
| C/GLib |
| </a> |
| </li> |
| |
| |
| <li class="nav-item current active"> |
| <a class="nav-link dropdown-item nav-internal" href="../index.html"> |
| C++ |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/csharp/README.md"> |
| C# |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://pkg.go.dev/github.com/apache/arrow/go/v17"> |
| Go |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../java/index.html"> |
| Java |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../js/index.html"> |
| JavaScript |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/julia/"> |
| Julia |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/matlab/README.md"> |
| MATLAB |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/nanoarrow/"> |
| nanoarrow |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../python/index.html"> |
| Python |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../r/index.html"> |
| R |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/ruby/README.md"> |
| Ruby |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://docs.rs/crate/arrow/"> |
| Rust |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../status.html"> |
| Implementation Status |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/cpp/"> |
| C++ cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/java/"> |
| Java cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/py/"> |
| Python cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/r/"> |
| R cookbook |
| </a> |
| </li> |
| |
| </ul> |
| </li> |
| |
| </ul> |
| </nav></div> |
| |
| </div> |
| |
| |
| <div class="navbar-header-items__end"> |
| |
| <div class="navbar-item navbar-persistent--container"> |
| |
| |
| <script> |
| document.write(` |
| <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <span class="search-button__default-text">Search</span> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> |
| </button> |
| `); |
| </script> |
| </div> |
| |
| |
| <div class="navbar-item"> |
| <script> |
| document.write(` |
| <div class="version-switcher__container dropdown"> |
| <button id="pst-version-switcher-button-2" |
| type="button" |
| class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" |
| data-bs-toggle="dropdown" |
| aria-haspopup="listbox" |
| aria-controls="pst-version-switcher-list-2" |
| aria-label="Version switcher list" |
| > |
| Choose version <!-- this text may get changed later by javascript --> |
| <span class="caret"></span> |
| </button> |
| <div id="pst-version-switcher-list-2" |
| class="version-switcher__menu dropdown-menu list-group-flush py-0" |
| role="listbox" aria-labelledby="pst-version-switcher-button-2"> |
| <!-- dropdown will be populated by javascript on page load --> |
| </div> |
| </div> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"> |
| |
| <script> |
| document.write(` |
| <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span> |
| </button> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"><ul class="navbar-icon-links navbar-nav" |
| aria-label="Icon Links"> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">GitHub</span></a> |
| </li> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://twitter.com/ApacheArrow" title="X" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-x-twitter fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">X</span></a> |
| </li> |
| </ul></div> |
| |
| </div> |
| |
| </div> |
| |
| |
| <div class="navbar-persistent--mobile"> |
| |
| <script> |
| document.write(` |
| <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <span class="search-button__default-text">Search</span> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> |
| </button> |
| `); |
| </script> |
| </div> |
| |
| |
| |
| <label class="sidebar-toggle secondary-toggle" for="__secondary" tabindex="0"> |
| <span class="fa-solid fa-outdent"></span> |
| </label> |
| |
| </div> |
| |
| </header> |
| |
| |
| <div class="bd-container"> |
| <div class="bd-container__inner bd-page-width"> |
| |
| |
| |
| <div class="bd-sidebar-primary bd-sidebar"> |
| |
| |
| |
| <div class="sidebar-header-items sidebar-primary__section"> |
| |
| |
| <div class="sidebar-header-items__center"> |
| |
| <div class="navbar-item"> |
| <nav class="navbar-nav"> |
| <ul class="bd-navbar-elements navbar-nav"> |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../format/index.html"> |
| Specifications |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../developers/index.html"> |
| Development |
| </a> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links-2"> |
| Implementations |
| </button> |
| <ul id="pst-nav-more-links-2" class="dropdown-menu"> |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../c_glib/index.html"> |
| C/GLib |
| </a> |
| </li> |
| |
| |
| <li class="nav-item current active"> |
| <a class="nav-link dropdown-item nav-internal" href="../index.html"> |
| C++ |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/csharp/README.md"> |
| C# |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://pkg.go.dev/github.com/apache/arrow/go/v17"> |
| Go |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../java/index.html"> |
| Java |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../js/index.html"> |
| JavaScript |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/julia/"> |
| Julia |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/matlab/README.md"> |
| MATLAB |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/nanoarrow/"> |
| nanoarrow |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../python/index.html"> |
| Python |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../r/index.html"> |
| R |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/ruby/README.md"> |
| Ruby |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://docs.rs/crate/arrow/"> |
| Rust |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../status.html"> |
| Implementation Status |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/cpp/"> |
| C++ cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/java/"> |
| Java cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/py/"> |
| Python cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/r/"> |
| R cookbook |
| </a> |
| </li> |
| |
| </ul> |
| </li> |
| |
| </ul> |
| </nav></div> |
| |
| </div> |
| |
| |
| |
| <div class="sidebar-header-items__end"> |
| |
| <div class="navbar-item"> |
| <script> |
| document.write(` |
| <div class="version-switcher__container dropdown"> |
| <button id="pst-version-switcher-button-3" |
| type="button" |
| class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" |
| data-bs-toggle="dropdown" |
| aria-haspopup="listbox" |
| aria-controls="pst-version-switcher-list-3" |
| aria-label="Version switcher list" |
| > |
| Choose version <!-- this text may get changed later by javascript --> |
| <span class="caret"></span> |
| </button> |
| <div id="pst-version-switcher-list-3" |
| class="version-switcher__menu dropdown-menu list-group-flush py-0" |
| role="listbox" aria-labelledby="pst-version-switcher-button-3"> |
| <!-- dropdown will be populated by javascript on page load --> |
| </div> |
| </div> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"> |
| |
| <script> |
| document.write(` |
| <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span> |
| </button> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"><ul class="navbar-icon-links navbar-nav" |
| aria-label="Icon Links"> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">GitHub</span></a> |
| </li> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://twitter.com/ApacheArrow" title="X" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-x-twitter fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">X</span></a> |
| </li> |
| </ul></div> |
| |
| </div> |
| |
| </div> |
| |
| <div class="sidebar-primary-items__start sidebar-primary__section"> |
| <div class="sidebar-primary-item"> |
| <nav class="bd-docs-nav bd-links" |
| aria-label="Section Navigation"> |
| <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p> |
| <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav"> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="../getting_started.html">Getting Started</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../build_system.html">Using Arrow C++ in your own project</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../conventions.html">Conventions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/basic_arrow.html">Basic Arrow Data Structures</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/io_tutorial.html">Arrow File I/O</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/compute_tutorial.html">Arrow Compute</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/datasets_tutorial.html">Arrow Datasets</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="../user_guide.html">User Guide</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../overview.html">High-Level Overview</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../memory.html">Memory Management</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../arrays.html">Arrays</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../datatypes.html">Data Types</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tables.html">Tabular Data</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../compute.html">Compute Functions</a></li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../gandiva.html">The Gandiva Expression Compiler</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../gandiva/expr_projector_filter.html">Gandiva Expression, Projector, and Filter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../gandiva/external_func.html">Gandiva External Functions Development Guide</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../streaming_execution.html">Acero: A C++ streaming execution engine</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/overview.html">Acero Overview</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/user_guide.html">Acero User’s Guide</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/substrait.html">Using Acero with Substrait</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/developer_guide.html">Developer’s Guide</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../io.html">Input / output and filesystems</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../ipc.html">Reading and writing the Arrow IPC format</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../orc.html">Reading and Writing ORC files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../parquet.html">Reading and writing Parquet files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../csv.html">Reading and Writing CSV files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../json.html">Reading JSON files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../dataset.html">Tabular Datasets</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../flight.html">Arrow Flight RPC</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../gdb.html">Debugging code using Arrow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../threading.html">Thread Management</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../opentelemetry.html">OpenTelemetry</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../env_vars.html">Environment Variables</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="../examples/index.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/cmake_minimal_build.html">Minimal build using CMake</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/compute_and_write_example.html">Compute and Write CSV Example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/dataset_documentation_example.html">Arrow Datasets example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/dataset_skyhook_scan_example.html">Arrow Skyhook example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/row_columnar_conversion.html">Row to columnar conversion</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/tuple_range_conversion.html">std::tuple-like ranges to Arrow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/converting_recordbatch_to_tensor.html">Converting RecordBatch to Tensor</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1 current active has-children"><a class="reference internal" href="../api.html">API Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-6"><i class="fa-solid fa-chevron-down"></i></label><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="support.html">Programming Support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="memory.html">Memory (management)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="thread.html">Thread (management)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="datatype.html">Data Types</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="array.html">Arrays</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="scalar.html">Scalars</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="builder.html">Array Builders</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="table.html">Two-dimensional Datasets</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="c_abi.html">C Interfaces</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="compute.html">Compute Functions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="acero.html">Streaming Execution (Acero)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="gandiva.html">Gandiva Expression Compiler</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="tensor.html">Tensors</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="utilities.html">Utilities</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="async.html">Asynchronous programming</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="io.html">Input / output</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="ipc.html">Arrow IPC</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="formats.html">File Formats</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cuda.html">CUDA support</a></li> |
| <li class="toctree-l2 current active"><a class="current reference internal" href="#">Arrow Flight RPC</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="flightsql.html">Arrow Flight SQL</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="filesystem.html">Filesystems</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="dataset.html">Dataset</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/cookbook/cpp/">C++ cookbook</a></li> |
| </ul> |
| </div> |
| </nav></div> |
| </div> |
| |
| |
| <div class="sidebar-primary-items__end sidebar-primary__section"> |
| </div> |
| |
| <div id="rtd-footer-container"></div> |
| |
| |
| </div> |
| |
| <main id="main-content" class="bd-main"> |
| |
| |
| <div class="bd-content"> |
| <div class="bd-article-container"> |
| |
| <div class="bd-header-article"> |
| <div class="header-article-items header-article__inner"> |
| |
| <div class="header-article-items__start"> |
| |
| <div class="header-article-item"> |
| |
| |
| |
| <nav aria-label="Breadcrumb"> |
| <ul class="bd-breadcrumbs"> |
| |
| <li class="breadcrumb-item breadcrumb-home"> |
| <a href="../../index.html" class="nav-link" aria-label="Home"> |
| <i class="fa-solid fa-home"></i> |
| </a> |
| </li> |
| |
| <li class="breadcrumb-item"><a href="../index.html" class="nav-link">C++ Implementation</a></li> |
| |
| |
| <li class="breadcrumb-item"><a href="../api.html" class="nav-link">API Reference</a></li> |
| |
| <li class="breadcrumb-item active" aria-current="page">Arrow Flight RPC</li> |
| </ul> |
| </nav> |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| |
| |
| |
| <div id="searchbox"></div> |
| <article class="bd-article"> |
| |
| <section id="arrow-flight-rpc"> |
| <h1>Arrow Flight RPC<a class="headerlink" href="#arrow-flight-rpc" title="Permalink to this heading">#</a></h1> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Flight is currently unstable. APIs are subject to change, |
| though we don’t expect drastic changes.</p> |
| </div> |
| <section id="common-types"> |
| <h2>Common Types<a class="headerlink" href="#common-types" title="Permalink to this heading">#</a></h2> |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight6ActionE"> |
| <span id="_CPPv3N5arrow6flight6ActionE"></span><span id="_CPPv2N5arrow6flight6ActionE"></span><span id="arrow::flight::Action"></span><span class="target" id="structarrow_1_1flight_1_1_action"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Action</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight6ActionE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An action to perform with the DoAction RPC. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight6Action17SerializeToStringEv"> |
| <span id="_CPPv3NK5arrow6flight6Action17SerializeToStringEv"></span><span id="_CPPv2NK5arrow6flight6Action17SerializeToStringEv"></span><span id="arrow::flight::Action::SerializeToStringC"></span><span class="target" id="structarrow_1_1flight_1_1_action_1a24d6e239abf0b86881c506a2236009c0"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SerializeToString</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight6Action17SerializeToStringEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Serialize this message to its wire-format representation. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight6Action4typeE"> |
| <span id="_CPPv3N5arrow6flight6Action4typeE"></span><span id="_CPPv2N5arrow6flight6Action4typeE"></span><span id="arrow::flight::Action::type__ss"></span><span class="target" id="structarrow_1_1flight_1_1_action_1af9896e305e4138edb643078f4fcca5f4"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight6Action4typeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The action type. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight6Action4bodyE"> |
| <span id="_CPPv3N5arrow6flight6Action4bodyE"></span><span id="_CPPv2N5arrow6flight6Action4bodyE"></span><span id="arrow::flight::Action::body__std::shared_ptr:Buffer:"></span><span class="target" id="structarrow_1_1flight_1_1_action_1ad8502d5b8d1b7e2e0f48c90acda15ef7"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="memory.html#_CPPv4N5arrow6BufferE" title="arrow::Buffer"><span class="n"><span class="pre">Buffer</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">body</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight6Action4bodyE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The action content as a <a class="reference internal" href="memory.html#classarrow_1_1_buffer"><span class="std std-ref">Buffer</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight6Action11DeserializeENSt11string_viewE"> |
| <span id="_CPPv3N5arrow6flight6Action11DeserializeENSt11string_viewE"></span><span id="_CPPv2N5arrow6flight6Action11DeserializeENSt11string_viewE"></span><span id="arrow::flight::Action::Deserialize__std::string_view"></span><span class="target" id="structarrow_1_1flight_1_1_action_1a8b7cc8864fc4bd620b2d27f55d610a5c"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight6ActionE" title="arrow::flight::Action"><span class="n"><span class="pre">Action</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Deserialize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string_view</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">serialized</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight6Action11DeserializeENSt11string_viewE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Deserialize this message from its wire-format representation. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight10ActionTypeE"> |
| <span id="_CPPv3N5arrow6flight10ActionTypeE"></span><span id="_CPPv2N5arrow6flight10ActionTypeE"></span><span id="arrow::flight::ActionType"></span><span class="target" id="structarrow_1_1flight_1_1_action_type"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ActionType</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight10ActionTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A type of action that can be performed with the DoAction RPC. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight10ActionType17SerializeToStringEv"> |
| <span id="_CPPv3NK5arrow6flight10ActionType17SerializeToStringEv"></span><span id="_CPPv2NK5arrow6flight10ActionType17SerializeToStringEv"></span><span id="arrow::flight::ActionType::SerializeToStringC"></span><span class="target" id="structarrow_1_1flight_1_1_action_type_1a718c409d3cdb561160deddfd6eb4785a"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SerializeToString</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight10ActionType17SerializeToStringEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Serialize this message to its wire-format representation. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight10ActionType4typeE"> |
| <span id="_CPPv3N5arrow6flight10ActionType4typeE"></span><span id="_CPPv2N5arrow6flight10ActionType4typeE"></span><span id="arrow::flight::ActionType::type__ss"></span><span class="target" id="structarrow_1_1flight_1_1_action_type_1ad0398039d125c7e81a1cf0c92e416a27"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight10ActionType4typeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The name of the action. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight10ActionType11descriptionE"> |
| <span id="_CPPv3N5arrow6flight10ActionType11descriptionE"></span><span id="_CPPv2N5arrow6flight10ActionType11descriptionE"></span><span id="arrow::flight::ActionType::description__ss"></span><span class="target" id="structarrow_1_1flight_1_1_action_type_1acce448827c5033af73977af150754917"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">description</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight10ActionType11descriptionE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A human-readable description of the action. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight10ActionType11DeserializeENSt11string_viewE"> |
| <span id="_CPPv3N5arrow6flight10ActionType11DeserializeENSt11string_viewE"></span><span id="_CPPv2N5arrow6flight10ActionType11DeserializeENSt11string_viewE"></span><span id="arrow::flight::ActionType::Deserialize__std::string_view"></span><span class="target" id="structarrow_1_1flight_1_1_action_type_1a436e8378e6e2c3777bcaeaf6477d212d"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight10ActionTypeE" title="arrow::flight::ActionType"><span class="n"><span class="pre">ActionType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Deserialize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string_view</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">serialized</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight10ActionType11DeserializeENSt11string_viewE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Deserialize this message from its wire-format representation. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight14AddCallHeadersE"> |
| <span id="_CPPv3N5arrow6flight14AddCallHeadersE"></span><span id="_CPPv2N5arrow6flight14AddCallHeadersE"></span><span id="arrow::flight::AddCallHeaders"></span><span class="target" id="classarrow_1_1flight_1_1_add_call_headers"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AddCallHeaders</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight14AddCallHeadersE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A write-only wrapper around headers for an RPC call. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight14AddCallHeaders9AddHeaderERKNSt6stringERKNSt6stringE"> |
| <span id="_CPPv3N5arrow6flight14AddCallHeaders9AddHeaderERKNSt6stringERKNSt6stringE"></span><span id="_CPPv2N5arrow6flight14AddCallHeaders9AddHeaderERKNSt6stringERKNSt6stringE"></span><span id="arrow::flight::AddCallHeaders::AddHeader__ssCR.ssCR"></span><span class="target" id="classarrow_1_1flight_1_1_add_call_headers_1a0c589c15379805a92781df546e982731"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AddHeader</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">key</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight14AddCallHeaders9AddHeaderERKNSt6stringERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Add a header to be sent to the client. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>key</strong> – <strong>[in]</strong> The header name. Must be lowercase ASCII; some transports may reject invalid header names. </p></li> |
| <li><p><strong>value</strong> – <strong>[in]</strong> The header value. Some transports may only accept binary header values if the header name ends in “-bin”. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8CallInfoE"> |
| <span id="_CPPv3N5arrow6flight8CallInfoE"></span><span id="_CPPv2N5arrow6flight8CallInfoE"></span><span id="arrow::flight::CallInfo"></span><span class="target" id="structarrow_1_1flight_1_1_call_info"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CallInfo</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight8CallInfoE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Information about an instance of a Flight RPC. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8CallInfo6methodE"> |
| <span id="_CPPv3N5arrow6flight8CallInfo6methodE"></span><span id="_CPPv2N5arrow6flight8CallInfo6methodE"></span><span id="arrow::flight::CallInfo::method__FlightMethod"></span><span class="target" id="structarrow_1_1flight_1_1_call_info_1ade3302d2aaf99d6a128fa026d2144a4c"></span><a class="reference internal" href="#_CPPv4N5arrow6flight12FlightMethodE" title="arrow::flight::FlightMethod"><span class="n"><span class="pre">FlightMethod</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">method</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight8CallInfo6methodE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The RPC method of this call. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8CriteriaE"> |
| <span id="_CPPv3N5arrow6flight8CriteriaE"></span><span id="_CPPv2N5arrow6flight8CriteriaE"></span><span id="arrow::flight::Criteria"></span><span class="target" id="structarrow_1_1flight_1_1_criteria"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Criteria</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight8CriteriaE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Opaque selection criteria for ListFlights RPC. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight8Criteria17SerializeToStringEv"> |
| <span id="_CPPv3NK5arrow6flight8Criteria17SerializeToStringEv"></span><span id="_CPPv2NK5arrow6flight8Criteria17SerializeToStringEv"></span><span id="arrow::flight::Criteria::SerializeToStringC"></span><span class="target" id="structarrow_1_1flight_1_1_criteria_1a6278e1c9208a3219890824ff02b18476"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SerializeToString</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight8Criteria17SerializeToStringEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Serialize this message to its wire-format representation. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8Criteria10expressionE"> |
| <span id="_CPPv3N5arrow6flight8Criteria10expressionE"></span><span id="_CPPv2N5arrow6flight8Criteria10expressionE"></span><span id="arrow::flight::Criteria::expression__ss"></span><span class="target" id="structarrow_1_1flight_1_1_criteria_1aa7f742b91843a5345a772eeb33741c73"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">expression</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight8Criteria10expressionE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Opaque criteria expression, dependent on server implementation. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8Criteria11DeserializeENSt11string_viewE"> |
| <span id="_CPPv3N5arrow6flight8Criteria11DeserializeENSt11string_viewE"></span><span id="_CPPv2N5arrow6flight8Criteria11DeserializeENSt11string_viewE"></span><span id="arrow::flight::Criteria::Deserialize__std::string_view"></span><span class="target" id="structarrow_1_1flight_1_1_criteria_1a89bf813c0b743db1e1d4d6a1924d5210"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight8CriteriaE" title="arrow::flight::Criteria"><span class="n"><span class="pre">Criteria</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Deserialize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string_view</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">serialized</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight8Criteria11DeserializeENSt11string_viewE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Deserialize this message from its wire-format representation. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightDescriptorE"> |
| <span id="_CPPv3N5arrow6flight16FlightDescriptorE"></span><span id="_CPPv2N5arrow6flight16FlightDescriptorE"></span><span id="arrow::flight::FlightDescriptor"></span><span class="target" id="structarrow_1_1flight_1_1_flight_descriptor"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightDescriptor</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightDescriptorE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A request to retrieve or generate a dataset. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight16FlightDescriptor8ToStringEv"> |
| <span id="_CPPv3NK5arrow6flight16FlightDescriptor8ToStringEv"></span><span id="_CPPv2NK5arrow6flight16FlightDescriptor8ToStringEv"></span><span id="arrow::flight::FlightDescriptor::ToStringC"></span><span class="target" id="structarrow_1_1flight_1_1_flight_descriptor_1af36068fccc9781e62ab31c6886458a61"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight16FlightDescriptor8ToStringEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a human-readable form of this descriptor. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight16FlightDescriptor17SerializeToStringEv"> |
| <span id="_CPPv3NK5arrow6flight16FlightDescriptor17SerializeToStringEv"></span><span id="_CPPv2NK5arrow6flight16FlightDescriptor17SerializeToStringEv"></span><span id="arrow::flight::FlightDescriptor::SerializeToStringC"></span><span class="target" id="structarrow_1_1flight_1_1_flight_descriptor_1a9bd569e2c8dbc4ed380468cba8294b31"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SerializeToString</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight16FlightDescriptor17SerializeToStringEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the wire-format representation of this type. </p> |
| <p>Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightDescriptor4typeE"> |
| <span id="_CPPv3N5arrow6flight16FlightDescriptor4typeE"></span><span id="_CPPv2N5arrow6flight16FlightDescriptor4typeE"></span><span id="arrow::flight::FlightDescriptor::type__DescriptorType"></span><span class="target" id="structarrow_1_1flight_1_1_flight_descriptor_1aabfcaa722ae6b362ee3be72273ea79ab"></span><span class="n"><span class="pre">DescriptorType</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightDescriptor4typeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The descriptor type. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightDescriptor3cmdE"> |
| <span id="_CPPv3N5arrow6flight16FlightDescriptor3cmdE"></span><span id="_CPPv2N5arrow6flight16FlightDescriptor3cmdE"></span><span id="arrow::flight::FlightDescriptor::cmd__ss"></span><span class="target" id="structarrow_1_1flight_1_1_flight_descriptor_1a5cc5791676902261e4985350fa9c92ed"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">cmd</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightDescriptor3cmdE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Opaque value used to express a command. </p> |
| <p>Should only be defined when type is CMD </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightDescriptor4pathE"> |
| <span id="_CPPv3N5arrow6flight16FlightDescriptor4pathE"></span><span id="_CPPv2N5arrow6flight16FlightDescriptor4pathE"></span><span id="arrow::flight::FlightDescriptor::path__std::vector:ss:"></span><span class="target" id="structarrow_1_1flight_1_1_flight_descriptor_1a5451422dd19bfec89dce2b62866c1e53"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">path</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightDescriptor4pathE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>List of strings identifying a particular dataset. </p> |
| <p>Should only be defined when type is PATH </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightDescriptor11DeserializeENSt11string_viewE"> |
| <span id="_CPPv3N5arrow6flight16FlightDescriptor11DeserializeENSt11string_viewE"></span><span id="_CPPv2N5arrow6flight16FlightDescriptor11DeserializeENSt11string_viewE"></span><span id="arrow::flight::FlightDescriptor::Deserialize__std::string_view"></span><span class="target" id="structarrow_1_1flight_1_1_flight_descriptor_1aba9aad9e663e774d6257a0d33f2c7e16"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Deserialize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string_view</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">serialized</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightDescriptor11DeserializeENSt11string_viewE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Parse the wire-format representation of this type. </p> |
| <p>Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight14FlightEndpointE"> |
| <span id="_CPPv3N5arrow6flight14FlightEndpointE"></span><span id="_CPPv2N5arrow6flight14FlightEndpointE"></span><span id="arrow::flight::FlightEndpoint"></span><span class="target" id="structarrow_1_1flight_1_1_flight_endpoint"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightEndpoint</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight14FlightEndpointE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A flight ticket and list of locations where the ticket can be redeemed. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight14FlightEndpoint17SerializeToStringEv"> |
| <span id="_CPPv3NK5arrow6flight14FlightEndpoint17SerializeToStringEv"></span><span id="_CPPv2NK5arrow6flight14FlightEndpoint17SerializeToStringEv"></span><span id="arrow::flight::FlightEndpoint::SerializeToStringC"></span><span class="target" id="structarrow_1_1flight_1_1_flight_endpoint_1ab77b2777396840bc44c28e17a73a1ffc"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SerializeToString</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight14FlightEndpoint17SerializeToStringEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Serialize this message to its wire-format representation. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight14FlightEndpoint6ticketE"> |
| <span id="_CPPv3N5arrow6flight14FlightEndpoint6ticketE"></span><span id="_CPPv2N5arrow6flight14FlightEndpoint6ticketE"></span><span id="arrow::flight::FlightEndpoint::ticket__Ticket"></span><span class="target" id="structarrow_1_1flight_1_1_flight_endpoint_1ae88cc1607d53a206d33ea692c3f5d4f0"></span><a class="reference internal" href="#_CPPv4N5arrow6flight6TicketE" title="arrow::flight::Ticket"><span class="n"><span class="pre">Ticket</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ticket</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight14FlightEndpoint6ticketE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Opaque ticket identify; use with DoGet RPC. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight14FlightEndpoint9locationsE"> |
| <span id="_CPPv3N5arrow6flight14FlightEndpoint9locationsE"></span><span id="_CPPv2N5arrow6flight14FlightEndpoint9locationsE"></span><span id="arrow::flight::FlightEndpoint::locations__std::vector:Location:"></span><span class="target" id="structarrow_1_1flight_1_1_flight_endpoint_1a93c933152f5458413022c74b3a68ec3e"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">locations</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight14FlightEndpoint9locationsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>List of locations where ticket can be redeemed. </p> |
| <p>If the list is empty, the ticket can only be redeemed on the current service where the ticket was generated </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight14FlightEndpoint15expiration_timeE"> |
| <span id="_CPPv3N5arrow6flight14FlightEndpoint15expiration_timeE"></span><span id="_CPPv2N5arrow6flight14FlightEndpoint15expiration_timeE"></span><span id="arrow::flight::FlightEndpoint::expiration_time__std::optional:Timestamp:"></span><span class="target" id="structarrow_1_1flight_1_1_flight_endpoint_1af32a93891517e1cc2f240006abac0aae"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Timestamp</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">expiration_time</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight14FlightEndpoint15expiration_timeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Expiration time of this stream. </p> |
| <p>If present, clients may assume they can retry DoGet requests. Otherwise, clients should avoid retrying DoGet requests. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight14FlightEndpoint12app_metadataE"> |
| <span id="_CPPv3N5arrow6flight14FlightEndpoint12app_metadataE"></span><span id="_CPPv2N5arrow6flight14FlightEndpoint12app_metadataE"></span><span id="arrow::flight::FlightEndpoint::app_metadata__ss"></span><span class="target" id="structarrow_1_1flight_1_1_flight_endpoint_1a73d12d9ad4485f02de01a34926446fc2"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">app_metadata</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight14FlightEndpoint12app_metadataE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Opaque Application-defined metadata. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight14FlightEndpoint11DeserializeENSt11string_viewE"> |
| <span id="_CPPv3N5arrow6flight14FlightEndpoint11DeserializeENSt11string_viewE"></span><span id="_CPPv2N5arrow6flight14FlightEndpoint11DeserializeENSt11string_viewE"></span><span id="arrow::flight::FlightEndpoint::Deserialize__std::string_view"></span><span class="target" id="structarrow_1_1flight_1_1_flight_endpoint_1a1ae130e375f1328de4f69672d2c23aa2"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight14FlightEndpointE" title="arrow::flight::FlightEndpoint"><span class="n"><span class="pre">FlightEndpoint</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Deserialize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string_view</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">serialized</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight14FlightEndpoint11DeserializeENSt11string_viewE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Deserialize this message from its wire-format representation. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight10FlightInfoE"> |
| <span id="_CPPv3N5arrow6flight10FlightInfoE"></span><span id="_CPPv2N5arrow6flight10FlightInfoE"></span><span id="arrow::flight::FlightInfo"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightInfo</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight10FlightInfoE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The access coordinates for retrieval of a dataset, returned by GetFlightInfo. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight10FlightInfo9GetSchemaEPN3ipc14DictionaryMemoE"> |
| <span id="_CPPv3NK5arrow6flight10FlightInfo9GetSchemaEPN3ipc14DictionaryMemoE"></span><span id="_CPPv2NK5arrow6flight10FlightInfo9GetSchemaEPN3ipc14DictionaryMemoE"></span><span id="arrow::flight::FlightInfo::GetSchema__ipc::DictionaryMemoPC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1a253b6bf1f6a9aa5e1378457dae761c02"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSchema</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">ipc</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">DictionaryMemo</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">dictionary_memo</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight10FlightInfo9GetSchemaEPN3ipc14DictionaryMemoE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Deserialize the Arrow schema of the dataset. </p> |
| <p>Populate any dictionary encoded fields into a DictionaryMemo for bookkeeping </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>dictionary_memo</strong> – <strong>[inout]</strong> for dictionary bookkeeping, will be modified </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with the reconstructed <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight10FlightInfo10descriptorEv"> |
| <span id="_CPPv3NK5arrow6flight10FlightInfo10descriptorEv"></span><span id="_CPPv2NK5arrow6flight10FlightInfo10descriptorEv"></span><span id="arrow::flight::FlightInfo::descriptorC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1af948fa2fc9f46987656dff565aeb62bb"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">descriptor</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight10FlightInfo10descriptorEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The descriptor associated with this flight, may not be set. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight10FlightInfo9endpointsEv"> |
| <span id="_CPPv3NK5arrow6flight10FlightInfo9endpointsEv"></span><span id="_CPPv2NK5arrow6flight10FlightInfo9endpointsEv"></span><span id="arrow::flight::FlightInfo::endpointsC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1a101f2c75e81b0eec16a59baf05514d22"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight14FlightEndpointE" title="arrow::flight::FlightEndpoint"><span class="n"><span class="pre">FlightEndpoint</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">endpoints</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight10FlightInfo9endpointsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A list of endpoints associated with the flight (dataset). </p> |
| <p>To consume the whole flight, all endpoints must be consumed </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight10FlightInfo13total_recordsEv"> |
| <span id="_CPPv3NK5arrow6flight10FlightInfo13total_recordsEv"></span><span id="_CPPv2NK5arrow6flight10FlightInfo13total_recordsEv"></span><span id="arrow::flight::FlightInfo::total_recordsC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1a9e19c96b3ae8be6c624b56240f4356b8"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">total_records</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight10FlightInfo13total_recordsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The total number of records (rows) in the dataset. If unknown, set to -1. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight10FlightInfo11total_bytesEv"> |
| <span id="_CPPv3NK5arrow6flight10FlightInfo11total_bytesEv"></span><span id="_CPPv2NK5arrow6flight10FlightInfo11total_bytesEv"></span><span id="arrow::flight::FlightInfo::total_bytesC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1a558520833731ca6a747ad6ef5257ecf2"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">total_bytes</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight10FlightInfo11total_bytesEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The total number of bytes in the dataset. If unknown, set to -1. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight10FlightInfo7orderedEv"> |
| <span id="_CPPv3NK5arrow6flight10FlightInfo7orderedEv"></span><span id="_CPPv2NK5arrow6flight10FlightInfo7orderedEv"></span><span id="arrow::flight::FlightInfo::orderedC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1a5d771ec7a17a7793a34d554655670f59"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ordered</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight10FlightInfo7orderedEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Whether endpoints are in the same order as the data. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight10FlightInfo12app_metadataEv"> |
| <span id="_CPPv3NK5arrow6flight10FlightInfo12app_metadataEv"></span><span id="_CPPv2NK5arrow6flight10FlightInfo12app_metadataEv"></span><span id="arrow::flight::FlightInfo::app_metadataC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1a9043dd57f30c6b4ee43a15418d884690"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">app_metadata</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight10FlightInfo12app_metadataEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Application-defined opaque metadata. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight10FlightInfo17SerializeToStringEv"> |
| <span id="_CPPv3NK5arrow6flight10FlightInfo17SerializeToStringEv"></span><span id="_CPPv2NK5arrow6flight10FlightInfo17SerializeToStringEv"></span><span id="arrow::flight::FlightInfo::SerializeToStringC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1aa726411a72d470cd8e1cad88db1e4824"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SerializeToString</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight10FlightInfo17SerializeToStringEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the wire-format representation of this type. </p> |
| <p>Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight10FlightInfo6EqualsERK10FlightInfo"> |
| <span id="_CPPv3NK5arrow6flight10FlightInfo6EqualsERK10FlightInfo"></span><span id="_CPPv2NK5arrow6flight10FlightInfo6EqualsERK10FlightInfo"></span><span id="arrow::flight::FlightInfo::Equals__FlightInfoCRC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1a0022aaca62a25df17c77ecf1bb8bf1d8"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Equals</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">other</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight10FlightInfo6EqualsERK10FlightInfo" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Compare two <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> for equality. </p> |
| <p>This will compare the serialized schema representations, NOT the logical equality of the schemas. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight10FlightInfo4MakeERK6SchemaRK16FlightDescriptorRKNSt6vectorI14FlightEndpointEE7int64_t7int64_tbNSt6stringE"> |
| <span id="_CPPv3N5arrow6flight10FlightInfo4MakeERK6SchemaRK16FlightDescriptorRKNSt6vectorI14FlightEndpointEE7int64_t7int64_tbNSt6stringE"></span><span id="_CPPv2N5arrow6flight10FlightInfo4MakeERK6SchemaRK16FlightDescriptorRKNSt6vectorI14FlightEndpointEE7int64_t7int64_tbNSt6stringE"></span><span id="arrow::flight::FlightInfo::Make__SchemaCR.FlightDescriptorCR.std::vector:FlightEndpoint:CR.int64_t.int64_t.b.ss"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1a770abed156d663e645605cd3e82c6550"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Make</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">schema</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight14FlightEndpointE" title="arrow::flight::FlightEndpoint"><span class="n"><span class="pre">FlightEndpoint</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">endpoints</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">total_records</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">total_bytes</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">ordered</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">false</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">app_metadata</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">""</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight10FlightInfo4MakeERK6SchemaRK16FlightDescriptorRKNSt6vectorI14FlightEndpointEE7int64_t7int64_tbNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Factory method to construct a <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight10FlightInfo11DeserializeENSt11string_viewE"> |
| <span id="_CPPv3N5arrow6flight10FlightInfo11DeserializeENSt11string_viewE"></span><span id="_CPPv2N5arrow6flight10FlightInfo11DeserializeENSt11string_viewE"></span><span id="arrow::flight::FlightInfo::Deserialize__std::string_view"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1abb0816eef84dda9e4ed8c53770754d2d"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Deserialize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string_view</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">serialized</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight10FlightInfo11DeserializeENSt11string_viewE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Parse the wire-format representation of this type. </p> |
| <p>Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types. </p> |
| </dd></dl> |
| |
| </div> |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight10FlightInfo4DataE"> |
| <span id="_CPPv3N5arrow6flight10FlightInfo4DataE"></span><span id="_CPPv2N5arrow6flight10FlightInfo4DataE"></span><span id="arrow::flight::FlightInfo::Data"></span><span class="target" id="structarrow_1_1flight_1_1_flight_info_1_1_data"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Data</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight10FlightInfo4DataE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight13FlightPayloadE"> |
| <span id="_CPPv3N5arrow6flight13FlightPayloadE"></span><span id="_CPPv2N5arrow6flight13FlightPayloadE"></span><span id="arrow::flight::FlightPayload"></span><span class="target" id="structarrow_1_1flight_1_1_flight_payload"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightPayload</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight13FlightPayloadE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Staging data structure for messages about to be put on the wire. </p> |
| <p>This structure corresponds to FlightData in the protocol. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight13FlightPayload8ValidateEv"> |
| <span id="_CPPv3NK5arrow6flight13FlightPayload8ValidateEv"></span><span id="_CPPv2NK5arrow6flight13FlightPayload8ValidateEv"></span><span id="arrow::flight::FlightPayload::ValidateC"></span><span class="target" id="structarrow_1_1flight_1_1_flight_payload_1a904003a2407c6e2401f89da4365efcee"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Validate</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight13FlightPayload8ValidateEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Check that the payload can be written to the wire. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight13FlightListingE"> |
| <span id="_CPPv3N5arrow6flight13FlightListingE"></span><span id="_CPPv2N5arrow6flight13FlightListingE"></span><span id="arrow::flight::FlightListing"></span><span class="target" id="classarrow_1_1flight_1_1_flight_listing"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightListing</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight13FlightListingE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An iterator to <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> instances returned by ListFlights. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1flight_1_1_simple_flight_listing"><span class="std std-ref">arrow::flight::SimpleFlightListing</span></a></p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight13FlightListing4NextEv"> |
| <span id="_CPPv3N5arrow6flight13FlightListing4NextEv"></span><span id="_CPPv2N5arrow6flight13FlightListing4NextEv"></span><span id="arrow::flight::FlightListing::Next"></span><span class="target" id="classarrow_1_1flight_1_1_flight_listing_1accdfcab658dcf6b51c90747d2b49231e"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Next</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight13FlightListing4NextEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the next <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> from the iterator. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Arrow result with a single <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a>. Set to <em>nullptr</em> if there are none left. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp enum-class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethodE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethodE"></span><span id="_CPPv2N5arrow6flight12FlightMethodE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">flight</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">FlightMethod</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethodE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An enumeration of the RPC methods Flight implements. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod7InvalidE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod7InvalidE"></span><span id="_CPPv2N5arrow6flight12FlightMethod7InvalidE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a4bbb8f967da6d1a610596d7257179c2b"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Invalid</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod7InvalidE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod9HandshakeE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod9HandshakeE"></span><span id="_CPPv2N5arrow6flight12FlightMethod9HandshakeE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a7559811a22a9c4b79332bd85a197e4c5"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Handshake</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod9HandshakeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod11ListFlightsE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod11ListFlightsE"></span><span id="_CPPv2N5arrow6flight12FlightMethod11ListFlightsE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a05c19eb1b6596dd2588a8b09cc246ef4"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ListFlights</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod11ListFlightsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod13GetFlightInfoE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod13GetFlightInfoE"></span><span id="_CPPv2N5arrow6flight12FlightMethod13GetFlightInfoE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9aebfc9ab310a15a21c35657482c3450b8"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfo</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod13GetFlightInfoE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod9GetSchemaE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod9GetSchemaE"></span><span id="_CPPv2N5arrow6flight12FlightMethod9GetSchemaE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a8d3cfdcce46efdccebb2a0c7ee3eadc3"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSchema</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod9GetSchemaE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod5DoGetE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod5DoGetE"></span><span id="_CPPv2N5arrow6flight12FlightMethod5DoGetE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a3554dde31575307018486d06a5937808"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGet</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod5DoGetE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod5DoPutE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod5DoPutE"></span><span id="_CPPv2N5arrow6flight12FlightMethod5DoPutE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9ae514ccb580e9528bc16903b05ae550c7"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoPut</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod5DoPutE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod8DoActionE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod8DoActionE"></span><span id="_CPPv2N5arrow6flight12FlightMethod8DoActionE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a2be1259a544968886c788fa905020bc9"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoAction</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod8DoActionE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod11ListActionsE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod11ListActionsE"></span><span id="_CPPv2N5arrow6flight12FlightMethod11ListActionsE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a7676138469fbafceabd2e7cf7533c027"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ListActions</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod11ListActionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod10DoExchangeE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod10DoExchangeE"></span><span id="_CPPv2N5arrow6flight12FlightMethod10DoExchangeE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a10dd9d9d389f6546b7e80f4b6038b62b"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoExchange</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod10DoExchangeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod14PollFlightInfoE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod14PollFlightInfoE"></span><span id="_CPPv2N5arrow6flight12FlightMethod14PollFlightInfoE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a307548368be8d035074b8570deb4d3dc"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PollFlightInfo</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod14PollFlightInfoE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8LocationE"> |
| <span id="_CPPv3N5arrow6flight8LocationE"></span><span id="_CPPv2N5arrow6flight8LocationE"></span><span id="arrow::flight::Location"></span><span class="target" id="structarrow_1_1flight_1_1_location"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Location</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight8LocationE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A host location (a URI) </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8Location8LocationEv"> |
| <span id="_CPPv3N5arrow6flight8Location8LocationEv"></span><span id="_CPPv2N5arrow6flight8Location8LocationEv"></span><span id="arrow::flight::Location::Location"></span><span class="target" id="structarrow_1_1flight_1_1_location_1a7428db46789c3d40ccc63f40b2b823cd"></span><span class="sig-name descname"><span class="n"><span class="pre">Location</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight8Location8LocationEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Initialize a blank location. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight8Location8ToStringEv"> |
| <span id="_CPPv3NK5arrow6flight8Location8ToStringEv"></span><span id="_CPPv2NK5arrow6flight8Location8ToStringEv"></span><span id="arrow::flight::Location::ToStringC"></span><span class="target" id="structarrow_1_1flight_1_1_location_1adaa5abc85f6f527e2c5b1ba3f52015cd"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight8Location8ToStringEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a representation of this URI as a string. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight8Location6schemeEv"> |
| <span id="_CPPv3NK5arrow6flight8Location6schemeEv"></span><span id="_CPPv2NK5arrow6flight8Location6schemeEv"></span><span id="arrow::flight::Location::schemeC"></span><span class="target" id="structarrow_1_1flight_1_1_location_1a9103044f6a0aee9674ff695a29a74db6"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">scheme</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight8Location6schemeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the scheme of this URI. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8Location5ParseERKNSt6stringE"> |
| <span id="_CPPv3N5arrow6flight8Location5ParseERKNSt6stringE"></span><span id="_CPPv2N5arrow6flight8Location5ParseERKNSt6stringE"></span><span id="arrow::flight::Location::Parse__ssCR"></span><span class="target" id="structarrow_1_1flight_1_1_location_1a8a9ed7a70cf86559a0cb9a101f266b5e"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Parse</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">uri_string</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight8Location5ParseERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Initialize a location by parsing a URI string. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8Location15ReuseConnectionEv"> |
| <span id="_CPPv3N5arrow6flight8Location15ReuseConnectionEv"></span><span id="_CPPv2N5arrow6flight8Location15ReuseConnectionEv"></span><span id="arrow::flight::Location::ReuseConnection"></span><span class="target" id="structarrow_1_1flight_1_1_location_1a35c808a4d9fa5a461f82a7281d8b2fe0"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">ReuseConnection</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight8Location15ReuseConnectionEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the fallback URI. </p> |
| <p>arrow-flight-reuse-connection://? means that a client may attempt to reuse an existing connection to a Flight service to fetch data instead of creating a new connection to one of the other locations listed in a <a class="reference internal" href="#structarrow_1_1flight_1_1_flight_endpoint"><span class="std std-ref">FlightEndpoint</span></a> response. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8Location10ForGrpcTcpERKNSt6stringEKi"> |
| <span id="_CPPv3N5arrow6flight8Location10ForGrpcTcpERKNSt6stringEKi"></span><span id="_CPPv2N5arrow6flight8Location10ForGrpcTcpERKNSt6stringEKi"></span><span id="arrow::flight::Location::ForGrpcTcp__ssCR.iC"></span><span class="target" id="structarrow_1_1flight_1_1_location_1a92e39472067fc6b7ffede6e5942fee48"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ForGrpcTcp</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">host</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">port</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight8Location10ForGrpcTcpERKNSt6stringEKi" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Initialize a location for a non-TLS, gRPC-based Flight service from a host and port. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>host</strong> – <strong>[in]</strong> The hostname to connect to </p></li> |
| <li><p><strong>port</strong> – <strong>[in]</strong> The port </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with the resulting location </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8Location10ForGrpcTlsERKNSt6stringEKi"> |
| <span id="_CPPv3N5arrow6flight8Location10ForGrpcTlsERKNSt6stringEKi"></span><span id="_CPPv2N5arrow6flight8Location10ForGrpcTlsERKNSt6stringEKi"></span><span id="arrow::flight::Location::ForGrpcTls__ssCR.iC"></span><span class="target" id="structarrow_1_1flight_1_1_location_1a9dab9bca24f02036fdb82c5aeb16d652"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ForGrpcTls</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">host</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">port</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight8Location10ForGrpcTlsERKNSt6stringEKi" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Initialize a location for a TLS-enabled, gRPC-based Flight service from a host and port. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>host</strong> – <strong>[in]</strong> The hostname to connect to </p></li> |
| <li><p><strong>port</strong> – <strong>[in]</strong> The port </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with the resulting location </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8Location11ForGrpcUnixERKNSt6stringE"> |
| <span id="_CPPv3N5arrow6flight8Location11ForGrpcUnixERKNSt6stringE"></span><span id="_CPPv2N5arrow6flight8Location11ForGrpcUnixERKNSt6stringE"></span><span id="arrow::flight::Location::ForGrpcUnix__ssCR"></span><span class="target" id="structarrow_1_1flight_1_1_location_1a9c8fa70788dae29006749a610e187f35"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ForGrpcUnix</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">path</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight8Location11ForGrpcUnixERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Initialize a location for a domain socket-based Flight service. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>path</strong> – <strong>[in]</strong> The path to the domain socket </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with the resulting location </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8Location9ForSchemeERKNSt6stringERKNSt6stringEKi"> |
| <span id="_CPPv3N5arrow6flight8Location9ForSchemeERKNSt6stringERKNSt6stringEKi"></span><span id="_CPPv2N5arrow6flight8Location9ForSchemeERKNSt6stringERKNSt6stringEKi"></span><span id="arrow::flight::Location::ForScheme__ssCR.ssCR.iC"></span><span class="target" id="structarrow_1_1flight_1_1_location_1a36717906295c890b8acf5add29a066a6"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ForScheme</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">scheme</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">host</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">port</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight8Location9ForSchemeERKNSt6stringERKNSt6stringEKi" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Initialize a location based on a URI scheme. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight25MetadataRecordBatchReaderE"> |
| <span id="_CPPv3N5arrow6flight25MetadataRecordBatchReaderE"></span><span id="_CPPv2N5arrow6flight25MetadataRecordBatchReaderE"></span><span id="arrow::flight::MetadataRecordBatchReader"></span><span class="target" id="classarrow_1_1flight_1_1_metadata_record_batch_reader"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MetadataRecordBatchReader</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight25MetadataRecordBatchReaderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An interface to read Flight data with metadata. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_message_reader"><span class="std std-ref">arrow::flight::FlightMessageReader</span></a>, <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_stream_reader"><span class="std std-ref">arrow::flight::FlightStreamReader</span></a></p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight25MetadataRecordBatchReader9GetSchemaEv"> |
| <span id="_CPPv3N5arrow6flight25MetadataRecordBatchReader9GetSchemaEv"></span><span id="_CPPv2N5arrow6flight25MetadataRecordBatchReader9GetSchemaEv"></span><span id="arrow::flight::MetadataRecordBatchReader::GetSchema"></span><span class="target" id="classarrow_1_1flight_1_1_metadata_record_batch_reader_1aa0eeeb0a8e43c0941fc7f25164316641"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSchema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight25MetadataRecordBatchReader9GetSchemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the schema for this stream. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight25MetadataRecordBatchReader4NextEv"> |
| <span id="_CPPv3N5arrow6flight25MetadataRecordBatchReader4NextEv"></span><span id="_CPPv2N5arrow6flight25MetadataRecordBatchReader4NextEv"></span><span id="arrow::flight::MetadataRecordBatchReader::Next"></span><span class="target" id="classarrow_1_1flight_1_1_metadata_record_batch_reader_1adfb00820f2c4848d21759aa20c51fde0"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">FlightStreamChunk</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Next</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight25MetadataRecordBatchReader4NextEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the next message from Flight. </p> |
| <p>If the stream is finished, then the members of <em>FlightStreamChunk</em> will be nullptr. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight25MetadataRecordBatchReader15ToRecordBatchesEv"> |
| <span id="_CPPv3N5arrow6flight25MetadataRecordBatchReader15ToRecordBatchesEv"></span><span id="_CPPv2N5arrow6flight25MetadataRecordBatchReader15ToRecordBatchesEv"></span><span id="arrow::flight::MetadataRecordBatchReader::ToRecordBatches"></span><span class="target" id="classarrow_1_1flight_1_1_metadata_record_batch_reader_1a1d187521cd0e812cd77b3b3039060be2"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="table.html#_CPPv4N5arrow11RecordBatchE" title="arrow::RecordBatch"><span class="n"><span class="pre">RecordBatch</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToRecordBatches</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight25MetadataRecordBatchReader15ToRecordBatchesEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Consume entire stream as a vector of record batches. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight25MetadataRecordBatchReader7ToTableEv"> |
| <span id="_CPPv3N5arrow6flight25MetadataRecordBatchReader7ToTableEv"></span><span id="_CPPv2N5arrow6flight25MetadataRecordBatchReader7ToTableEv"></span><span id="arrow::flight::MetadataRecordBatchReader::ToTable"></span><span class="target" id="classarrow_1_1flight_1_1_metadata_record_batch_reader_1af42a446532c83cfaae038a74e52cfd11"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="table.html#_CPPv4N5arrow5TableE" title="arrow::Table"><span class="n"><span class="pre">Table</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToTable</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight25MetadataRecordBatchReader7ToTableEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Consume entire stream as a <a class="reference internal" href="table.html#classarrow_1_1_table"><span class="std std-ref">Table</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight6ResultE"> |
| <span id="_CPPv3N5arrow6flight6ResultE"></span><span id="_CPPv2N5arrow6flight6ResultE"></span><span id="arrow::flight::Result"></span><span class="target" id="structarrow_1_1flight_1_1_result"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Result</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight6ResultE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Opaque result returned after executing an action. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight6Result17SerializeToStringEv"> |
| <span id="_CPPv3NK5arrow6flight6Result17SerializeToStringEv"></span><span id="_CPPv2NK5arrow6flight6Result17SerializeToStringEv"></span><span id="arrow::flight::Result::SerializeToStringC"></span><span class="target" id="structarrow_1_1flight_1_1_result_1aff6fe809e4d3019d8b2f48fcbd2e2ec9"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SerializeToString</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight6Result17SerializeToStringEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Serialize this message to its wire-format representation. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight6Result11DeserializeENSt11string_viewE"> |
| <span id="_CPPv3N5arrow6flight6Result11DeserializeENSt11string_viewE"></span><span id="_CPPv2N5arrow6flight6Result11DeserializeENSt11string_viewE"></span><span id="arrow::flight::Result::Deserialize__std::string_view"></span><span class="target" id="structarrow_1_1flight_1_1_result_1aaadf77f38cecd13933a8a6685c23dad0"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight6ResultE" title="arrow::flight::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Deserialize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string_view</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">serialized</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight6Result11DeserializeENSt11string_viewE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Deserialize this message from its wire-format representation. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12ResultStreamE"> |
| <span id="_CPPv3N5arrow6flight12ResultStreamE"></span><span id="_CPPv2N5arrow6flight12ResultStreamE"></span><span id="arrow::flight::ResultStream"></span><span class="target" id="classarrow_1_1flight_1_1_result_stream"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ResultStream</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12ResultStreamE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An iterator to <a class="reference internal" href="#structarrow_1_1flight_1_1_result"><span class="std std-ref">Result</span></a> instances returned by DoAction. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1flight_1_1_simple_result_stream"><span class="std std-ref">arrow::flight::SimpleResultStream</span></a></p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12ResultStream4NextEv"> |
| <span id="_CPPv3N5arrow6flight12ResultStream4NextEv"></span><span id="_CPPv2N5arrow6flight12ResultStream4NextEv"></span><span id="arrow::flight::ResultStream::Next"></span><span class="target" id="classarrow_1_1flight_1_1_result_stream_1af18594613ac871c8ae8670eba3772424"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight6ResultE" title="arrow::flight::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Next</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12ResultStream4NextEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the next <a class="reference internal" href="#structarrow_1_1flight_1_1_result"><span class="std std-ref">Result</span></a> from the iterator. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Arrow result with a single <a class="reference internal" href="#structarrow_1_1flight_1_1_result"><span class="std std-ref">Result</span></a>. Set to <em>nullptr</em> if there are none left. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12ResultStream5DrainEv"> |
| <span id="_CPPv3N5arrow6flight12ResultStream5DrainEv"></span><span id="_CPPv2N5arrow6flight12ResultStream5DrainEv"></span><span id="arrow::flight::ResultStream::Drain"></span><span class="target" id="classarrow_1_1flight_1_1_result_stream_1a6ebd5252a431b437ab6fd385ddd1c0c9"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Drain</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12ResultStream5DrainEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Read and drop the remaining messages to get the error (if any) from a server. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> OK if this is no error from a server, any other status if a server returns an error. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight6TicketE"> |
| <span id="_CPPv3N5arrow6flight6TicketE"></span><span id="_CPPv2N5arrow6flight6TicketE"></span><span id="arrow::flight::Ticket"></span><span class="target" id="structarrow_1_1flight_1_1_ticket"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Ticket</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight6TicketE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Data structure providing an opaque identifier or credential to use when requesting a data stream with the DoGet RPC. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight6Ticket17SerializeToStringEv"> |
| <span id="_CPPv3NK5arrow6flight6Ticket17SerializeToStringEv"></span><span id="_CPPv2NK5arrow6flight6Ticket17SerializeToStringEv"></span><span id="arrow::flight::Ticket::SerializeToStringC"></span><span class="target" id="structarrow_1_1flight_1_1_ticket_1a38b2d9baabe03dcdfafb82fe4ae5eb0f"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SerializeToString</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight6Ticket17SerializeToStringEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the wire-format representation of this type. </p> |
| <p>Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight6Ticket11DeserializeENSt11string_viewE"> |
| <span id="_CPPv3N5arrow6flight6Ticket11DeserializeENSt11string_viewE"></span><span id="_CPPv2N5arrow6flight6Ticket11DeserializeENSt11string_viewE"></span><span id="arrow::flight::Ticket::Deserialize__std::string_view"></span><span class="target" id="structarrow_1_1flight_1_1_ticket_1adf96a2709a6ca53177f063e6104d36aa"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight6TicketE" title="arrow::flight::Ticket"><span class="n"><span class="pre">Ticket</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Deserialize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string_view</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">serialized</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight6Ticket11DeserializeENSt11string_viewE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Parse the wire-format representation of this type. </p> |
| <p>Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </section> |
| <section id="clients"> |
| <h2>Clients<a class="headerlink" href="#clients" title="Permalink to this heading">#</a></h2> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClientE"> |
| <span id="_CPPv3N5arrow6flight12FlightClientE"></span><span id="_CPPv2N5arrow6flight12FlightClientE"></span><span id="arrow::flight::FlightClient"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightClient</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClientE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Client class for Arrow Flight RPC services. </p> |
| <p>API experimental for now </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient12AuthenticateERK17FlightCallOptionsNSt10unique_ptrI17ClientAuthHandlerEE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient12AuthenticateERK17FlightCallOptionsNSt10unique_ptrI17ClientAuthHandlerEE"></span><span id="_CPPv2N5arrow6flight12FlightClient12AuthenticateERK17FlightCallOptionsNSt10unique_ptrI17ClientAuthHandlerEE"></span><span id="arrow::flight::FlightClient::Authenticate__FlightCallOptionsCR.std::unique_ptr:ClientAuthHandler:"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1aed24e3c298ae6669e7cade15aafd6eeb"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Authenticate</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight17ClientAuthHandlerE" title="arrow::flight::ClientAuthHandler"><span class="n"><span class="pre">ClientAuthHandler</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">auth_handler</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient12AuthenticateERK17FlightCallOptionsNSt10unique_ptrI17ClientAuthHandlerEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Authenticate to the server using the given handler. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>auth_handler</strong> – <strong>[in]</strong> The authentication mechanism to use </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> OK if the client authenticated successfully </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient22AuthenticateBasicTokenERK17FlightCallOptionsRKNSt6stringERKNSt6stringE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient22AuthenticateBasicTokenERK17FlightCallOptionsRKNSt6stringERKNSt6stringE"></span><span id="_CPPv2N5arrow6flight12FlightClient22AuthenticateBasicTokenERK17FlightCallOptionsRKNSt6stringERKNSt6stringE"></span><span id="arrow::flight::FlightClient::AuthenticateBasicToken__FlightCallOptionsCR.ssCR.ssCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a43bd8581511ebacf2ac656b294d0176e"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">pair</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AuthenticateBasicToken</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">username</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">password</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient22AuthenticateBasicTokenERK17FlightCallOptionsRKNSt6stringERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Authenticate to the server using basic HTTP style authentication. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>username</strong> – <strong>[in]</strong> Username to use </p></li> |
| <li><p><strong>password</strong> – <strong>[in]</strong> Password to use </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with bearer token and status OK if client authenticated successfully </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient8DoActionERK17FlightCallOptionsRK6Action"> |
| <span id="_CPPv3N5arrow6flight12FlightClient8DoActionERK17FlightCallOptionsRK6Action"></span><span id="_CPPv2N5arrow6flight12FlightClient8DoActionERK17FlightCallOptionsRK6Action"></span><span id="arrow::flight::FlightClient::DoAction__FlightCallOptionsCR.ActionCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1ae790acbfc5c47fc216f0f018ad6f9876"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight12ResultStreamE" title="arrow::flight::ResultStream"><span class="n"><span class="pre">ResultStream</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoAction</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight6ActionE" title="arrow::flight::Action"><span class="n"><span class="pre">Action</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">action</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient8DoActionERK17FlightCallOptionsRK6Action" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Perform the indicated action, returning an iterator to the stream of results, if any. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>action</strong> – <strong>[in]</strong> the action to be performed </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with an iterator object for reading the returned results </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient16CancelFlightInfoERK17FlightCallOptionsRK23CancelFlightInfoRequest"> |
| <span id="_CPPv3N5arrow6flight12FlightClient16CancelFlightInfoERK17FlightCallOptionsRK23CancelFlightInfoRequest"></span><span id="_CPPv2N5arrow6flight12FlightClient16CancelFlightInfoERK17FlightCallOptionsRK23CancelFlightInfoRequest"></span><span id="arrow::flight::FlightClient::CancelFlightInfo__FlightCallOptionsCR.CancelFlightInfoRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a34371d68f52e782006acfd331cb994bf"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">CancelFlightInfoResult</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CancelFlightInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">CancelFlightInfoRequest</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient16CancelFlightInfoERK17FlightCallOptionsRK23CancelFlightInfoRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Perform the CancelFlightInfo action, returning a CancelFlightInfoResult. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The CancelFlightInfoRequest</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with a CancelFlightInfoResult</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient19RenewFlightEndpointERK17FlightCallOptionsRK26RenewFlightEndpointRequest"> |
| <span id="_CPPv3N5arrow6flight12FlightClient19RenewFlightEndpointERK17FlightCallOptionsRK26RenewFlightEndpointRequest"></span><span id="_CPPv2N5arrow6flight12FlightClient19RenewFlightEndpointERK17FlightCallOptionsRK26RenewFlightEndpointRequest"></span><span id="arrow::flight::FlightClient::RenewFlightEndpoint__FlightCallOptionsCR.RenewFlightEndpointRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1ac0f9191818e180a9a3665f90cc855d91"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight14FlightEndpointE" title="arrow::flight::FlightEndpoint"><span class="n"><span class="pre">FlightEndpoint</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">RenewFlightEndpoint</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">RenewFlightEndpointRequest</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient19RenewFlightEndpointERK17FlightCallOptionsRK26RenewFlightEndpointRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Perform the RenewFlightEndpoint action, returning a renewed <a class="reference internal" href="#structarrow_1_1flight_1_1_flight_endpoint"><span class="std std-ref">FlightEndpoint</span></a>. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The RenewFlightEndpointRequest</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with a renewed <a class="reference internal" href="#structarrow_1_1flight_1_1_flight_endpoint"><span class="std std-ref">FlightEndpoint</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient11ListActionsERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight12FlightClient11ListActionsERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight12FlightClient11ListActionsERK17FlightCallOptions"></span><span id="arrow::flight::FlightClient::ListActions__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1add9deadb1c02386c53b9b72328bde1de"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight10ActionTypeE" title="arrow::flight::ActionType"><span class="n"><span class="pre">ActionType</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ListActions</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient11ListActionsERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve a list of available <a class="reference internal" href="#structarrow_1_1flight_1_1_action"><span class="std std-ref">Action</span></a> types. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with the available actions </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient13GetFlightInfoERK17FlightCallOptionsRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight12FlightClient13GetFlightInfoERK17FlightCallOptionsRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight12FlightClient13GetFlightInfoERK17FlightCallOptionsRK16FlightDescriptor"></span><span id="arrow::flight::FlightClient::GetFlightInfo__FlightCallOptionsCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a6ed075ea94c4c84e0c8d74376a88ef00"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient13GetFlightInfoERK17FlightCallOptionsRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Request access plan for a single flight, which may be an existing dataset or a command to be executed. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> the dataset request, whether a named dataset or command </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with the <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient18GetFlightInfoAsyncERK17FlightCallOptionsRK16FlightDescriptorNSt10shared_ptrI13AsyncListenerI10FlightInfoEEE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient18GetFlightInfoAsyncERK17FlightCallOptionsRK16FlightDescriptorNSt10shared_ptrI13AsyncListenerI10FlightInfoEEE"></span><span id="_CPPv2N5arrow6flight12FlightClient18GetFlightInfoAsyncERK17FlightCallOptionsRK16FlightDescriptorNSt10shared_ptrI13AsyncListenerI10FlightInfoEEE"></span><span id="arrow::flight::FlightClient::GetFlightInfoAsync__FlightCallOptionsCR.FlightDescriptorCR.std::shared_ptr:AsyncListener:FlightInfo::"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1aca651d7c5bafdd9367c56c0637814655"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfoAsync</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">AsyncListener</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">listener</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient18GetFlightInfoAsyncERK17FlightCallOptionsRK16FlightDescriptorNSt10shared_ptrI13AsyncListenerI10FlightInfoEEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Asynchronous GetFlightInfo. </p> |
| <p> |
| This API is EXPERIMENTAL. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> the dataset request </p></li> |
| <li><p><strong>listener</strong> – <strong>[in]</strong> Callbacks for response and RPC completion</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient18GetFlightInfoAsyncERK17FlightCallOptionsRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight12FlightClient18GetFlightInfoAsyncERK17FlightCallOptionsRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight12FlightClient18GetFlightInfoAsyncERK17FlightCallOptionsRK16FlightDescriptor"></span><span id="arrow::flight::FlightClient::GetFlightInfoAsync__FlightCallOptionsCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a0acb7faf01dcdb46b8e2eb26b743ac45"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="async.html#_CPPv4I0EN5arrow6FutureE" title="arrow::Future"><span class="n"><span class="pre">Future</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfoAsync</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient18GetFlightInfoAsyncERK17FlightCallOptionsRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Asynchronous GetFlightInfo returning a <a class="reference internal" href="async.html#classarrow_1_1_future"><span class="std std-ref">Future</span></a>. </p> |
| <p> |
| This API is EXPERIMENTAL. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> the dataset request</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient14PollFlightInfoERK17FlightCallOptionsRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight12FlightClient14PollFlightInfoERK17FlightCallOptionsRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight12FlightClient14PollFlightInfoERK17FlightCallOptionsRK16FlightDescriptor"></span><span id="arrow::flight::FlightClient::PollFlightInfo__FlightCallOptionsCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a30a2b8995d8778449b01ed20fc33888a"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">PollInfo</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PollFlightInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient14PollFlightInfoERK17FlightCallOptionsRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Request and poll a long running query. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> the dataset request or a descriptor returned by a prior PollFlightInfo call </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with the PollInfo describing the status of the requested query </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient9GetSchemaERK17FlightCallOptionsRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight12FlightClient9GetSchemaERK17FlightCallOptionsRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight12FlightClient9GetSchemaERK17FlightCallOptionsRK16FlightDescriptor"></span><span id="arrow::flight::FlightClient::GetSchema__FlightCallOptionsCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1ab9b124b2acbc90b231d4e4da37f5fa7e"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient9GetSchemaERK17FlightCallOptionsRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Request schema for a single flight, which may be an existing dataset or a command to be executed. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> the dataset request, whether a named dataset or command </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with the SchemaResult describing the dataset schema </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient11ListFlightsEv"> |
| <span id="_CPPv3N5arrow6flight12FlightClient11ListFlightsEv"></span><span id="_CPPv2N5arrow6flight12FlightClient11ListFlightsEv"></span><span id="arrow::flight::FlightClient::ListFlights"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a95ec27df872b3f6f0d5a1e44290c3826"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight13FlightListingE" title="arrow::flight::FlightListing"><span class="n"><span class="pre">FlightListing</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ListFlights</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient11ListFlightsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>List all available flights known to the server. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Arrow result with an iterator that returns a <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> for each flight </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient11ListFlightsERK17FlightCallOptionsRK8Criteria"> |
| <span id="_CPPv3N5arrow6flight12FlightClient11ListFlightsERK17FlightCallOptionsRK8Criteria"></span><span id="_CPPv2N5arrow6flight12FlightClient11ListFlightsERK17FlightCallOptionsRK8Criteria"></span><span id="arrow::flight::FlightClient::ListFlights__FlightCallOptionsCR.CriteriaCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a196178f0a8a3b7586681ff100cfce725"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight13FlightListingE" title="arrow::flight::FlightListing"><span class="n"><span class="pre">FlightListing</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ListFlights</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight8CriteriaE" title="arrow::flight::Criteria"><span class="n"><span class="pre">Criteria</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">criteria</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient11ListFlightsERK17FlightCallOptionsRK8Criteria" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>List available flights given indicated filter criteria. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>criteria</strong> – <strong>[in]</strong> the filter criteria (opaque) </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with an iterator that returns a <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> for each flight </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient5DoGetERK17FlightCallOptionsRK6Ticket"> |
| <span id="_CPPv3N5arrow6flight12FlightClient5DoGetERK17FlightCallOptionsRK6Ticket"></span><span id="_CPPv2N5arrow6flight12FlightClient5DoGetERK17FlightCallOptionsRK6Ticket"></span><span id="arrow::flight::FlightClient::DoGet__FlightCallOptionsCR.TicketCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a42c2cba8d9729acc0ba8a5f9d2983596"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight18FlightStreamReaderE" title="arrow::flight::FlightStreamReader"><span class="n"><span class="pre">FlightStreamReader</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGet</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight6TicketE" title="arrow::flight::Ticket"><span class="n"><span class="pre">Ticket</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">ticket</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient5DoGetERK17FlightCallOptionsRK6Ticket" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Given a flight ticket and schema, request to be sent the stream. </p> |
| <p>Returns record batch stream reader </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>ticket</strong> – <strong>[in]</strong> The flight ticket to use </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with the returned <a class="reference internal" href="table.html#classarrow_1_1_record_batch_reader"><span class="std std-ref">RecordBatchReader</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient5DoPutERK17FlightCallOptionsRK16FlightDescriptorRKNSt10shared_ptrI6SchemaEE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient5DoPutERK17FlightCallOptionsRK16FlightDescriptorRKNSt10shared_ptrI6SchemaEE"></span><span id="_CPPv2N5arrow6flight12FlightClient5DoPutERK17FlightCallOptionsRK16FlightDescriptorRKNSt10shared_ptrI6SchemaEE"></span><span id="arrow::flight::FlightClient::DoPut__FlightCallOptionsCR.FlightDescriptorCR.std::shared_ptr:Schema:CR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a0e6659cdcf500f6eaf62eacaf25c77dc"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight12FlightClient11DoPutResultE" title="arrow::flight::FlightClient::DoPutResult"><span class="n"><span class="pre">DoPutResult</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoPut</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">schema</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient5DoPutERK17FlightCallOptionsRK16FlightDescriptorRKNSt10shared_ptrI6SchemaEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Upload data to a Flight described by the given descriptor. </p> |
| <p>The caller must call <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_client_1abb7ec36ab901c7d103082715237c436a"><span class="std std-ref">Close()</span></a> on the returned stream once they are done writing.</p> |
| <p>The reader and writer are linked; closing the writer will also close the reader. Use <em>DoneWriting</em> to only close the write side of the channel.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> the descriptor of the stream </p></li> |
| <li><p><strong>schema</strong> – <strong>[in]</strong> the schema for the data to upload </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with a <a class="reference internal" href="#structarrow_1_1flight_1_1_flight_client_1_1_do_put_result"><span class="std std-ref">DoPutResult</span></a> struct holding a reader and a writer </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient17SetSessionOptionsERK17FlightCallOptionsRK24SetSessionOptionsRequest"> |
| <span id="_CPPv3N5arrow6flight12FlightClient17SetSessionOptionsERK17FlightCallOptionsRK24SetSessionOptionsRequest"></span><span id="_CPPv2N5arrow6flight12FlightClient17SetSessionOptionsERK17FlightCallOptionsRK24SetSessionOptionsRequest"></span><span id="arrow::flight::FlightClient::SetSessionOptions__FlightCallOptionsCR.SetSessionOptionsRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a261d1652ecabb8869d1966ab936a012e"></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SetSessionOptionsResult</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SetSessionOptions</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">SetSessionOptionsRequest</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient17SetSessionOptionsERK17FlightCallOptionsRK24SetSessionOptionsRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Set server session option(s) by name/value. </p> |
| <p>Sessions are generally persisted via HTTP cookies. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The server session options to set </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient17GetSessionOptionsERK17FlightCallOptionsRK24GetSessionOptionsRequest"> |
| <span id="_CPPv3N5arrow6flight12FlightClient17GetSessionOptionsERK17FlightCallOptionsRK24GetSessionOptionsRequest"></span><span id="_CPPv2N5arrow6flight12FlightClient17GetSessionOptionsERK17FlightCallOptionsRK24GetSessionOptionsRequest"></span><span id="arrow::flight::FlightClient::GetSessionOptions__FlightCallOptionsCR.GetSessionOptionsRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1ad2ba4bc3618f0105fba450551fa756bd"></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">GetSessionOptionsResult</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSessionOptions</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">GetSessionOptionsRequest</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient17GetSessionOptionsERK17FlightCallOptionsRK24GetSessionOptionsRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the current server session options. </p> |
| <p>The session is generally accessed via an HTTP cookie. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The (empty) GetSessionOptions request object. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient12CloseSessionERK17FlightCallOptionsRK19CloseSessionRequest"> |
| <span id="_CPPv3N5arrow6flight12FlightClient12CloseSessionERK17FlightCallOptionsRK19CloseSessionRequest"></span><span id="_CPPv2N5arrow6flight12FlightClient12CloseSessionERK17FlightCallOptionsRK19CloseSessionRequest"></span><span id="arrow::flight::FlightClient::CloseSession__FlightCallOptionsCR.CloseSessionRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a63300d272dd495245c08658f0985ed61"></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">CloseSessionResult</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CloseSession</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">CloseSessionRequest</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient12CloseSessionERK17FlightCallOptionsRK19CloseSessionRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Close/invalidate the current server session. </p> |
| <p>The session is generally accessed via an HTTP cookie. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The (empty) CloseSession request object. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient5CloseEv"> |
| <span id="_CPPv3N5arrow6flight12FlightClient5CloseEv"></span><span id="_CPPv2N5arrow6flight12FlightClient5CloseEv"></span><span id="arrow::flight::FlightClient::Close"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1abb7ec36ab901c7d103082715237c436a"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Close</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient5CloseEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Explicitly shut down and clean up the client. </p> |
| <p>For backwards compatibility, this will be implicitly called by the destructor if not already called, but this gives the application no chance to handle errors, so it is recommended to explicitly close the client.</p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>8.0.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight12FlightClient14supports_asyncEv"> |
| <span id="_CPPv3NK5arrow6flight12FlightClient14supports_asyncEv"></span><span id="_CPPv2NK5arrow6flight12FlightClient14supports_asyncEv"></span><span id="arrow::flight::FlightClient::supports_asyncC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1aa5c2f4ef4d0033a81c9efcd13b87737a"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">supports_async</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight12FlightClient14supports_asyncEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Whether this client supports asynchronous methods. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight12FlightClient17CheckAsyncSupportEv"> |
| <span id="_CPPv3NK5arrow6flight12FlightClient17CheckAsyncSupportEv"></span><span id="_CPPv2NK5arrow6flight12FlightClient17CheckAsyncSupportEv"></span><span id="arrow::flight::FlightClient::CheckAsyncSupportC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a35b8e421acdb948b79b91e0b36304149"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CheckAsyncSupport</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight12FlightClient17CheckAsyncSupportEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Check whether this client supports asynchronous methods. </p> |
| <p>This is like <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_client_1aa5c2f4ef4d0033a81c9efcd13b87737a"><span class="std std-ref">supports_async()</span></a>, except that a detailed error message is returned if async support is not available. If async support is available, this function returns successfully. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient7ConnectERK8Location"> |
| <span id="_CPPv3N5arrow6flight12FlightClient7ConnectERK8Location"></span><span id="_CPPv2N5arrow6flight12FlightClient7ConnectERK8Location"></span><span id="arrow::flight::FlightClient::Connect__LocationCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1acc555e5cc396d46894b6520d8d8a68d0"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight12FlightClientE" title="arrow::flight::FlightClient"><span class="n"><span class="pre">FlightClient</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Connect</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">location</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient7ConnectERK8Location" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Connect to an unauthenticated flight service. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>location</strong> – <strong>[in]</strong> the URI </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with the created <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_client"><span class="std std-ref">FlightClient</span></a>, OK status may not indicate that the connection was successful </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient7ConnectERK8LocationRK19FlightClientOptions"> |
| <span id="_CPPv3N5arrow6flight12FlightClient7ConnectERK8LocationRK19FlightClientOptions"></span><span id="_CPPv2N5arrow6flight12FlightClient7ConnectERK8LocationRK19FlightClientOptions"></span><span id="arrow::flight::FlightClient::Connect__LocationCR.FlightClientOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1ade71b678cb6df4e8a6cc97b276741040"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight12FlightClientE" title="arrow::flight::FlightClient"><span class="n"><span class="pre">FlightClient</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Connect</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">location</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight19FlightClientOptionsE" title="arrow::flight::FlightClientOptions"><span class="n"><span class="pre">FlightClientOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient7ConnectERK8LocationRK19FlightClientOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Connect to an unauthenticated flight service. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>location</strong> – <strong>[in]</strong> the URI </p></li> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Other options for setting up the client </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with the created <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_client"><span class="std std-ref">FlightClient</span></a>, OK status may not indicate that the connection was successful </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient16DoExchangeResultE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient16DoExchangeResultE"></span><span id="_CPPv2N5arrow6flight12FlightClient16DoExchangeResultE"></span><span id="arrow::flight::FlightClient::DoExchangeResult"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_1_1_do_exchange_result"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoExchangeResult</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient16DoExchangeResultE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient11DoPutResultE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient11DoPutResultE"></span><span id="_CPPv2N5arrow6flight12FlightClient11DoPutResultE"></span><span id="arrow::flight::FlightClient::DoPutResult"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_1_1_do_put_result"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoPutResult</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient11DoPutResultE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>DoPut return value. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient11DoPutResult6writerE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient11DoPutResult6writerE"></span><span id="_CPPv2N5arrow6flight12FlightClient11DoPutResult6writerE"></span><span id="arrow::flight::FlightClient::DoPutResult::writer__std::unique_ptr:FlightStreamWriter:"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_1_1_do_put_result_1aceee89579be177004a058eecfe52b209"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight18FlightStreamWriterE" title="arrow::flight::FlightStreamWriter"><span class="n"><span class="pre">FlightStreamWriter</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">writer</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient11DoPutResult6writerE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>a writer to write record batches to </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient11DoPutResult6readerE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient11DoPutResult6readerE"></span><span id="_CPPv2N5arrow6flight12FlightClient11DoPutResult6readerE"></span><span id="arrow::flight::FlightClient::DoPutResult::reader__std::unique_ptr:FlightMetadataReader:"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_1_1_do_put_result_1afadc2d2a545f268a17c44599c9c24c61"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">FlightMetadataReader</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">reader</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient11DoPutResult6readerE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>a reader for application metadata from the server </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptionsE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptionsE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptionsE"></span><span id="arrow::flight::FlightClientOptions"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightClientOptions</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions14tls_root_certsE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions14tls_root_certsE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions14tls_root_certsE"></span><span id="arrow::flight::FlightClientOptions::tls_root_certs__ss"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1add5f255e136e5d25243a504bfbe90958"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">tls_root_certs</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions14tls_root_certsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Root certificates to use for validating server certificates. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions17override_hostnameE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions17override_hostnameE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions17override_hostnameE"></span><span id="arrow::flight::FlightClientOptions::override_hostname__ss"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1a494b451fcfece2fd181c609cfe4f0e4b"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">override_hostname</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions17override_hostnameE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Override the hostname checked by TLS. Use with caution. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions10cert_chainE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions10cert_chainE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions10cert_chainE"></span><span id="arrow::flight::FlightClientOptions::cert_chain__ss"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1a2bc5e5269cb3a82eb5ba0d8b6251193e"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">cert_chain</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions10cert_chainE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The client certificate to use if using Mutual TLS. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions11private_keyE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions11private_keyE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions11private_keyE"></span><span id="arrow::flight::FlightClientOptions::private_key__ss"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1aaeb361d048b6b807689d9d3c0e027065"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">private_key</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions11private_keyE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The private key associated with the client certificate for Mutual TLS. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions10middlewareE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions10middlewareE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions10middlewareE"></span><span id="arrow::flight::FlightClientOptions::middleware__std::vector:std::shared_ptr:ClientMiddlewareFactory::"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1a1b798cd0468120edb6a2acf7a87e931b"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight23ClientMiddlewareFactoryE" title="arrow::flight::ClientMiddlewareFactory"><span class="n"><span class="pre">ClientMiddlewareFactory</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">middleware</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions10middlewareE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A list of client middleware to apply. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions22write_size_limit_bytesE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions22write_size_limit_bytesE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions22write_size_limit_bytesE"></span><span id="arrow::flight::FlightClientOptions::write_size_limit_bytes__int64_t"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1ae9af5c10b0f2ab2f74a773f8ea6591b1"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">write_size_limit_bytes</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions22write_size_limit_bytesE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A soft limit on the number of bytes to write in a single batch when sending Arrow data to a server. </p> |
| <p>Used to help limit server memory consumption. Only enabled if positive. When enabled, FlightStreamWriter.Write* may yield a IOError with error detail FlightWriteSizeStatusDetail. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions15generic_optionsE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions15generic_optionsE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions15generic_optionsE"></span><span id="arrow::flight::FlightClientOptions::generic_options__std::vector:std::pair:ss.std::variant:i.ss:::"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1a4888fe2bb0d9fe34dfd121f91bb63559"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">pair</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">variant</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">generic_options</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions15generic_optionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Generic connection options, passed to the underlying transport; interpretation is implementation-dependent. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions27disable_server_verificationE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions27disable_server_verificationE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions27disable_server_verificationE"></span><span id="arrow::flight::FlightClientOptions::disable_server_verification__b"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1a41311f8730083f5dbaf6032da9a8a171"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">disable_server_verification</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">false</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions27disable_server_verificationE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Use TLS without validating the server certificate. Use with caution. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions8DefaultsEv"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions8DefaultsEv"></span><span id="arrow::flight::FlightClientOptions::Defaults"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1a8e55ccb95e5bbf3db24e2577df5eead8"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight19FlightClientOptionsE" title="arrow::flight::FlightClientOptions"><span class="n"><span class="pre">FlightClientOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Defaults</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions8DefaultsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get default options. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17FlightCallOptionsE"> |
| <span id="_CPPv3N5arrow6flight17FlightCallOptionsE"></span><span id="_CPPv2N5arrow6flight17FlightCallOptionsE"></span><span id="arrow::flight::FlightCallOptions"></span><span class="target" id="classarrow_1_1flight_1_1_flight_call_options"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightCallOptions</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Hints to the underlying RPC layer for Arrow Flight calls. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17FlightCallOptions17FlightCallOptionsEv"> |
| <span id="_CPPv3N5arrow6flight17FlightCallOptions17FlightCallOptionsEv"></span><span id="_CPPv2N5arrow6flight17FlightCallOptions17FlightCallOptionsEv"></span><span id="arrow::flight::FlightCallOptions::FlightCallOptions"></span><span class="target" id="classarrow_1_1flight_1_1_flight_call_options_1a49638080ba66ff44fe1126f27a02f5be"></span><span class="sig-name descname"><span class="n"><span class="pre">FlightCallOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight17FlightCallOptions17FlightCallOptionsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a default set of call options. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17FlightCallOptions7timeoutE"> |
| <span id="_CPPv3N5arrow6flight17FlightCallOptions7timeoutE"></span><span id="_CPPv2N5arrow6flight17FlightCallOptions7timeoutE"></span><span id="arrow::flight::FlightCallOptions::timeout__TimeoutDuration"></span><span class="target" id="classarrow_1_1flight_1_1_flight_call_options_1ae767c6ad69172b3d2ddd6ca40494bb85"></span><a class="reference internal" href="#_CPPv4N5arrow6flight15TimeoutDurationE" title="arrow::flight::TimeoutDuration"><span class="n"><span class="pre">TimeoutDuration</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">timeout</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17FlightCallOptions7timeoutE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An optional timeout for this call. </p> |
| <p>Negative durations mean an implementation-defined default behavior will be used instead. This is the default value. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17FlightCallOptions12read_optionsE"> |
| <span id="_CPPv3N5arrow6flight17FlightCallOptions12read_optionsE"></span><span id="_CPPv2N5arrow6flight17FlightCallOptions12read_optionsE"></span><span id="arrow::flight::FlightCallOptions::read_options__ipc::IpcReadOptions"></span><span class="target" id="classarrow_1_1flight_1_1_flight_call_options_1aad9c5cc750e23ec785275d7765a35af1"></span><span class="n"><span class="pre">ipc</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="ipc.html#_CPPv4N5arrow3ipc14IpcReadOptionsE" title="arrow::ipc::IpcReadOptions"><span class="n"><span class="pre">IpcReadOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">read_options</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17FlightCallOptions12read_optionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>IPC reader options, if applicable for the call. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17FlightCallOptions13write_optionsE"> |
| <span id="_CPPv3N5arrow6flight17FlightCallOptions13write_optionsE"></span><span id="_CPPv2N5arrow6flight17FlightCallOptions13write_optionsE"></span><span id="arrow::flight::FlightCallOptions::write_options__ipc::IpcWriteOptions"></span><span class="target" id="classarrow_1_1flight_1_1_flight_call_options_1ac68eae40ad88558d997d430a78fe11b2"></span><span class="n"><span class="pre">ipc</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="ipc.html#_CPPv4N5arrow3ipc15IpcWriteOptionsE" title="arrow::ipc::IpcWriteOptions"><span class="n"><span class="pre">IpcWriteOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">write_options</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17FlightCallOptions13write_optionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>IPC writer options, if applicable for the call. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17FlightCallOptions7headersE"> |
| <span id="_CPPv3N5arrow6flight17FlightCallOptions7headersE"></span><span id="_CPPv2N5arrow6flight17FlightCallOptions7headersE"></span><span id="arrow::flight::FlightCallOptions::headers__std::vector:std::pair:ss.ss::"></span><span class="target" id="classarrow_1_1flight_1_1_flight_call_options_1a1fa1dc582343a4134346d647509deedc"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">pair</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">headers</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17FlightCallOptions7headersE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Headers for client to add to context. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17FlightCallOptions10stop_tokenE"> |
| <span id="_CPPv3N5arrow6flight17FlightCallOptions10stop_tokenE"></span><span id="_CPPv2N5arrow6flight17FlightCallOptions10stop_tokenE"></span><span id="arrow::flight::FlightCallOptions::stop_token__StopToken"></span><span class="target" id="classarrow_1_1flight_1_1_flight_call_options_1a5ee95d807f30f8d977740a41e87686b7"></span><span class="n"><span class="pre">StopToken</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">stop_token</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17FlightCallOptions10stop_tokenE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A token to enable interactive user cancellation of long-running requests. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17FlightCallOptions14memory_managerE"> |
| <span id="_CPPv3N5arrow6flight17FlightCallOptions14memory_managerE"></span><span id="_CPPv2N5arrow6flight17FlightCallOptions14memory_managerE"></span><span id="arrow::flight::FlightCallOptions::memory_manager__std::shared_ptr:MemoryManager:"></span><span class="target" id="classarrow_1_1flight_1_1_flight_call_options_1a2d8733bae4f1222b19d243fa725a6014"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="memory.html#_CPPv4N5arrow13MemoryManagerE" title="arrow::MemoryManager"><span class="n"><span class="pre">MemoryManager</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">memory_manager</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17FlightCallOptions14memory_managerE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An optional memory manager to control where to allocate incoming data. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17ClientAuthHandlerE"> |
| <span id="_CPPv3N5arrow6flight17ClientAuthHandlerE"></span><span id="_CPPv2N5arrow6flight17ClientAuthHandlerE"></span><span id="arrow::flight::ClientAuthHandler"></span><span class="target" id="classarrow_1_1flight_1_1_client_auth_handler"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ClientAuthHandler</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17ClientAuthHandlerE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An authentication implementation for a Flight service. </p> |
| <p>Authentication includes both an initial negotiation and a per-call token validation. Implementations may choose to use either or both mechanisms. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17ClientAuthHandler12AuthenticateEP16ClientAuthSenderP16ClientAuthReader"> |
| <span id="_CPPv3N5arrow6flight17ClientAuthHandler12AuthenticateEP16ClientAuthSenderP16ClientAuthReader"></span><span id="_CPPv2N5arrow6flight17ClientAuthHandler12AuthenticateEP16ClientAuthSenderP16ClientAuthReader"></span><span id="arrow::flight::ClientAuthHandler::Authenticate__ClientAuthSenderP.ClientAuthReaderP"></span><span class="target" id="classarrow_1_1flight_1_1_client_auth_handler_1a86a152f14aad68ef020c890f59102ce4"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Authenticate</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">ClientAuthSender</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">outgoing</span></span>, <span class="n"><span class="pre">ClientAuthReader</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">incoming</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17ClientAuthHandler12AuthenticateEP16ClientAuthSenderP16ClientAuthReader" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Authenticate the client on initial connection. </p> |
| <p>The client can send messages to/read responses from the server at any time. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> OK if authenticated successfully </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17ClientAuthHandler8GetTokenEPNSt6stringE"> |
| <span id="_CPPv3N5arrow6flight17ClientAuthHandler8GetTokenEPNSt6stringE"></span><span id="_CPPv2N5arrow6flight17ClientAuthHandler8GetTokenEPNSt6stringE"></span><span id="arrow::flight::ClientAuthHandler::GetToken__ssP"></span><span class="target" id="classarrow_1_1flight_1_1_client_auth_handler_1aeb21d551b7a3d8fe9b7dc094fa287843"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetToken</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">token</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17ClientAuthHandler8GetTokenEPNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a per-call token. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>token</strong> – <strong>[out]</strong> The token to send to the server. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16ClientMiddlewareE"> |
| <span id="_CPPv3N5arrow6flight16ClientMiddlewareE"></span><span id="_CPPv2N5arrow6flight16ClientMiddlewareE"></span><span id="arrow::flight::ClientMiddleware"></span><span class="target" id="classarrow_1_1flight_1_1_client_middleware"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ClientMiddleware</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16ClientMiddlewareE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Client-side middleware for a call, instantiated per RPC. </p> |
| <p>Middleware should be fast and must be infallible: there is no way to reject the call or report errors from the middleware instance. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16ClientMiddleware14SendingHeadersEP14AddCallHeaders"> |
| <span id="_CPPv3N5arrow6flight16ClientMiddleware14SendingHeadersEP14AddCallHeaders"></span><span id="_CPPv2N5arrow6flight16ClientMiddleware14SendingHeadersEP14AddCallHeaders"></span><span id="arrow::flight::ClientMiddleware::SendingHeaders__AddCallHeadersP"></span><span class="target" id="classarrow_1_1flight_1_1_client_middleware_1a4a72af5fd73ded195c78ec25052f14d8"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SendingHeaders</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow6flight14AddCallHeadersE" title="arrow::flight::AddCallHeaders"><span class="n"><span class="pre">AddCallHeaders</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">outgoing_headers</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16ClientMiddleware14SendingHeadersEP14AddCallHeaders" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A callback before headers are sent. </p> |
| <p>Extra headers can be added, but existing ones cannot be read. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16ClientMiddleware15ReceivedHeadersERK11CallHeaders"> |
| <span id="_CPPv3N5arrow6flight16ClientMiddleware15ReceivedHeadersERK11CallHeaders"></span><span id="_CPPv2N5arrow6flight16ClientMiddleware15ReceivedHeadersERK11CallHeaders"></span><span id="arrow::flight::ClientMiddleware::ReceivedHeaders__CallHeadersCR"></span><span class="target" id="classarrow_1_1flight_1_1_client_middleware_1a492de955bab10ba3bf73030e389e7cfa"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ReceivedHeaders</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">CallHeaders</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">incoming_headers</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16ClientMiddleware15ReceivedHeadersERK11CallHeaders" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A callback when headers are received from the server. </p> |
| <p>This may be called more than once, since servers send both headers and trailers. Some implementations (e.g. gRPC-Java, and hence Arrow Flight in Java) may consolidate headers into trailers if the RPC errored. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16ClientMiddleware13CallCompletedERK6Status"> |
| <span id="_CPPv3N5arrow6flight16ClientMiddleware13CallCompletedERK6Status"></span><span id="_CPPv2N5arrow6flight16ClientMiddleware13CallCompletedERK6Status"></span><span id="arrow::flight::ClientMiddleware::CallCompleted__StatusCR"></span><span class="target" id="classarrow_1_1flight_1_1_client_middleware_1a6687c6c857f4aea7a2a16b6944e7b834"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CallCompleted</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">status</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16ClientMiddleware13CallCompletedERK6Status" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A callback after the call has completed. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight23ClientMiddlewareFactoryE"> |
| <span id="_CPPv3N5arrow6flight23ClientMiddlewareFactoryE"></span><span id="_CPPv2N5arrow6flight23ClientMiddlewareFactoryE"></span><span id="arrow::flight::ClientMiddlewareFactory"></span><span class="target" id="classarrow_1_1flight_1_1_client_middleware_factory"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ClientMiddlewareFactory</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight23ClientMiddlewareFactoryE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A factory for new middleware instances. </p> |
| <p>If added to a client, this will be called for each RPC (including Handshake) to give the opportunity to intercept the call.</p> |
| <p>It is guaranteed that all client middleware methods are called from the same thread that calls the RPC method implementation. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight23ClientMiddlewareFactory9StartCallERK8CallInfoPNSt10unique_ptrI16ClientMiddlewareEE"> |
| <span id="_CPPv3N5arrow6flight23ClientMiddlewareFactory9StartCallERK8CallInfoPNSt10unique_ptrI16ClientMiddlewareEE"></span><span id="_CPPv2N5arrow6flight23ClientMiddlewareFactory9StartCallERK8CallInfoPNSt10unique_ptrI16ClientMiddlewareEE"></span><span id="arrow::flight::ClientMiddlewareFactory::StartCall__CallInfoCR.std::unique_ptr:ClientMiddleware:P"></span><span class="target" id="classarrow_1_1flight_1_1_client_middleware_factory_1a840570d1d9c0a8bee4f313bdb711370c"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">StartCall</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight8CallInfoE" title="arrow::flight::CallInfo"><span class="n"><span class="pre">CallInfo</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">info</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight16ClientMiddlewareE" title="arrow::flight::ClientMiddleware"><span class="n"><span class="pre">ClientMiddleware</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">middleware</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight23ClientMiddlewareFactory9StartCallERK8CallInfoPNSt10unique_ptrI16ClientMiddlewareEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A callback for the start of a new call. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>info</strong> – Information about the call. </p></li> |
| <li><p><strong>middleware</strong> – <strong>[out]</strong> The middleware instance for this call. If unset, will not add middleware to this call instance from this factory. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight15TimeoutDurationE"> |
| <span id="_CPPv3N5arrow6flight15TimeoutDurationE"></span><span id="_CPPv2N5arrow6flight15TimeoutDurationE"></span><span id="arrow::flight::TimeoutDuration"></span><span class="target" id="namespacearrow_1_1flight_1a300f0f4f1be96f649588886489265633"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">chrono</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">duration</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">double</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">chrono</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">seconds</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">period</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">flight</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">TimeoutDuration</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight15TimeoutDurationE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A duration type for Flight call timeouts. </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18FlightStreamReaderE"> |
| <span id="_CPPv3N5arrow6flight18FlightStreamReaderE"></span><span id="_CPPv2N5arrow6flight18FlightStreamReaderE"></span><span id="arrow::flight::FlightStreamReader"></span><span class="target" id="classarrow_1_1flight_1_1_flight_stream_reader"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightStreamReader</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">flight</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight25MetadataRecordBatchReaderE" title="arrow::flight::MetadataRecordBatchReader"><span class="n"><span class="pre">MetadataRecordBatchReader</span></span></a><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStreamReaderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A <a class="reference internal" href="table.html#classarrow_1_1_record_batch_reader"><span class="std std-ref">RecordBatchReader</span></a> exposing Flight metadata and cancel operations. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18FlightStreamReader6CancelEv"> |
| <span id="_CPPv3N5arrow6flight18FlightStreamReader6CancelEv"></span><span id="_CPPv2N5arrow6flight18FlightStreamReader6CancelEv"></span><span id="arrow::flight::FlightStreamReader::Cancel"></span><span class="target" id="classarrow_1_1flight_1_1_flight_stream_reader_1a2da607d7731a356d69f7842ac5c19918"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Cancel</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStreamReader6CancelEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Try to cancel the call. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18FlightStreamReader15ToRecordBatchesERK9StopToken"> |
| <span id="_CPPv3N5arrow6flight18FlightStreamReader15ToRecordBatchesERK9StopToken"></span><span id="_CPPv2N5arrow6flight18FlightStreamReader15ToRecordBatchesERK9StopToken"></span><span id="arrow::flight::FlightStreamReader::ToRecordBatches__StopTokenCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_stream_reader_1a5eed72587d02b6bd9dd38ae560389630"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="table.html#_CPPv4N5arrow11RecordBatchE" title="arrow::RecordBatch"><span class="n"><span class="pre">RecordBatch</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToRecordBatches</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">StopToken</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">stop_token</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStreamReader15ToRecordBatchesERK9StopToken" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Consume entire stream as a vector of record batches. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18FlightStreamReader7ToTableERK9StopToken"> |
| <span id="_CPPv3N5arrow6flight18FlightStreamReader7ToTableERK9StopToken"></span><span id="_CPPv2N5arrow6flight18FlightStreamReader7ToTableERK9StopToken"></span><span id="arrow::flight::FlightStreamReader::ToTable__StopTokenCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_stream_reader_1a10c8b610d142f0faa5ae3c4962c9e45f"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="table.html#_CPPv4N5arrow5TableE" title="arrow::Table"><span class="n"><span class="pre">Table</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToTable</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">StopToken</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">stop_token</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStreamReader7ToTableERK9StopToken" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Consume entire stream as a <a class="reference internal" href="table.html#classarrow_1_1_table"><span class="std std-ref">Table</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18FlightStreamReader15ToRecordBatchesEv"> |
| <span id="_CPPv3N5arrow6flight18FlightStreamReader15ToRecordBatchesEv"></span><span id="_CPPv2N5arrow6flight18FlightStreamReader15ToRecordBatchesEv"></span><span id="arrow::flight::FlightStreamReader::ToRecordBatches"></span><span class="target" id="classarrow_1_1flight_1_1_flight_stream_reader_1a1d187521cd0e812cd77b3b3039060be2"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="table.html#_CPPv4N5arrow11RecordBatchE" title="arrow::RecordBatch"><span class="n"><span class="pre">RecordBatch</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToRecordBatches</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStreamReader15ToRecordBatchesEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Consume entire stream as a vector of record batches. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18FlightStreamReader7ToTableEv"> |
| <span id="_CPPv3N5arrow6flight18FlightStreamReader7ToTableEv"></span><span id="_CPPv2N5arrow6flight18FlightStreamReader7ToTableEv"></span><span id="arrow::flight::FlightStreamReader::ToTable"></span><span class="target" id="classarrow_1_1flight_1_1_flight_stream_reader_1af42a446532c83cfaae038a74e52cfd11"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="table.html#_CPPv4N5arrow5TableE" title="arrow::Table"><span class="n"><span class="pre">Table</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToTable</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStreamReader7ToTableEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Consume entire stream as a <a class="reference internal" href="table.html#classarrow_1_1_table"><span class="std std-ref">Table</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18FlightStreamWriterE"> |
| <span id="_CPPv3N5arrow6flight18FlightStreamWriterE"></span><span id="_CPPv2N5arrow6flight18FlightStreamWriterE"></span><span id="arrow::flight::FlightStreamWriter"></span><span class="target" id="classarrow_1_1flight_1_1_flight_stream_writer"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightStreamWriter</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">flight</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">MetadataRecordBatchWriter</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStreamWriterE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A RecordBatchWriter that also allows sending application-defined metadata via the Flight protocol. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18FlightStreamWriter11DoneWritingEv"> |
| <span id="_CPPv3N5arrow6flight18FlightStreamWriter11DoneWritingEv"></span><span id="_CPPv2N5arrow6flight18FlightStreamWriter11DoneWritingEv"></span><span id="arrow::flight::FlightStreamWriter::DoneWriting"></span><span class="target" id="classarrow_1_1flight_1_1_flight_stream_writer_1a5d0da94bfa911d652d8257ee13fbe8ed"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoneWriting</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStreamWriter11DoneWritingEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Indicate that the application is done writing to this stream. </p> |
| <p>The application may not write to this stream after calling this. This differs from closing the stream because this writer may represent only one half of a readable and writable stream. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </section> |
| <section id="servers"> |
| <h2>Servers<a class="headerlink" href="#servers" title="Permalink to this heading">#</a></h2> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBaseE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBaseE"></span><span id="_CPPv2N5arrow6flight16FlightServerBaseE"></span><span id="arrow::flight::FlightServerBase"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightServerBase</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBaseE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Skeleton RPC server implementation which can be used to create custom servers by implementing its abstract methods. </p> |
| <p>Subclassed by <a class="reference internal" href="flightsql.html#classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base"><span class="std std-ref">arrow::flight::sql::FlightSqlServerBase</span></a></p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase4InitERK19FlightServerOptions"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase4InitERK19FlightServerOptions"></span><span id="_CPPv2N5arrow6flight16FlightServerBase4InitERK19FlightServerOptions"></span><span id="arrow::flight::FlightServerBase::Init__FlightServerOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a06a8ce8cfc29ea5fc361873fe76764fa"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Init</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight19FlightServerOptionsE" title="arrow::flight::FlightServerOptions"><span class="n"><span class="pre">FlightServerOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase4InitERK19FlightServerOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Initialize a Flight server listening at the given location. </p> |
| <p>This method must be called before any other method. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>options</strong> – <strong>[in]</strong> The configuration for this server. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight16FlightServerBase4portEv"> |
| <span id="_CPPv3NK5arrow6flight16FlightServerBase4portEv"></span><span id="_CPPv2NK5arrow6flight16FlightServerBase4portEv"></span><span id="arrow::flight::FlightServerBase::portC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1ac9c3d43f50ae7905fa4723b843d8cd98"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">port</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight16FlightServerBase4portEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the port that the Flight server is listening on. </p> |
| <p>This method must only be called after <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a06a8ce8cfc29ea5fc361873fe76764fa"><span class="std std-ref">Init()</span></a>. Will return a non-positive value if no port exists (e.g. when listening on a domain socket). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight16FlightServerBase8locationEv"> |
| <span id="_CPPv3NK5arrow6flight16FlightServerBase8locationEv"></span><span id="_CPPv2NK5arrow6flight16FlightServerBase8locationEv"></span><span id="arrow::flight::FlightServerBase::locationC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a1427e2ddc5acf750b67febf3ca4b0feb"></span><a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">location</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight16FlightServerBase8locationEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the address that the Flight server is listening on. </p> |
| <p>This method must only be called after <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a06a8ce8cfc29ea5fc361873fe76764fa"><span class="std std-ref">Init()</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase20SetShutdownOnSignalsEKNSt6vectorIiEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase20SetShutdownOnSignalsEKNSt6vectorIiEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase20SetShutdownOnSignalsEKNSt6vectorIiEE"></span><span id="arrow::flight::FlightServerBase::SetShutdownOnSignals__std::vector:i:C"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1ae02679a91fbfb8dac640df0569c0e32d"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SetShutdownOnSignals</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">sigs</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase20SetShutdownOnSignalsEKNSt6vectorIiEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Set the server to stop when receiving any of the given signal numbers. </p> |
| <p>This method must be called before <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a7fa89e356d84b3bc61c78f509a16e202"><span class="std std-ref">Serve()</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase5ServeEv"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase5ServeEv"></span><span id="_CPPv2N5arrow6flight16FlightServerBase5ServeEv"></span><span id="arrow::flight::FlightServerBase::Serve"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a7fa89e356d84b3bc61c78f509a16e202"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Serve</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase5ServeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Start serving. </p> |
| <p>This method blocks until the server shuts down.</p> |
| <p>The server will start to shut down when either <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a1761b0bd669fe6261180ccb2e2835122"><span class="std std-ref">Shutdown()</span></a> is called or one of the signals registered in <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1ae02679a91fbfb8dac640df0569c0e32d"><span class="std std-ref">SetShutdownOnSignals()</span></a> is received. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight16FlightServerBase9GotSignalEv"> |
| <span id="_CPPv3NK5arrow6flight16FlightServerBase9GotSignalEv"></span><span id="_CPPv2NK5arrow6flight16FlightServerBase9GotSignalEv"></span><span id="arrow::flight::FlightServerBase::GotSignalC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a3005b9262b4a5a97d53d9fed8a469097"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GotSignal</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight16FlightServerBase9GotSignalEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Query whether <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a7fa89e356d84b3bc61c78f509a16e202"><span class="std std-ref">Serve()</span></a> was interrupted by a signal. </p> |
| <p>This method must be called after <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a7fa89e356d84b3bc61c78f509a16e202"><span class="std std-ref">Serve()</span></a> has returned.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>int the signal number that interrupted <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a7fa89e356d84b3bc61c78f509a16e202"><span class="std std-ref">Serve()</span></a>, if any, otherwise 0 </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase8ShutdownEPKNSt6chrono12system_clock10time_pointE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase8ShutdownEPKNSt6chrono12system_clock10time_pointE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase8ShutdownEPKNSt6chrono12system_clock10time_pointE"></span><span id="arrow::flight::FlightServerBase::Shutdown__std::chrono::system_clock::time_pointCP"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a1761b0bd669fe6261180ccb2e2835122"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Shutdown</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">chrono</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">system_clock</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">time_point</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">deadline</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NULLPTR</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase8ShutdownEPKNSt6chrono12system_clock10time_pointE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Shut down the server, blocking until current requests finish. </p> |
| <p>Can be called from a signal handler or another thread while <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a7fa89e356d84b3bc61c78f509a16e202"><span class="std std-ref">Serve()</span></a> blocks. Optionally a deadline can be set. Once the deadline expires server will wait until remaining running calls complete.</p> |
| <p>Should only be called once. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase4WaitEv"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase4WaitEv"></span><span id="_CPPv2N5arrow6flight16FlightServerBase4WaitEv"></span><span id="arrow::flight::FlightServerBase::Wait"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1ad68a6e1600bf121f1fe2bc32459ad391"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Wait</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase4WaitEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Block until server shuts down with Shutdown. </p> |
| <p>Does not respond to signals like <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a7fa89e356d84b3bc61c78f509a16e202"><span class="std std-ref">Serve()</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase11ListFlightsERK17ServerCallContextPK8CriteriaPNSt10unique_ptrI13FlightListingEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase11ListFlightsERK17ServerCallContextPK8CriteriaPNSt10unique_ptrI13FlightListingEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase11ListFlightsERK17ServerCallContextPK8CriteriaPNSt10unique_ptrI13FlightListingEE"></span><span id="arrow::flight::FlightServerBase::ListFlights__ServerCallContextCR.CriteriaCP.std::unique_ptr:FlightListing:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1aa9b655acfcfdaf6e2b911565827dd2b9"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ListFlights</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight8CriteriaE" title="arrow::flight::Criteria"><span class="n"><span class="pre">Criteria</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">criteria</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight13FlightListingE" title="arrow::flight::FlightListing"><span class="n"><span class="pre">FlightListing</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">listings</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase11ListFlightsERK17ServerCallContextPK8CriteriaPNSt10unique_ptrI13FlightListingEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve a list of available fields given an optional opaque criteria. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>criteria</strong> – <strong>[in]</strong> may be null </p></li> |
| <li><p><strong>listings</strong> – <strong>[out]</strong> the returned listings iterator </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase13GetFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI10FlightInfoEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase13GetFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI10FlightInfoEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase13GetFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI10FlightInfoEE"></span><span id="arrow::flight::FlightServerBase::GetFlightInfo__ServerCallContextCR.FlightDescriptorCR.std::unique_ptr:FlightInfo:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a225ae1502c6f9b09f650768e98280cf9"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">info</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase13GetFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI10FlightInfoEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the schema and an access plan for the indicated descriptor. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> the dataset request, whether a named dataset or command </p></li> |
| <li><p><strong>info</strong> – <strong>[out]</strong> the returned flight info provider </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase14PollFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI8PollInfoEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase14PollFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI8PollInfoEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase14PollFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI8PollInfoEE"></span><span id="arrow::flight::FlightServerBase::PollFlightInfo__ServerCallContextCR.FlightDescriptorCR.std::unique_ptr:PollInfo:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a815c713c0b911e4eb68e6a86e0c61e7c"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PollFlightInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">PollInfo</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">info</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase14PollFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI8PollInfoEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the current status of the target query. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> the dataset request or a descriptor returned by a prior PollFlightInfo call </p></li> |
| <li><p><strong>info</strong> – <strong>[out]</strong> the returned retry info provider </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase9GetSchemaERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI12SchemaResultEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase9GetSchemaERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI12SchemaResultEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase9GetSchemaERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI12SchemaResultEE"></span><span id="arrow::flight::FlightServerBase::GetSchema__ServerCallContextCR.FlightDescriptorCR.std::unique_ptr:SchemaResult:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a7b4107bd314af21cd1284d7c9c0c450a"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">schema</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase9GetSchemaERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI12SchemaResultEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the schema for the indicated descriptor. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> the dataset request, whether a named dataset or command </p></li> |
| <li><p><strong>schema</strong> – <strong>[out]</strong> the returned flight schema provider </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase5DoGetERK17ServerCallContextRK6TicketPNSt10unique_ptrI16FlightDataStreamEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase5DoGetERK17ServerCallContextRK6TicketPNSt10unique_ptrI16FlightDataStreamEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase5DoGetERK17ServerCallContextRK6TicketPNSt10unique_ptrI16FlightDataStreamEE"></span><span id="arrow::flight::FlightServerBase::DoGet__ServerCallContextCR.TicketCR.std::unique_ptr:FlightDataStream:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a6a28902c5eaad91cd3cab3c9a7b694f9"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGet</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight6TicketE" title="arrow::flight::Ticket"><span class="n"><span class="pre">Ticket</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">stream</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase5DoGetERK17ServerCallContextRK6TicketPNSt10unique_ptrI16FlightDataStreamEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a stream of IPC payloads to put on the wire. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> an opaque ticket </p></li> |
| <li><p><strong>stream</strong> – <strong>[out]</strong> the returned stream provider </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase5DoPutERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI20FlightMetadataWriterEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase5DoPutERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI20FlightMetadataWriterEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase5DoPutERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI20FlightMetadataWriterEE"></span><span id="arrow::flight::FlightServerBase::DoPut__ServerCallContextCR.std::unique_ptr:FlightMessageReader:.std::unique_ptr:FlightMetadataWriter:"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a3dd52ff2cf92b7bb1e7e5c449294bfd3"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoPut</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight19FlightMessageReaderE" title="arrow::flight::FlightMessageReader"><span class="n"><span class="pre">FlightMessageReader</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">reader</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight20FlightMetadataWriterE" title="arrow::flight::FlightMetadataWriter"><span class="n"><span class="pre">FlightMetadataWriter</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">writer</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase5DoPutERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI20FlightMetadataWriterEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Process a stream of IPC payloads sent from a client. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>reader</strong> – <strong>[in]</strong> a sequence of uploaded record batches </p></li> |
| <li><p><strong>writer</strong> – <strong>[in]</strong> send metadata back to the client </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase10DoExchangeERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI19FlightMessageWriterEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase10DoExchangeERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI19FlightMessageWriterEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase10DoExchangeERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI19FlightMessageWriterEE"></span><span id="arrow::flight::FlightServerBase::DoExchange__ServerCallContextCR.std::unique_ptr:FlightMessageReader:.std::unique_ptr:FlightMessageWriter:"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1ada5dd1277b40965b05b310d428f4e305"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoExchange</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight19FlightMessageReaderE" title="arrow::flight::FlightMessageReader"><span class="n"><span class="pre">FlightMessageReader</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">reader</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">FlightMessageWriter</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">writer</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase10DoExchangeERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI19FlightMessageWriterEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Process a bidirectional stream of IPC payloads. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>reader</strong> – <strong>[in]</strong> a sequence of uploaded record batches </p></li> |
| <li><p><strong>writer</strong> – <strong>[in]</strong> send data back to the client </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase8DoActionERK17ServerCallContextRK6ActionPNSt10unique_ptrI12ResultStreamEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase8DoActionERK17ServerCallContextRK6ActionPNSt10unique_ptrI12ResultStreamEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase8DoActionERK17ServerCallContextRK6ActionPNSt10unique_ptrI12ResultStreamEE"></span><span id="arrow::flight::FlightServerBase::DoAction__ServerCallContextCR.ActionCR.std::unique_ptr:ResultStream:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1af386bc5f425feb6d7953e6bb041d1a8b"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoAction</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight6ActionE" title="arrow::flight::Action"><span class="n"><span class="pre">Action</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">action</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight12ResultStreamE" title="arrow::flight::ResultStream"><span class="n"><span class="pre">ResultStream</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">result</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase8DoActionERK17ServerCallContextRK6ActionPNSt10unique_ptrI12ResultStreamEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Execute an action, return stream of zero or more results. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>action</strong> – <strong>[in]</strong> the action to execute, with type and body </p></li> |
| <li><p><strong>result</strong> – <strong>[out]</strong> the result iterator </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase11ListActionsERK17ServerCallContextPNSt6vectorI10ActionTypeEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase11ListActionsERK17ServerCallContextPNSt6vectorI10ActionTypeEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase11ListActionsERK17ServerCallContextPNSt6vectorI10ActionTypeEE"></span><span id="arrow::flight::FlightServerBase::ListActions__ServerCallContextCR.std::vector:ActionType:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a32e5270b934ee373b64cef4cee07bf97"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ListActions</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight10ActionTypeE" title="arrow::flight::ActionType"><span class="n"><span class="pre">ActionType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">actions</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase11ListActionsERK17ServerCallContextPNSt6vectorI10ActionTypeEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the list of available actions. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>actions</strong> – <strong>[out]</strong> a vector of available action types </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptionsE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptionsE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptionsE"></span><span id="arrow::flight::FlightServerOptions"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightServerOptions</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptions8locationE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptions8locationE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptions8locationE"></span><span id="arrow::flight::FlightServerOptions::location__Location"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options_1aa7faa740a57bce03c267148e43afd411"></span><a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">location</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptions8locationE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The host & port (or domain socket path) to listen on. </p> |
| <p>Use port 0 to bind to an available port. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptions12auth_handlerE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptions12auth_handlerE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptions12auth_handlerE"></span><span id="arrow::flight::FlightServerOptions::auth_handler__std::shared_ptr:ServerAuthHandler:"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options_1af3dff1faed9844a53f964275f312d5d8"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight17ServerAuthHandlerE" title="arrow::flight::ServerAuthHandler"><span class="n"><span class="pre">ServerAuthHandler</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">auth_handler</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptions12auth_handlerE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The authentication handler to use. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptions16tls_certificatesE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptions16tls_certificatesE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptions16tls_certificatesE"></span><span id="arrow::flight::FlightServerOptions::tls_certificates__std::vector:CertKeyPair:"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options_1a931bfee1d34d25729f25d681210a4825"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight11CertKeyPairE" title="arrow::flight::CertKeyPair"><span class="n"><span class="pre">CertKeyPair</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">tls_certificates</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptions16tls_certificatesE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A list of TLS certificate+key pairs to use. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptions13verify_clientE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptions13verify_clientE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptions13verify_clientE"></span><span id="arrow::flight::FlightServerOptions::verify_client__b"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options_1a68f7c0d9d9c59a5f23babef692de8223"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">verify_client</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptions13verify_clientE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Enable mTLS and require that the client present a certificate. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptions17root_certificatesE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptions17root_certificatesE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptions17root_certificatesE"></span><span id="arrow::flight::FlightServerOptions::root_certificates__ss"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options_1a8e960d31126e6e15605c36a006137fba"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">root_certificates</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptions17root_certificatesE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If using mTLS, the PEM-encoded root certificate to use. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptions10middlewareE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptions10middlewareE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptions10middlewareE"></span><span id="arrow::flight::FlightServerOptions::middleware__std::vector:std::pair:ss.std::shared_ptr:ServerMiddlewareFactory:::"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options_1a8ce3177a754ac0ca7750b37aae56e9f3"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">pair</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight23ServerMiddlewareFactoryE" title="arrow::flight::ServerMiddlewareFactory"><span class="n"><span class="pre">ServerMiddlewareFactory</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">middleware</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptions10middlewareE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A list of server middleware to apply, along with a key to identify them by. </p> |
| <p>Middleware are always applied in the order provided. Duplicate keys are an error. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptions14memory_managerE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptions14memory_managerE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptions14memory_managerE"></span><span id="arrow::flight::FlightServerOptions::memory_manager__std::shared_ptr:MemoryManager:"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options_1a045815733e8d8d057847ed24f42033b6"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="memory.html#_CPPv4N5arrow13MemoryManagerE" title="arrow::MemoryManager"><span class="n"><span class="pre">MemoryManager</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">memory_manager</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptions14memory_managerE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An optional memory manager to control where to allocate incoming data. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptions12builder_hookE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptions12builder_hookE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptions12builder_hookE"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options_1ac80e7f3b8317bce30cf0ffc6623dfe30"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">function</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">void</span></span><span class="p"><span class="pre">(</span></span><span class="kt"><span class="pre">void</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">builder_hook</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptions12builder_hookE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A Flight implementation-specific callback to customize transport-specific options. </p> |
| <p>Not guaranteed to be called. The type of the parameter is specific to the Flight implementation. Users should take care to link to the same transport implementation as Flight to avoid runtime problems. See “Using Arrow C++ in your own project” in the documentation for more details. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight11CertKeyPairE"> |
| <span id="_CPPv3N5arrow6flight11CertKeyPairE"></span><span id="_CPPv2N5arrow6flight11CertKeyPairE"></span><span id="arrow::flight::CertKeyPair"></span><span class="target" id="structarrow_1_1flight_1_1_cert_key_pair"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CertKeyPair</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight11CertKeyPairE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A TLS certificate plus key. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight11CertKeyPair8pem_certE"> |
| <span id="_CPPv3N5arrow6flight11CertKeyPair8pem_certE"></span><span id="_CPPv2N5arrow6flight11CertKeyPair8pem_certE"></span><span id="arrow::flight::CertKeyPair::pem_cert__ss"></span><span class="target" id="structarrow_1_1flight_1_1_cert_key_pair_1ab8ccf50ff902c1d72f10fd7b3139a122"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">pem_cert</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight11CertKeyPair8pem_certE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The certificate in PEM format. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight11CertKeyPair7pem_keyE"> |
| <span id="_CPPv3N5arrow6flight11CertKeyPair7pem_keyE"></span><span id="_CPPv2N5arrow6flight11CertKeyPair7pem_keyE"></span><span id="arrow::flight::CertKeyPair::pem_key__ss"></span><span class="target" id="structarrow_1_1flight_1_1_cert_key_pair_1abfc97775bd03a5ad77db6f565a4211de"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">pem_key</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight11CertKeyPair7pem_keyE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The key in PEM format. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightDataStreamE"> |
| <span id="_CPPv3N5arrow6flight16FlightDataStreamE"></span><span id="_CPPv2N5arrow6flight16FlightDataStreamE"></span><span id="arrow::flight::FlightDataStream"></span><span class="target" id="classarrow_1_1flight_1_1_flight_data_stream"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightDataStream</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightDataStreamE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Interface that produces a sequence of IPC payloads to be sent in FlightData protobuf messages. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1flight_1_1_record_batch_stream"><span class="std std-ref">arrow::flight::RecordBatchStream</span></a></p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightDataStream16GetSchemaPayloadEv"> |
| <span id="_CPPv3N5arrow6flight16FlightDataStream16GetSchemaPayloadEv"></span><span id="_CPPv2N5arrow6flight16FlightDataStream16GetSchemaPayloadEv"></span><span id="arrow::flight::FlightDataStream::GetSchemaPayload"></span><span class="target" id="classarrow_1_1flight_1_1_flight_data_stream_1a7264d548cbd6acb4a3055cb871f7fb54"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight13FlightPayloadE" title="arrow::flight::FlightPayload"><span class="n"><span class="pre">FlightPayload</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSchemaPayload</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightDataStream16GetSchemaPayloadEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Compute <a class="reference internal" href="#structarrow_1_1flight_1_1_flight_payload"><span class="std std-ref">FlightPayload</span></a> containing serialized <a class="reference internal" href="table.html#classarrow_1_1_record_batch"><span class="std std-ref">RecordBatch</span></a> schema. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightMessageReaderE"> |
| <span id="_CPPv3N5arrow6flight19FlightMessageReaderE"></span><span id="_CPPv2N5arrow6flight19FlightMessageReaderE"></span><span id="arrow::flight::FlightMessageReader"></span><span class="target" id="classarrow_1_1flight_1_1_flight_message_reader"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightMessageReader</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">flight</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight25MetadataRecordBatchReaderE" title="arrow::flight::MetadataRecordBatchReader"><span class="n"><span class="pre">MetadataRecordBatchReader</span></span></a><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightMessageReaderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A reader for IPC payloads uploaded by a client. </p> |
| <p>Also allows reading application-defined metadata via the Flight protocol. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight19FlightMessageReader10descriptorEv"> |
| <span id="_CPPv3NK5arrow6flight19FlightMessageReader10descriptorEv"></span><span id="_CPPv2NK5arrow6flight19FlightMessageReader10descriptorEv"></span><span id="arrow::flight::FlightMessageReader::descriptorC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_message_reader_1a8ae42ba038e74f746a827284534f3ee6"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">descriptor</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight19FlightMessageReader10descriptorEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the descriptor for this upload. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight20FlightMetadataWriterE"> |
| <span id="_CPPv3N5arrow6flight20FlightMetadataWriterE"></span><span id="_CPPv2N5arrow6flight20FlightMetadataWriterE"></span><span id="arrow::flight::FlightMetadataWriter"></span><span class="target" id="classarrow_1_1flight_1_1_flight_metadata_writer"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightMetadataWriter</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight20FlightMetadataWriterE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A writer for application-specific metadata sent back to the client during an upload. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight20FlightMetadataWriter13WriteMetadataERK6Buffer"> |
| <span id="_CPPv3N5arrow6flight20FlightMetadataWriter13WriteMetadataERK6Buffer"></span><span id="_CPPv2N5arrow6flight20FlightMetadataWriter13WriteMetadataERK6Buffer"></span><span id="arrow::flight::FlightMetadataWriter::WriteMetadata__BufferCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_metadata_writer_1acbcc91a2d29430578ddf8eee6b60c66f"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">WriteMetadata</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="memory.html#_CPPv4N5arrow6BufferE" title="arrow::Buffer"><span class="n"><span class="pre">Buffer</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">app_metadata</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight20FlightMetadataWriter13WriteMetadataERK6Buffer" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Send a message to the client. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17RecordBatchStreamE"> |
| <span id="_CPPv3N5arrow6flight17RecordBatchStreamE"></span><span id="_CPPv2N5arrow6flight17RecordBatchStreamE"></span><span id="arrow::flight::RecordBatchStream"></span><span class="target" id="classarrow_1_1flight_1_1_record_batch_stream"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">RecordBatchStream</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">flight</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><a class="headerlink" href="#_CPPv4N5arrow6flight17RecordBatchStreamE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A basic implementation of <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> that will provide a sequence of FlightData messages to be written to a stream. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17RecordBatchStream17RecordBatchStreamERKNSt10shared_ptrI17RecordBatchReaderEERKN3ipc15IpcWriteOptionsE"> |
| <span id="_CPPv3N5arrow6flight17RecordBatchStream17RecordBatchStreamERKNSt10shared_ptrI17RecordBatchReaderEERKN3ipc15IpcWriteOptionsE"></span><span id="_CPPv2N5arrow6flight17RecordBatchStream17RecordBatchStreamERKNSt10shared_ptrI17RecordBatchReaderEERKN3ipc15IpcWriteOptionsE"></span><span id="arrow::flight::RecordBatchStream::RecordBatchStream__std::shared_ptr:RecordBatchReader:CR.ipc::IpcWriteOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1_record_batch_stream_1ac2fcf4c337009f94f89d22370230027b"></span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">RecordBatchStream</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="table.html#_CPPv4N5arrow17RecordBatchReaderE" title="arrow::RecordBatchReader"><span class="n"><span class="pre">RecordBatchReader</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">reader</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ipc</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="ipc.html#_CPPv4N5arrow3ipc15IpcWriteOptionsE" title="arrow::ipc::IpcWriteOptions"><span class="n"><span class="pre">IpcWriteOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">ipc</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="ipc.html#_CPPv4N5arrow3ipc15IpcWriteOptionsE" title="arrow::ipc::IpcWriteOptions"><span class="n"><span class="pre">IpcWriteOptions</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">Defaults</span></span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">)</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight17RecordBatchStream17RecordBatchStreamERKNSt10shared_ptrI17RecordBatchReaderEERKN3ipc15IpcWriteOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>reader</strong> – <strong>[in]</strong> produces a sequence of record batches </p></li> |
| <li><p><strong>options</strong> – <strong>[in]</strong> IPC options for writing </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17RecordBatchStream16GetSchemaPayloadEv"> |
| <span id="_CPPv3N5arrow6flight17RecordBatchStream16GetSchemaPayloadEv"></span><span id="_CPPv2N5arrow6flight17RecordBatchStream16GetSchemaPayloadEv"></span><span id="arrow::flight::RecordBatchStream::GetSchemaPayload"></span><span class="target" id="classarrow_1_1flight_1_1_record_batch_stream_1a0c72c5ca1aefa00be7663ffb358918d3"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight13FlightPayloadE" title="arrow::flight::FlightPayload"><span class="n"><span class="pre">FlightPayload</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSchemaPayload</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17RecordBatchStream16GetSchemaPayloadEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Compute <a class="reference internal" href="#structarrow_1_1flight_1_1_flight_payload"><span class="std std-ref">FlightPayload</span></a> containing serialized <a class="reference internal" href="table.html#classarrow_1_1_record_batch"><span class="std std-ref">RecordBatch</span></a> schema. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp"> |
| <span class="target" id="classarrow_1_1flight_1_1_record_batch_stream_1a7264d548cbd6acb4a3055cb871f7fb54"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight13FlightPayloadE" title="arrow::flight::FlightPayload"><span class="n"><span class="pre">FlightPayload</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSchemaPayload</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><br /></dt> |
| <dd><p>Compute <a class="reference internal" href="#structarrow_1_1flight_1_1_flight_payload"><span class="std std-ref">FlightPayload</span></a> containing serialized <a class="reference internal" href="table.html#classarrow_1_1_record_batch"><span class="std std-ref">RecordBatch</span></a> schema. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17ServerAuthHandlerE"> |
| <span id="_CPPv3N5arrow6flight17ServerAuthHandlerE"></span><span id="_CPPv2N5arrow6flight17ServerAuthHandlerE"></span><span id="arrow::flight::ServerAuthHandler"></span><span class="target" id="classarrow_1_1flight_1_1_server_auth_handler"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ServerAuthHandler</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17ServerAuthHandlerE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An authentication implementation for a Flight service. </p> |
| <p>Authentication includes both an initial negotiation and a per-call token validation. Implementations may choose to use either or both mechanisms. An implementation may need to track some state, e.g. a mapping of client tokens to authenticated identities. </p> |
| <p>Subclassed by arrow::flight::NoOpAuthHandler</p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17ServerAuthHandler12AuthenticateERK17ServerCallContextP16ServerAuthSenderP16ServerAuthReader"> |
| <span id="_CPPv3N5arrow6flight17ServerAuthHandler12AuthenticateERK17ServerCallContextP16ServerAuthSenderP16ServerAuthReader"></span><span id="_CPPv2N5arrow6flight17ServerAuthHandler12AuthenticateERK17ServerCallContextP16ServerAuthSenderP16ServerAuthReader"></span><span id="arrow::flight::ServerAuthHandler::Authenticate__ServerCallContextCR.ServerAuthSenderP.ServerAuthReaderP"></span><span class="target" id="classarrow_1_1flight_1_1_server_auth_handler_1a930c222943eb45266a3a0b06c5bf7a73"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Authenticate</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="n"><span class="pre">ServerAuthSender</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">outgoing</span></span>, <span class="n"><span class="pre">ServerAuthReader</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">incoming</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight17ServerAuthHandler12AuthenticateERK17ServerCallContextP16ServerAuthSenderP16ServerAuthReader" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Authenticate the client on initial connection. </p> |
| <p>The server can send and read responses from the client at any time. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>outgoing</strong> – <strong>[in]</strong> The writer for messages to the client. </p></li> |
| <li><p><strong>incoming</strong> – <strong>[in]</strong> The reader for messages from the client. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> OK if this authentication is succeeded. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17ServerAuthHandler12AuthenticateEP16ServerAuthSenderP16ServerAuthReader"> |
| <span id="_CPPv3N5arrow6flight17ServerAuthHandler12AuthenticateEP16ServerAuthSenderP16ServerAuthReader"></span><span id="_CPPv2N5arrow6flight17ServerAuthHandler12AuthenticateEP16ServerAuthSenderP16ServerAuthReader"></span><span id="arrow::flight::ServerAuthHandler::Authenticate__ServerAuthSenderP.ServerAuthReaderP"></span><span class="target" id="classarrow_1_1flight_1_1_server_auth_handler_1a6faae7c7ecba26bb254ecf558d4ffae1"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Authenticate</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">ServerAuthSender</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">outgoing</span></span>, <span class="n"><span class="pre">ServerAuthReader</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">incoming</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight17ServerAuthHandler12AuthenticateEP16ServerAuthSenderP16ServerAuthReader" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Authenticate the client on initial connection. </p> |
| <p>The server can send and read responses from the client at any time. <dl> |
| <dt class="sig sig-object cpp"> |
| <em><span class="pre">Deprecated:</span></em></dt> |
| <dd><p>Deprecated in 13.0.0. Implement the Authentication() with <a class="reference internal" href="#classarrow_1_1flight_1_1_server_call_context"><span class="std std-ref">ServerCallContext</span></a> version instead. </p> |
| </dd></dl> |
| |
| </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>outgoing</strong> – <strong>[in]</strong> The writer for messages to the client. </p></li> |
| <li><p><strong>incoming</strong> – <strong>[in]</strong> The reader for messages from the client. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> OK if this authentication is succeeded. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17ServerAuthHandler7IsValidERK17ServerCallContextRKNSt6stringEPNSt6stringE"> |
| <span id="_CPPv3N5arrow6flight17ServerAuthHandler7IsValidERK17ServerCallContextRKNSt6stringEPNSt6stringE"></span><span id="_CPPv2N5arrow6flight17ServerAuthHandler7IsValidERK17ServerCallContextRKNSt6stringEPNSt6stringE"></span><span id="arrow::flight::ServerAuthHandler::IsValid__ServerCallContextCR.ssCR.ssP"></span><span class="target" id="classarrow_1_1flight_1_1_server_auth_handler_1a7c890a9eaadfa22aaf2c10bbd8144296"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsValid</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">token</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">peer_identity</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight17ServerAuthHandler7IsValidERK17ServerCallContextRKNSt6stringEPNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Validate a per-call client token. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>token</strong> – <strong>[in]</strong> The client token. May be the empty string if the client does not provide a token. </p></li> |
| <li><p><strong>peer_identity</strong> – <strong>[out]</strong> The identity of the peer, if this authentication method supports it. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> OK if the token is valid, any other status if validation failed </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17ServerAuthHandler7IsValidERKNSt6stringEPNSt6stringE"> |
| <span id="_CPPv3N5arrow6flight17ServerAuthHandler7IsValidERKNSt6stringEPNSt6stringE"></span><span id="_CPPv2N5arrow6flight17ServerAuthHandler7IsValidERKNSt6stringEPNSt6stringE"></span><span id="arrow::flight::ServerAuthHandler::IsValid__ssCR.ssP"></span><span class="target" id="classarrow_1_1flight_1_1_server_auth_handler_1a15cb1ed2ffb5c97c0f2e29845e54bc19"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsValid</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">token</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">peer_identity</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight17ServerAuthHandler7IsValidERKNSt6stringEPNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Validate a per-call client token. </p> |
| <p><dl> |
| <dt class="sig sig-object cpp"> |
| <em><span class="pre">Deprecated:</span></em></dt> |
| <dd><p>Deprecated in 13.0.0. Implement the <a class="reference internal" href="#classarrow_1_1flight_1_1_server_auth_handler_1a7c890a9eaadfa22aaf2c10bbd8144296"><span class="std std-ref">IsValid()</span></a> with <a class="reference internal" href="#classarrow_1_1flight_1_1_server_call_context"><span class="std std-ref">ServerCallContext</span></a> version instead. </p> |
| </dd></dl> |
| |
| </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>token</strong> – <strong>[in]</strong> The client token. May be the empty string if the client does not provide a token. </p></li> |
| <li><p><strong>peer_identity</strong> – <strong>[out]</strong> The identity of the peer, if this authentication method supports it. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> OK if the token is valid, any other status if validation failed </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17ServerCallContextE"> |
| <span id="_CPPv3N5arrow6flight17ServerCallContextE"></span><span id="_CPPv2N5arrow6flight17ServerCallContextE"></span><span id="arrow::flight::ServerCallContext"></span><span class="target" id="classarrow_1_1flight_1_1_server_call_context"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ServerCallContext</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17ServerCallContextE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Call state/contextual data. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight17ServerCallContext13peer_identityEv"> |
| <span id="_CPPv3NK5arrow6flight17ServerCallContext13peer_identityEv"></span><span id="_CPPv2NK5arrow6flight17ServerCallContext13peer_identityEv"></span><span id="arrow::flight::ServerCallContext::peer_identityC"></span><span class="target" id="classarrow_1_1flight_1_1_server_call_context_1abc9372b6fc4110789bc1bd94edc6cef0"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">peer_identity</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight17ServerCallContext13peer_identityEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The name of the authenticated peer (may be the empty string) </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight17ServerCallContext4peerEv"> |
| <span id="_CPPv3NK5arrow6flight17ServerCallContext4peerEv"></span><span id="_CPPv2NK5arrow6flight17ServerCallContext4peerEv"></span><span id="arrow::flight::ServerCallContext::peerC"></span><span class="target" id="classarrow_1_1flight_1_1_server_call_context_1a58a569abc8437dc66ca97c9bfbd591a6"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">peer</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight17ServerCallContext4peerEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The peer address (not validated) </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight17ServerCallContext9AddHeaderERKNSt6stringERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow6flight17ServerCallContext9AddHeaderERKNSt6stringERKNSt6stringE"></span><span id="_CPPv2NK5arrow6flight17ServerCallContext9AddHeaderERKNSt6stringERKNSt6stringE"></span><span id="arrow::flight::ServerCallContext::AddHeader__ssCR.ssCRC"></span><span class="target" id="classarrow_1_1flight_1_1_server_call_context_1a43cd5f8c2a633c31da13d3d732d1d2b0"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AddHeader</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">key</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight17ServerCallContext9AddHeaderERKNSt6stringERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Add a response header. </p> |
| <p>This is only valid before the server starts sending the response; generally this isn’t an issue unless you are implementing <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a>, <a class="reference internal" href="#classarrow_1_1flight_1_1_result_stream"><span class="std std-ref">ResultStream</span></a>, or similar interfaces yourself, or during a DoExchange or DoPut. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight17ServerCallContext10AddTrailerERKNSt6stringERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow6flight17ServerCallContext10AddTrailerERKNSt6stringERKNSt6stringE"></span><span id="_CPPv2NK5arrow6flight17ServerCallContext10AddTrailerERKNSt6stringERKNSt6stringE"></span><span id="arrow::flight::ServerCallContext::AddTrailer__ssCR.ssCRC"></span><span class="target" id="classarrow_1_1flight_1_1_server_call_context_1aabbc319849b0dc4ae3ad26ced5b9ccd4"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AddTrailer</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">key</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight17ServerCallContext10AddTrailerERKNSt6stringERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Add a response trailer. </p> |
| <p>This is only valid before the server sends the final status; generally this isn’t an issue unless your RPC handler launches a thread or similar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight17ServerCallContext13GetMiddlewareERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow6flight17ServerCallContext13GetMiddlewareERKNSt6stringE"></span><span id="_CPPv2NK5arrow6flight17ServerCallContext13GetMiddlewareERKNSt6stringE"></span><span id="arrow::flight::ServerCallContext::GetMiddleware__ssCRC"></span><span class="target" id="classarrow_1_1flight_1_1_server_call_context_1a9e5c663e42b9180ee1c78079b297f869"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight16ServerMiddlewareE" title="arrow::flight::ServerMiddleware"><span class="n"><span class="pre">ServerMiddleware</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetMiddleware</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">key</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight17ServerCallContext13GetMiddlewareERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Look up a middleware by key. </p> |
| <p>Do not maintain a reference to the object beyond the request body. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The middleware, or nullptr if not found. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight17ServerCallContext12is_cancelledEv"> |
| <span id="_CPPv3NK5arrow6flight17ServerCallContext12is_cancelledEv"></span><span id="_CPPv2NK5arrow6flight17ServerCallContext12is_cancelledEv"></span><span id="arrow::flight::ServerCallContext::is_cancelledC"></span><span class="target" id="classarrow_1_1flight_1_1_server_call_context_1a1551de041246fadda3ad72a1be30eb68"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">is_cancelled</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight17ServerCallContext12is_cancelledEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Check if the current RPC has been cancelled (by the client, by a network error, etc.). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight17ServerCallContext16incoming_headersEv"> |
| <span id="_CPPv3NK5arrow6flight17ServerCallContext16incoming_headersEv"></span><span id="_CPPv2NK5arrow6flight17ServerCallContext16incoming_headersEv"></span><span id="arrow::flight::ServerCallContext::incoming_headersC"></span><span class="target" id="classarrow_1_1flight_1_1_server_call_context_1aac8f94797060841fe22f3dccaeb03875"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">CallHeaders</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">incoming_headers</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight17ServerCallContext16incoming_headersEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The headers sent by the client for this call. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16ServerMiddlewareE"> |
| <span id="_CPPv3N5arrow6flight16ServerMiddlewareE"></span><span id="_CPPv2N5arrow6flight16ServerMiddlewareE"></span><span id="arrow::flight::ServerMiddleware"></span><span class="target" id="classarrow_1_1flight_1_1_server_middleware"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ServerMiddleware</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16ServerMiddlewareE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Server-side middleware for a call, instantiated per RPC. </p> |
| <p>Middleware should be fast and must be infallible: there is no way to reject the call or report errors from the middleware instance. </p> |
| <p>Subclassed by arrow::flight::TracingServerMiddleware, arrow::flight::sql::ServerSessionMiddleware</p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight16ServerMiddleware4nameEv"> |
| <span id="_CPPv3NK5arrow6flight16ServerMiddleware4nameEv"></span><span id="_CPPv2NK5arrow6flight16ServerMiddleware4nameEv"></span><span id="arrow::flight::ServerMiddleware::nameC"></span><span class="target" id="classarrow_1_1flight_1_1_server_middleware_1a107036290f879e0209321164cc49e6f6"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight16ServerMiddleware4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Unique name of middleware, used as alternative to RTTI. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>the string name of the middleware </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16ServerMiddleware14SendingHeadersEP14AddCallHeaders"> |
| <span id="_CPPv3N5arrow6flight16ServerMiddleware14SendingHeadersEP14AddCallHeaders"></span><span id="_CPPv2N5arrow6flight16ServerMiddleware14SendingHeadersEP14AddCallHeaders"></span><span id="arrow::flight::ServerMiddleware::SendingHeaders__AddCallHeadersP"></span><span class="target" id="classarrow_1_1flight_1_1_server_middleware_1a6f4d5745cc7725577ee0f76558167949"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SendingHeaders</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow6flight14AddCallHeadersE" title="arrow::flight::AddCallHeaders"><span class="n"><span class="pre">AddCallHeaders</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">outgoing_headers</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16ServerMiddleware14SendingHeadersEP14AddCallHeaders" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A callback before headers are sent. </p> |
| <p>Extra headers can be added, but existing ones cannot be read. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16ServerMiddleware13CallCompletedERK6Status"> |
| <span id="_CPPv3N5arrow6flight16ServerMiddleware13CallCompletedERK6Status"></span><span id="_CPPv2N5arrow6flight16ServerMiddleware13CallCompletedERK6Status"></span><span id="arrow::flight::ServerMiddleware::CallCompleted__StatusCR"></span><span class="target" id="classarrow_1_1flight_1_1_server_middleware_1a0c50914c910beb5a5bababe8fd283f1f"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CallCompleted</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">status</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16ServerMiddleware13CallCompletedERK6Status" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A callback after the call has completed. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight23ServerMiddlewareFactoryE"> |
| <span id="_CPPv3N5arrow6flight23ServerMiddlewareFactoryE"></span><span id="_CPPv2N5arrow6flight23ServerMiddlewareFactoryE"></span><span id="arrow::flight::ServerMiddlewareFactory"></span><span class="target" id="classarrow_1_1flight_1_1_server_middleware_factory"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ServerMiddlewareFactory</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight23ServerMiddlewareFactoryE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A factory for new middleware instances. </p> |
| <p>If added to a server, this will be called for each RPC (including Handshake) to give the opportunity to intercept the call.</p> |
| <p>It is guaranteed that all server middleware methods are called from the same thread that calls the RPC method implementation. </p> |
| <p>Subclassed by arrow::flight::sql::ServerSessionMiddlewareFactory</p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight23ServerMiddlewareFactory9StartCallERK8CallInfoRK17ServerCallContextPNSt10shared_ptrI16ServerMiddlewareEE"> |
| <span id="_CPPv3N5arrow6flight23ServerMiddlewareFactory9StartCallERK8CallInfoRK17ServerCallContextPNSt10shared_ptrI16ServerMiddlewareEE"></span><span id="_CPPv2N5arrow6flight23ServerMiddlewareFactory9StartCallERK8CallInfoRK17ServerCallContextPNSt10shared_ptrI16ServerMiddlewareEE"></span><span id="arrow::flight::ServerMiddlewareFactory::StartCall__CallInfoCR.ServerCallContextCR.std::shared_ptr:ServerMiddleware:P"></span><span class="target" id="classarrow_1_1flight_1_1_server_middleware_factory_1ac84a4fe0c1c01fcb4c8409ca77b87910"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">StartCall</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight8CallInfoE" title="arrow::flight::CallInfo"><span class="n"><span class="pre">CallInfo</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">info</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight16ServerMiddlewareE" title="arrow::flight::ServerMiddleware"><span class="n"><span class="pre">ServerMiddleware</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">middleware</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight23ServerMiddlewareFactory9StartCallERK8CallInfoRK17ServerCallContextPNSt10shared_ptrI16ServerMiddlewareEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A callback for the start of a new call. </p> |
| <p>Return a non-OK status to reject the call with the given status.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>info</strong> – <strong>[in]</strong> Information about the call. </p></li> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>middleware</strong> – <strong>[out]</strong> The middleware instance for this call. If null, no middleware will be added to this call instance from this factory. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> A non-OK status will reject the call with the given status. Middleware previously in the chain will have their CallCompleted callback called. Other middleware factories will not be called. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight23ServerMiddlewareFactory9StartCallERK8CallInfoRK11CallHeadersPNSt10shared_ptrI16ServerMiddlewareEE"> |
| <span id="_CPPv3N5arrow6flight23ServerMiddlewareFactory9StartCallERK8CallInfoRK11CallHeadersPNSt10shared_ptrI16ServerMiddlewareEE"></span><span id="_CPPv2N5arrow6flight23ServerMiddlewareFactory9StartCallERK8CallInfoRK11CallHeadersPNSt10shared_ptrI16ServerMiddlewareEE"></span><span id="arrow::flight::ServerMiddlewareFactory::StartCall__CallInfoCR.CallHeadersCR.std::shared_ptr:ServerMiddleware:P"></span><span class="target" id="classarrow_1_1flight_1_1_server_middleware_factory_1a9bc3f954e7d9ea3d5fef428044897004"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">StartCall</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight8CallInfoE" title="arrow::flight::CallInfo"><span class="n"><span class="pre">CallInfo</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">info</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">CallHeaders</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">incoming_headers</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight16ServerMiddlewareE" title="arrow::flight::ServerMiddleware"><span class="n"><span class="pre">ServerMiddleware</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">middleware</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight23ServerMiddlewareFactory9StartCallERK8CallInfoRK11CallHeadersPNSt10shared_ptrI16ServerMiddlewareEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A callback for the start of a new call. </p> |
| <p>Return a non-OK status to reject the call with the given status.</p> |
| <p><dl> |
| <dt class="sig sig-object cpp"> |
| <em><span class="pre">Deprecated:</span></em></dt> |
| <dd><p>Deprecated in 13.0.0. Implement the <a class="reference internal" href="#classarrow_1_1flight_1_1_server_middleware_factory_1ac84a4fe0c1c01fcb4c8409ca77b87910"><span class="std std-ref">StartCall()</span></a> with <a class="reference internal" href="#classarrow_1_1flight_1_1_server_call_context"><span class="std std-ref">ServerCallContext</span></a> version instead. </p> |
| </dd></dl> |
| |
| </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>info</strong> – Information about the call. </p></li> |
| <li><p><strong>incoming_headers</strong> – Headers sent by the client for this call. Do not retain a reference to this object. </p></li> |
| <li><p><strong>middleware</strong> – <strong>[out]</strong> The middleware instance for this call. If null, no middleware will be added to this call instance from this factory. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> A non-OK status will reject the call with the given status. Middleware previously in the chain will have their CallCompleted callback called. Other middleware factories will not be called. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19SimpleFlightListingE"> |
| <span id="_CPPv3N5arrow6flight19SimpleFlightListingE"></span><span id="_CPPv2N5arrow6flight19SimpleFlightListingE"></span><span id="arrow::flight::SimpleFlightListing"></span><span class="target" id="classarrow_1_1flight_1_1_simple_flight_listing"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SimpleFlightListing</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">flight</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight13FlightListingE" title="arrow::flight::FlightListing"><span class="n"><span class="pre">FlightListing</span></span></a><a class="headerlink" href="#_CPPv4N5arrow6flight19SimpleFlightListingE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_listing"><span class="std std-ref">FlightListing</span></a> implementation based on a vector of <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> objects. </p> |
| <p>This can be iterated once, then it is consumed. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19SimpleFlightListing4NextEv"> |
| <span id="_CPPv3N5arrow6flight19SimpleFlightListing4NextEv"></span><span id="_CPPv2N5arrow6flight19SimpleFlightListing4NextEv"></span><span id="arrow::flight::SimpleFlightListing::Next"></span><span class="target" id="classarrow_1_1flight_1_1_simple_flight_listing_1a7e3f9693c1432463d250bc2f3b5b7bd0"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Next</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19SimpleFlightListing4NextEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the next <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> from the iterator. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Arrow result with a single <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a>. Set to <em>nullptr</em> if there are none left. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18SimpleResultStreamE"> |
| <span id="_CPPv3N5arrow6flight18SimpleResultStreamE"></span><span id="_CPPv2N5arrow6flight18SimpleResultStreamE"></span><span id="arrow::flight::SimpleResultStream"></span><span class="target" id="classarrow_1_1flight_1_1_simple_result_stream"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SimpleResultStream</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">flight</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight12ResultStreamE" title="arrow::flight::ResultStream"><span class="n"><span class="pre">ResultStream</span></span></a><a class="headerlink" href="#_CPPv4N5arrow6flight18SimpleResultStreamE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A <a class="reference internal" href="#classarrow_1_1flight_1_1_result_stream"><span class="std std-ref">ResultStream</span></a> implementation based on a vector of <a class="reference internal" href="#structarrow_1_1flight_1_1_result"><span class="std std-ref">Result</span></a> objects. </p> |
| <p>This can be iterated once, then it is consumed. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18SimpleResultStream4NextEv"> |
| <span id="_CPPv3N5arrow6flight18SimpleResultStream4NextEv"></span><span id="_CPPv2N5arrow6flight18SimpleResultStream4NextEv"></span><span id="arrow::flight::SimpleResultStream::Next"></span><span class="target" id="classarrow_1_1flight_1_1_simple_result_stream_1a875ec943301aa3b63593fbbeb7a98e25"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight6ResultE" title="arrow::flight::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Next</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight18SimpleResultStream4NextEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the next <a class="reference internal" href="#structarrow_1_1flight_1_1_result"><span class="std std-ref">Result</span></a> from the iterator. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Arrow result with a single <a class="reference internal" href="#structarrow_1_1flight_1_1_result"><span class="std std-ref">Result</span></a>. Set to <em>nullptr</em> if there are none left. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </section> |
| <section id="error-handling"> |
| <h2>Error Handling<a class="headerlink" href="#error-handling" title="Permalink to this heading">#</a></h2> |
| <p>Error handling uses the normal <a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">arrow::Status</span></code></a> class, combined |
| with a custom <a class="reference internal" href="support.html#_CPPv4N5arrow12StatusDetailE" title="arrow::StatusDetail"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">arrow::StatusDetail</span></code></a> object for Flight-specific |
| error codes.</p> |
| <dl class="cpp enum-class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCodeE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCodeE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCodeE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">flight</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">FlightStatusCode</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int8_t</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCodeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A Flight-specific status code. </p> |
| <p>Used to encode some additional status codes into an Arrow <a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a>. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCode8InternalE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCode8InternalE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCode8InternalE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450aafbf0897a5a83fdd873dfb032ec695d3"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Internal</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCode8InternalE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An implementation error has occurred. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCode8TimedOutE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCode8TimedOutE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCode8TimedOutE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450a9541eb2348d883dd8e32ae0420274c4c"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TimedOut</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCode8TimedOutE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A request timed out. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCode9CancelledE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCode9CancelledE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCode9CancelledE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450aa149e85a44aeec9140e92733d9ed694e"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Cancelled</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCode9CancelledE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A request was cancelled. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCode15UnauthenticatedE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCode15UnauthenticatedE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCode15UnauthenticatedE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450ab403ce880ed2c28d0784a2430a9b6eda"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Unauthenticated</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCode15UnauthenticatedE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>We are not authenticated to the remote service. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCode12UnauthorizedE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCode12UnauthorizedE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCode12UnauthorizedE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450ae06d1ba70f1331e9f9a113cc2f887d3f"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Unauthorized</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCode12UnauthorizedE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>We do not have permission to make this request. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCode11UnavailableE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCode11UnavailableE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCode11UnavailableE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450a453e6aa38d87b28ccae545967c53004f"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Unavailable</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCode11UnavailableE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The remote service cannot handle this request at the moment. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCode6FailedE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCode6FailedE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCode6FailedE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450ad7c8c85bf79bbe1b7188497c32c3b0ca"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Failed</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCode6FailedE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A request failed for some other reason. </p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18FlightStatusDetailE"> |
| <span id="_CPPv3N5arrow6flight18FlightStatusDetailE"></span><span id="_CPPv2N5arrow6flight18FlightStatusDetailE"></span><span id="arrow::flight::FlightStatusDetail"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightStatusDetail</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4N5arrow12StatusDetailE" title="arrow::StatusDetail"><span class="n"><span class="pre">StatusDetail</span></span></a><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStatusDetailE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Flight-specific error information in a <a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a>. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight18FlightStatusDetail7type_idEv"> |
| <span id="_CPPv3NK5arrow6flight18FlightStatusDetail7type_idEv"></span><span id="_CPPv2NK5arrow6flight18FlightStatusDetail7type_idEv"></span><span id="arrow::flight::FlightStatusDetail::type_idC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail_1ab59e2fe85ee3450eff144e0ff6459733"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">type_id</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight18FlightStatusDetail7type_idEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a unique id for the type of the <a class="reference internal" href="support.html#classarrow_1_1_status_detail"><span class="std std-ref">StatusDetail</span></a> (effectively a poor man’s substitute for RTTI). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight18FlightStatusDetail8ToStringEv"> |
| <span id="_CPPv3NK5arrow6flight18FlightStatusDetail8ToStringEv"></span><span id="_CPPv2NK5arrow6flight18FlightStatusDetail8ToStringEv"></span><span id="arrow::flight::FlightStatusDetail::ToStringC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail_1a207c81b2953ee1b50a18988ab8780642"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight18FlightStatusDetail8ToStringEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Produce a human-readable description of this status. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight18FlightStatusDetail4codeEv"> |
| <span id="_CPPv3NK5arrow6flight18FlightStatusDetail4codeEv"></span><span id="_CPPv2NK5arrow6flight18FlightStatusDetail4codeEv"></span><span id="arrow::flight::FlightStatusDetail::codeC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail_1a09f374efbb0448572e53486c0c92ea00"></span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightStatusCodeE" title="arrow::flight::FlightStatusCode"><span class="n"><span class="pre">FlightStatusCode</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">code</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight18FlightStatusDetail4codeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the Flight status code. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight18FlightStatusDetail10extra_infoEv"> |
| <span id="_CPPv3NK5arrow6flight18FlightStatusDetail10extra_infoEv"></span><span id="_CPPv2NK5arrow6flight18FlightStatusDetail10extra_infoEv"></span><span id="arrow::flight::FlightStatusDetail::extra_infoC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail_1a210cc1b0ca7757d395035c546c88ebfb"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">extra_info</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight18FlightStatusDetail10extra_infoEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the extra error info. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight18FlightStatusDetail12CodeAsStringEv"> |
| <span id="_CPPv3NK5arrow6flight18FlightStatusDetail12CodeAsStringEv"></span><span id="_CPPv2NK5arrow6flight18FlightStatusDetail12CodeAsStringEv"></span><span id="arrow::flight::FlightStatusDetail::CodeAsStringC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail_1aa57e23e681bd5d0bd34af31db469b24b"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CodeAsString</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight18FlightStatusDetail12CodeAsStringEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the human-readable name of the status code. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18FlightStatusDetail14set_extra_infoENSt6stringE"> |
| <span id="_CPPv3N5arrow6flight18FlightStatusDetail14set_extra_infoENSt6stringE"></span><span id="_CPPv2N5arrow6flight18FlightStatusDetail14set_extra_infoENSt6stringE"></span><span id="arrow::flight::FlightStatusDetail::set_extra_info__ss"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail_1a24e0b3664e844e71afdfba6f06d2ad1f"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">set_extra_info</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">extra_info</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStatusDetail14set_extra_infoENSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Set the extra error info. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18FlightStatusDetail12UnwrapStatusERKN5arrow6StatusE"> |
| <span id="_CPPv3N5arrow6flight18FlightStatusDetail12UnwrapStatusERKN5arrow6StatusE"></span><span id="_CPPv2N5arrow6flight18FlightStatusDetail12UnwrapStatusERKN5arrow6StatusE"></span><span id="arrow::flight::FlightStatusDetail::UnwrapStatus__arrow::StatusCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail_1acb518cdec271a628e6d6ff00f2379ac1"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight18FlightStatusDetailE" title="arrow::flight::FlightStatusDetail"><span class="n"><span class="pre">FlightStatusDetail</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">UnwrapStatus</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">status</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStatusDetail12UnwrapStatusERKN5arrow6StatusE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Try to extract a <em><a class="reference internal" href="#classarrow_1_1flight_1_1_flight_status_detail"><span class="std std-ref">FlightStatusDetail</span></a></em> from any Arrow status. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>a <em><a class="reference internal" href="#classarrow_1_1flight_1_1_flight_status_detail"><span class="std std-ref">FlightStatusDetail</span></a></em> if it could be unwrapped, <em>nullptr</em> otherwise </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight15MakeFlightErrorE16FlightStatusCodeNSt6stringENSt6stringE"> |
| <span id="_CPPv3N5arrow6flight15MakeFlightErrorE16FlightStatusCodeNSt6stringENSt6stringE"></span><span id="_CPPv2N5arrow6flight15MakeFlightErrorE16FlightStatusCodeNSt6stringENSt6stringE"></span><span id="arrow::flight::MakeFlightError__FlightStatusCode.ss.ss"></span><span class="target" id="namespacearrow_1_1flight_1a4fa5fe5f0e743ee65c77564b353dfef7"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">flight</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">MakeFlightError</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightStatusCodeE" title="arrow::flight::FlightStatusCode"><span class="n"><span class="pre">FlightStatusCode</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">code</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">message</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">extra_info</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight15MakeFlightErrorE16FlightStatusCodeNSt6stringENSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Make an appropriate Arrow status for the given Flight-specific status. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>code</strong> – The Flight status code. </p></li> |
| <li><p><strong>message</strong> – The message for the error. </p></li> |
| <li><p><strong>extra_info</strong> – Optional extra binary info for the error (eg protobuf) </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </section> |
| <section id="implementing-custom-transports"> |
| <h2>Implementing Custom Transports<a class="headerlink" href="#implementing-custom-transports" title="Permalink to this heading">#</a></h2> |
| <p>Internal (but not private) interface for implementing alternate network transports in Flight. </p> |
| <p> |
| To implement a transport, implement ServerTransport and ClientTransport, and register the desired URI schemes with TransportRegistry. Flight takes care of most of the per-RPC details; transports only handle connections and providing a I/O stream implementation (TransportDataStream).</p> |
| <p>On the server side:</p> |
| <p><ol class="arabic simple"> |
| <li><p>Applications subclass FlightServerBase and override RPC handlers.</p></li> |
| <li><p>FlightServerBase::Init will look up and create a ServerTransport based on the scheme of the Location given to it.</p></li> |
| <li><p>The ServerTransport will start the actual server. (For instance, for gRPC, it creates a gRPC server and registers a gRPC service.) That server will handle connections.</p></li> |
| <li><p>The transport should forward incoming calls to the server to the RPC handlers defined on ServerTransport, which implements the actual RPC handler using the interfaces here. Any I/O the RPC handler needs to do is managed by transport-specific implementations of TransportDataStream.</p></li> |
| <li><p>ServerTransport calls FlightServerBase for the actual application logic.</p></li> |
| </ol> |
| </p> |
| <p>On the client side:</p> |
| <p><ol class="arabic simple"> |
| <li><p>Applications create a FlightClient with a Location.</p></li> |
| <li><p>FlightClient will look up and create a ClientTransport based on the scheme of the Location given to it.</p></li> |
| <li><p>When calling a method on FlightClient, FlightClient will delegate to the ClientTransport. There is some indirection, e.g. for DoGet, FlightClient only requests that the ClientTransport start the call and provide it with an I/O stream. The “Flight implementation” itself still lives in FlightClient. </p></li> |
| </ol> |
| </p> |
| <div class="admonition warning"> |
| <p class="admonition-title">Warning</p> |
| <p>EXPERIMENTAL. Subject to change.</p> |
| </div> |
| </section> |
| </section> |
| |
| |
| </article> |
| |
| |
| |
| |
| |
| <footer class="prev-next-footer"> |
| |
| <div class="prev-next-area"> |
| <a class="left-prev" |
| href="cuda.html" |
| title="previous page"> |
| <i class="fa-solid fa-angle-left"></i> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">previous</p> |
| <p class="prev-next-title">CUDA support</p> |
| </div> |
| </a> |
| <a class="right-next" |
| href="flightsql.html" |
| title="next page"> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">next</p> |
| <p class="prev-next-title">Arrow Flight SQL</p> |
| </div> |
| <i class="fa-solid fa-angle-right"></i> |
| </a> |
| </div> |
| </footer> |
| |
| </div> |
| |
| |
| |
| <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner"> |
| |
| |
| <div class="sidebar-secondary-item"> |
| <div |
| id="pst-page-navigation-heading-2" |
| class="page-toc tocsection onthispage"> |
| <i class="fa-solid fa-list"></i> On this page |
| </div> |
| <nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2"> |
| <ul class="visible nav section-nav flex-column"> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#common-types">Common Types</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#clients">Clients</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#servers">Servers</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#error-handling">Error Handling</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#implementing-custom-transports">Implementing Custom Transports</a></li> |
| </ul> |
| </nav></div> |
| |
| <div class="sidebar-secondary-item"> |
| |
| |
| <div class="tocsection editthispage"> |
| <a href="https://github.com/apache/arrow/edit/main/docs/source/cpp/api/flight.rst"> |
| <i class="fa-solid fa-pencil"></i> |
| |
| |
| |
| Edit on GitHub |
| |
| |
| </a> |
| </div> |
| </div> |
| |
| </div></div> |
| |
| |
| </div> |
| <footer class="bd-footer-content"> |
| |
| </footer> |
| |
| </main> |
| </div> |
| </div> |
| |
| <!-- Scripts loaded after <body> so the DOM is not blocked --> |
| <script src="../../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae"></script> |
| <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae"></script> |
| |
| <footer class="bd-footer"> |
| <div class="bd-footer__inner bd-page-width"> |
| |
| <div class="footer-items__start"> |
| |
| <div class="footer-item"> |
| |
| <p class="copyright"> |
| |
| © Copyright 2016-2024 Apache Software Foundation. |
| Apache Arrow, Arrow, Apache, the Apache feather logo, and the Apache Arrow project logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries. |
| <br/> |
| |
| </p> |
| </div> |
| |
| <div class="footer-item"> |
| |
| <p class="sphinx-version"> |
| Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0. |
| <br/> |
| </p> |
| </div> |
| |
| </div> |
| |
| |
| |
| <div class="footer-items__end"> |
| |
| <div class="footer-item"> |
| <p class="theme-version"> |
| Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.15.2. |
| </p></div> |
| |
| </div> |
| |
| </div> |
| |
| </footer> |
| </body> |
| </html> |
