:orphan:

.. index:: pair: group; TAPI to manage bttrack torrent tracker (tapi_bttrack)
.. _doxid-group__tapi__bttrack:

TAPI to manage bttrack torrent tracker (tapi_bttrack)
=====================================================

.. toctree::
	:hidden:

	struct_tapi_bttrack_app.rst
	struct_tapi_bttrack_opt.rst

Overview
~~~~~~~~

TAPI to manage *bttrack* torrent tracker (from *bittornado* package). :ref:`More...<details-group__tapi__bttrack>`


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

	
	// typedefs

	typedef struct :ref:`tapi_bttrack_app<doxid-structtapi__bttrack__app>` :target:`tapi_bttrack_app<doxid-group__tapi__bttrack_1ga9b7cf6588fa72eced4f3c1160dc85b3c>`;
	typedef struct :ref:`tapi_bttrack_opt<doxid-structtapi__bttrack__opt>` :ref:`tapi_bttrack_opt<doxid-group__tapi__bttrack_1ga96f1252423142dd2f0d4a60071f10b76>`;

	// structs

	struct :ref:`tapi_bttrack_app<doxid-structtapi__bttrack__app>`;
	struct :ref:`tapi_bttrack_opt<doxid-structtapi__bttrack__opt>`;

	// global variables

	const :ref:`tapi_bttrack_opt<doxid-structtapi__bttrack__opt>` :ref:`tapi_bttrack_default_opt<doxid-group__tapi__bttrack_1ga5d1d72c1def7da3939ee5b2477c25688>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_bttrack_create<doxid-group__tapi__bttrack_1gabe9f05ef438afdcb93f67dff7f746324>`(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const char* ip, :ref:`tapi_bttrack_opt<doxid-structtapi__bttrack__opt>`* opt, :ref:`tapi_bttrack_app<doxid-structtapi__bttrack__app>`** app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_bttrack_start<doxid-group__tapi__bttrack_1ga465663dbf78e19a6b6d6f1388d9d1625>`(:ref:`tapi_bttrack_app<doxid-structtapi__bttrack__app>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_bttrack_wait<doxid-group__tapi__bttrack_1ga65331a3b3e509cb72379742e21bea818>`(:ref:`tapi_bttrack_app<doxid-structtapi__bttrack__app>`* app, int timeout_ms);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_bttrack_kill<doxid-group__tapi__bttrack_1ga660b1997b3eebab67c1bd5d2652214ce>`(:ref:`tapi_bttrack_app<doxid-structtapi__bttrack__app>`* app, int signum);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_bttrack_stop<doxid-group__tapi__bttrack_1ga7fa3084d61b0e6b5556da464627c3e64>`(:ref:`tapi_bttrack_app<doxid-structtapi__bttrack__app>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_bttrack_destroy<doxid-group__tapi__bttrack_1gaf754f3d21f88c3aa059c030b3b18cc3c>`(:ref:`tapi_bttrack_app<doxid-structtapi__bttrack__app>`* app);

.. _details-group__tapi__bttrack:

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

TAPI to manage *bttrack* torrent tracker (from *bittornado* package).

Copyright (C) 2021-2022 OKTET Labs Ltd. All rights reserved.

Typedefs
--------

.. index:: pair: typedef; tapi_bttrack_opt
.. _doxid-group__tapi__bttrack_1ga96f1252423142dd2f0d4a60071f10b76:

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

	typedef struct :ref:`tapi_bttrack_opt<doxid-structtapi__bttrack__opt>` tapi_bttrack_opt

bttrack specific options

Global Variables
----------------

.. index:: pair: variable; tapi_bttrack_default_opt
.. _doxid-group__tapi__bttrack_1ga5d1d72c1def7da3939ee5b2477c25688:

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

	const :ref:`tapi_bttrack_opt<doxid-structtapi__bttrack__opt>` tapi_bttrack_default_opt

Default bttrack options initializer

Global Functions
----------------

.. index:: pair: function; tapi_bttrack_create
.. _doxid-group__tapi__bttrack_1gabe9f05ef438afdcb93f67dff7f746324:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_bttrack_create(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const char* ip, :ref:`tapi_bttrack_opt<doxid-structtapi__bttrack__opt>`* opt, :ref:`tapi_bttrack_app<doxid-structtapi__bttrack__app>`** app)

Create bttrack app.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- factory

		- Job factory.

	*
		- ip

		- IP address of the tracker.

	*
		- opt

		- bttrack options.

	*
		- app

		- bttrack app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_bttrack_start
.. _doxid-group__tapi__bttrack_1ga465663dbf78e19a6b6d6f1388d9d1625:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_bttrack_start(:ref:`tapi_bttrack_app<doxid-structtapi__bttrack__app>`* app)

Start bttrack.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- bttrack app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_bttrack_wait
.. _doxid-group__tapi__bttrack_1ga65331a3b3e509cb72379742e21bea818:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_bttrack_wait(:ref:`tapi_bttrack_app<doxid-structtapi__bttrack__app>`* app, int timeout_ms)

Wait for bttrack completion.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- bttrack app handle.

	*
		- timeout_ms

		- Wait timeout in milliseconds.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_bttrack_kill
.. _doxid-group__tapi__bttrack_1ga660b1997b3eebab67c1bd5d2652214ce:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_bttrack_kill(:ref:`tapi_bttrack_app<doxid-structtapi__bttrack__app>`* app, int signum)

Send a signal to bttrack.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- bttrack app handle.

	*
		- signum

		- Signal to send.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_bttrack_stop
.. _doxid-group__tapi__bttrack_1ga7fa3084d61b0e6b5556da464627c3e64:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_bttrack_stop(:ref:`tapi_bttrack_app<doxid-structtapi__bttrack__app>`* app)

Stop bttrack. It can be started over with :ref:`tapi_bttrack_start() <doxid-group__tapi__bttrack_1ga465663dbf78e19a6b6d6f1388d9d1625>`.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- bttrack app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_bttrack_destroy
.. _doxid-group__tapi__bttrack_1gaf754f3d21f88c3aa059c030b3b18cc3c:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_bttrack_destroy(:ref:`tapi_bttrack_app<doxid-structtapi__bttrack__app>`* app)

Destroy bttrack app (free memory, etc.).



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- bttrack app handle.



.. rubric:: Returns:

Status code.