:orphan:

.. index:: pair: struct; tapi_job_buffer_t
.. _doxid-structtapi__job__buffer__t:

struct tapi_job_buffer_t
========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

A structure to store messages read by :ref:`tapi_job_receive() <doxid-group__tapi__job_1ga3a58e482b9feb298d3cc74b6014de008>` or :ref:`tapi_job_receive_last() <doxid-group__tapi__job_1ga7e476fc0e48fe2bf3359c470f40ae9ba>`. :ref:`More...<details-structtapi__job__buffer__t>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <tapi_job.h>
	
	struct tapi_job_buffer_t {
		// fields
	
		:ref:`tapi_job_channel_t<doxid-group__tapi__job_1ga91bc512c5a63505cbb40c396039c84e0>`* :ref:`channel<doxid-structtapi__job__buffer__t_1a73dce721c725dd6a2bef708ac4941aa6>`;
		:ref:`tapi_job_channel_t<doxid-group__tapi__job_1ga91bc512c5a63505cbb40c396039c84e0>`* :ref:`filter<doxid-structtapi__job__buffer__t_1a846d158a3baf0a362c706d7a40e75795>`;
		unsigned int :ref:`dropped<doxid-structtapi__job__buffer__t_1a3ac3e72e91081ae54f85c3275f032dd4>`;
		bool :ref:`eos<doxid-structtapi__job__buffer__t_1a1d8fc89223898039bdf9d50680bd960e>`;
		:ref:`te_string<doxid-structte__string>` :ref:`data<doxid-structtapi__job__buffer__t_1a2bec63436e4ecafc450d2b92543089de>`;
	};
.. _details-structtapi__job__buffer__t:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

A structure to store messages read by :ref:`tapi_job_receive() <doxid-group__tapi__job_1ga3a58e482b9feb298d3cc74b6014de008>` or :ref:`tapi_job_receive_last() <doxid-group__tapi__job_1ga7e476fc0e48fe2bf3359c470f40ae9ba>`.

Fields
------

.. index:: pair: variable; channel
.. _doxid-structtapi__job__buffer__t_1a73dce721c725dd6a2bef708ac4941aa6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_job_channel_t<doxid-group__tapi__job_1ga91bc512c5a63505cbb40c396039c84e0>`* channel

Last message channel

.. index:: pair: variable; filter
.. _doxid-structtapi__job__buffer__t_1a846d158a3baf0a362c706d7a40e75795:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_job_channel_t<doxid-group__tapi__job_1ga91bc512c5a63505cbb40c396039c84e0>`* filter

Last message filter

.. index:: pair: variable; dropped
.. _doxid-structtapi__job__buffer__t_1a3ac3e72e91081ae54f85c3275f032dd4:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned int dropped

Number of dropped messages

.. index:: pair: variable; eos
.. _doxid-structtapi__job__buffer__t_1a1d8fc89223898039bdf9d50680bd960e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool eos

``true`` if the stream behind the filter has been closed. If :ref:`eos <doxid-structtapi__job__buffer__t_1a1d8fc89223898039bdf9d50680bd960e>` is received and a job is not started again, the next :ref:`tapi_job_receive() <doxid-group__tapi__job_1ga3a58e482b9feb298d3cc74b6014de008>` will time out. The stream behind the filter is re-opened when a job restarts. :ref:`eos <doxid-structtapi__job__buffer__t_1a1d8fc89223898039bdf9d50680bd960e>` is used as a separation between runs.

.. index:: pair: variable; data
.. _doxid-structtapi__job__buffer__t_1a2bec63436e4ecafc450d2b92543089de:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_string<doxid-structte__string>` data

Data buffer