Skip to content

GitLab

Switch branch/tag
Find file Normal viewHistoryPermalink
api.rst 1.31 KB
Newer Older
Antoine Kaufmann's avatar
doc: add documentation skeleton  
Antoine Kaufmann committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54 
API
###################################

The full API documentation extracted by doxygen can be found
`here <https://tas.readthedocs.io/en/latest/_static/doxygen/>`_.


TAS Low-Level Application API
******************************

.. doxygenfunction:: flextcp_init

Contexts
=========================

.. doxygenstruct:: flextcp_context
.. doxygenfunction:: flextcp_context_create
.. doxygenfunction:: flextcp_context_poll
.. doxygenfunction:: flextcp_block


Connections
=========================

.. doxygenstruct:: flextcp_connection
.. doxygenfunction:: flextcp_connection_open
.. doxygenfunction:: flextcp_connection_close
.. doxygenfunction:: flextcp_connection_rx_done
.. doxygenfunction:: flextcp_connection_tx_alloc
.. doxygenfunction:: flextcp_connection_tx_alloc2
.. doxygenfunction:: flextcp_connection_tx_send
.. doxygenfunction:: flextcp_connection_tx_close
.. doxygenfunction:: flextcp_connection_tx_possible
.. doxygenfunction:: flextcp_connection_move

Listeners
=========================

.. doxygenstruct:: flextcp_listener
.. doxygendefine:: FLEXTCP_LISTEN_REUSEPORT
.. doxygenfunction:: flextcp_listen_open
.. doxygenfunction:: flextcp_listen_accept

Events
=========================

.. doxygenenum:: flextcp_event_type

.. doxygenstruct:: flextcp_event
  :members:

TAS Sockets API
******************************