> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# gpudb::WorkerQueue

> gpudb::WorkerQueue — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p><code>#include \<<a className="el" href="/content/api/cpp/GPUdbMultiHeadIOUtils_8h_source">gpudb/utils/GPUdbMultiHeadIOUtils.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Types</h2>
        </td>
      </tr>

      <tr className="memitem:a7d07f517d92d92c0ff1261c454438125" id="r_a7d07f517d92d92c0ff1261c454438125">
        <td className="memItemLeft" align="right" valign="top">typedef std::vector\< <a className="el" href="/content/api/cpp/classgpudb_1_1GenericRecord">gpudb::GenericRecord</a> > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7d07f517d92d92c0ff1261c454438125">recordVector\_T</a></td>
      </tr>

      <tr className="separator:a7d07f517d92d92c0ff1261c454438125">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:ab52bb6a9cb08ef17cdfd55c9f5cdb744" id="r_ab52bb6a9cb08ef17cdfd55c9f5cdb744">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ab52bb6a9cb08ef17cdfd55c9f5cdb744">WorkerQueue</a> (const std::string \&url)</td>
      </tr>

      <tr className="separator:ab52bb6a9cb08ef17cdfd55c9f5cdb744">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ab0f42fd8e98c998dd942e95caa04f79f" id="r_ab0f42fd8e98c998dd942e95caa04f79f">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ab0f42fd8e98c998dd942e95caa04f79f">WorkerQueue</a> (const std::string \&url, size\_t capacity)</td>
      </tr>

      <tr className="separator:ab0f42fd8e98c998dd942e95caa04f79f">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a7c6c1b73125440f7a347003a79e10f92" id="r_a7c6c1b73125440f7a347003a79e10f92">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7c6c1b73125440f7a347003a79e10f92">\~WorkerQueue</a> ()</td>
      </tr>

      <tr className="separator:a7c6c1b73125440f7a347003a79e10f92">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a76edee013fff261854dba60b51cc3a90" id="r_a76edee013fff261854dba60b51cc3a90">
        <td className="memItemLeft" align="right" valign="top">void </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a76edee013fff261854dba60b51cc3a90">clear</a> ()</td>
      </tr>

      <tr className="memdesc:a76edee013fff261854dba60b51cc3a90">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Clear queue without sending. <br /></td>
      </tr>

      <tr className="separator:a76edee013fff261854dba60b51cc3a90">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ae1ebf25077817be5d017fdb2d217a402" id="r_ae1ebf25077817be5d017fdb2d217a402">
        <td className="memItemLeft" align="right" valign="top">const <a className="el" href="/content/api/cpp/classgpudb_1_1HttpUrl">gpudb::HttpUrl</a> & </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ae1ebf25077817be5d017fdb2d217a402">get\_url</a> () const</td>
      </tr>

      <tr className="memdesc:ae1ebf25077817be5d017fdb2d217a402">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Returns the URL in string format for this worker. <br /></td>
      </tr>

      <tr className="separator:ae1ebf25077817be5d017fdb2d217a402">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ac71ba1393090df7fb41e207b6d322c30" id="r_ac71ba1393090df7fb41e207b6d322c30">
        <td className="memItemLeft" align="right" valign="top">void </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ac71ba1393090df7fb41e207b6d322c30">flush</a> (<a className="el" href="#a7d07f517d92d92c0ff1261c454438125">recordVector\_T</a> \&flushed\_records)</td>
      </tr>

      <tr className="memdesc:ac71ba1393090df7fb41e207b6d322c30">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Returns the current queue and creates a new internal queue. <br /></td>
      </tr>

      <tr className="separator:ac71ba1393090df7fb41e207b6d322c30">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a578b09746f8c0683af2803d18595e69f" id="r_a578b09746f8c0683af2803d18595e69f">
        <td className="memItemLeft" align="right" valign="top">bool </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a578b09746f8c0683af2803d18595e69f">insert</a> (const <a className="el" href="/content/api/cpp/classgpudb_1_1GenericRecord">gpudb::GenericRecord</a> \&record, const <a className="el" href="/content/api/cpp/classgpudb_1_1RecordKey">RecordKey</a> \&key, <a className="el" href="#a7d07f517d92d92c0ff1261c454438125">recordVector\_T</a> \&flushed\_records)</td>
      </tr>

      <tr className="memdesc:a578b09746f8c0683af2803d18595e69f">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Inserts a record into the queue. <br /></td>
      </tr>

      <tr className="separator:a578b09746f8c0683af2803d18595e69f">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/GPUdbMultiHeadIOUtils_8h_source#l00333">333</a> of file <a className="el" href="/content/api/cpp/GPUdbMultiHeadIOUtils_8h_source">GPUdbMultiHeadIOUtils.h</a>.</p>
    </div>

    <h2 className="groupheader">Member Typedef Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a7d07f517d92d92c0ff1261c454438125">◆ </a></span>recordVector\_T</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">typedef std::vector\<<a className="el" href="/content/api/cpp/classgpudb_1_1GenericRecord">gpudb::GenericRecord</a>> <a className="el" href="#a7d07f517d92d92c0ff1261c454438125">gpudb::WorkerQueue::recordVector\_T</a></td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/GPUdbMultiHeadIOUtils_8h_source#l00338">338</a> of file <a className="el" href="/content/api/cpp/GPUdbMultiHeadIOUtils_8h_source">GPUdbMultiHeadIOUtils.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#ab52bb6a9cb08ef17cdfd55c9f5cdb744">◆ </a></span>WorkerQueue() <span className="overload">\[1/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">gpudb::WorkerQueue::WorkerQueue </td>
            <td>(</td>
            <td className="paramtype">const std::string &</td>
            <td className="paramname"><span className="paramname"><span className="em">url</span></span></td>
            <td>)</td>

            <td />
          </tr>
        </table>
      </div>

      <div className="memdoc" />
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ab0f42fd8e98c998dd942e95caa04f79f">◆ </a></span>WorkerQueue() <span className="overload">\[2/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">gpudb::WorkerQueue::WorkerQueue </td>
            <td>(</td>
            <td className="paramtype">const std::string &</td>
            <td className="paramname"><span className="paramname"><span className="em">url</span></span>, </td>
          </tr>

          <tr>
            <td className="paramkey" />

            <td />

            <td className="paramtype">size\_t</td>
            <td className="paramname"><span className="paramname"><span className="em">capacity</span></span> )</td>
          </tr>
        </table>
      </div>

      <div className="memdoc" />
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a7c6c1b73125440f7a347003a79e10f92">◆ </a></span>\~WorkerQueue()</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">gpudb::WorkerQueue::\~WorkerQueue </td>
            <td>(</td>

            <td className="paramname">
              <span className="paramname">
                <span className="em" />
              </span>
            </td>

            <td>)</td>

            <td />
          </tr>
        </table>
      </div>

      <div className="memdoc" />
    </div>

    <h2 className="groupheader">Member Function Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a76edee013fff261854dba60b51cc3a90">◆ </a></span>clear()</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">void gpudb::WorkerQueue::clear </td>
            <td>(</td>

            <td className="paramname">
              <span className="paramname">
                <span className="em" />
              </span>
            </td>

            <td>)</td>

            <td />
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Clear queue without sending. </p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ac71ba1393090df7fb41e207b6d322c30">◆ </a></span>flush()</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">void gpudb::WorkerQueue::flush </td>
            <td>(</td>
            <td className="paramtype"><a className="el" href="#a7d07f517d92d92c0ff1261c454438125">recordVector\_T</a> &</td>
            <td className="paramname"><span className="paramname"><span className="em">flushed\_records</span></span></td>
            <td>)</td>

            <td />
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Returns the current queue and creates a new internal queue. </p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ae1ebf25077817be5d017fdb2d217a402">◆ </a></span>get\_url()</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const <a className="el" href="/content/api/cpp/classgpudb_1_1HttpUrl">gpudb::HttpUrl</a> & gpudb::WorkerQueue::get\_url </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>
                  <td> const</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Returns the URL in string format for this worker. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/GPUdbMultiHeadIOUtils_8h_source#l00363">363</a> of file <a className="el" href="/content/api/cpp/GPUdbMultiHeadIOUtils_8h_source">GPUdbMultiHeadIOUtils.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a578b09746f8c0683af2803d18595e69f">◆ </a></span>insert()</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">bool gpudb::WorkerQueue::insert </td>
            <td>(</td>
            <td className="paramtype">const <a className="el" href="/content/api/cpp/classgpudb_1_1GenericRecord">gpudb::GenericRecord</a> &</td>
            <td className="paramname"><span className="paramname"><span className="em">record</span></span>, </td>
          </tr>

          <tr>
            <td className="paramkey" />

            <td />

            <td className="paramtype">const <a className="el" href="/content/api/cpp/classgpudb_1_1RecordKey">RecordKey</a> &</td>
            <td className="paramname"><span className="paramname"><span className="em">key</span></span>, </td>
          </tr>

          <tr>
            <td className="paramkey" />

            <td />

            <td className="paramtype"><a className="el" href="#a7d07f517d92d92c0ff1261c454438125">recordVector\_T</a> &</td>
            <td className="paramname"><span className="paramname"><span className="em">flushed\_records</span></span> )</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Inserts a record into the queue. </p>
      </div>
    </div>

    <hr />

    The documentation for this class was generated from the following file:

    <ul>
      <li>gpudb/utils/<a className="el" href="/content/api/cpp/GPUdbMultiHeadIOUtils_8h_source">GPUdbMultiHeadIOUtils.h</a></li>
    </ul>
  </div>
</div>