:orphan:

.. index:: pair: group; STP
.. _doxid-group__tapi__tad__stp:

STP
===

.. toctree::
	:hidden:

Overview
~~~~~~~~

Declarations of API for Spanning tree Protocol. :ref:`More...<details-group__tapi__tad__stp>`


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

	
	// typedefs

	typedef void (*:ref:`tapi_stp_bpdu_callback<doxid-group__tapi__tad__stp_1ga5a797ea3be4ec563fbcd6535fb8695ee>`)(
		const ndn_stp_bpdu_t *bpdu,
		const struct timeval *time_stamp,
		void *userdata
		);

	// global functions

	int :ref:`tapi_stp_plain_csap_create<doxid-group__tapi__tad__stp_1gac7312c60c230c9c5a96e9352823861f1>`(const char* ta_name, int sid, const char* ifname, const uint8_t* own_mac_addr, const uint8_t* peer_mac_addr, :ref:`csap_handle_t<doxid-tad__common_8h_1a7e2c7bef7cfecc60d78d3abd2c200ea8>`* stp_csap);
	int :ref:`tapi_stp_bpdu_send<doxid-group__tapi__tad__stp_1ga3e9251c12dc4fde4a43cbf8cce275278>`(const char* ta_name, int sid, :ref:`csap_handle_t<doxid-tad__common_8h_1a7e2c7bef7cfecc60d78d3abd2c200ea8>` stp_csap, const :ref:`asn_value<doxid-structasn__value>`* templ);

.. _details-group__tapi__tad__stp:

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

Declarations of API for Spanning tree Protocol.

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

Typedefs
--------

.. index:: pair: typedef; tapi_stp_bpdu_callback
.. _doxid-group__tapi__tad__stp_1ga5a797ea3be4ec563fbcd6535fb8695ee:

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

	typedef void (*tapi_stp_bpdu_callback)(
		const ndn_stp_bpdu_t *bpdu,
		const struct timeval *time_stamp,
		void *userdata
		)

Callback function for the tapi_eth_recv_start() routine, it is called for each packet received for csap.



.. rubric:: Parameters:

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

	*
		- header

		- Structure with Ethernet header of the frame.

	*
		- payload

		- Payload of the frame.

	*
		- plen

		- Length of the frame payload.

	*
		- userdata

		- Pointer to user data, provided by the caller of tapi_eth_recv_start.

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

.. index:: pair: function; tapi_stp_plain_csap_create
.. _doxid-group__tapi__tad__stp_1gac7312c60c230c9c5a96e9352823861f1:

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

	int tapi_stp_plain_csap_create(const char* ta_name, int sid, const char* ifname, const uint8_t* own_mac_addr, const uint8_t* peer_mac_addr, :ref:`csap_handle_t<doxid-tad__common_8h_1a7e2c7bef7cfecc60d78d3abd2c200ea8>`* stp_csap)

Creates STP CSAP that can be used for sending/receiving Configuration and Notification BPDUs specified in Media Access Control (MAC) Bridges ANSI/IEEE Std. 802.1D, 1998 Edition section 9

If "own_mac_addr" parameter is not NULL, then "peer_mac_addr" has to be NULL, and vice versa - If "peer_mac_addr" parameter is not NULL, then "own_mac_addr" has to be NULL. If both "peer_mac_addr" and "own_mac_addr" are NULL, then "own_mac_addr" is assumed to be MAC address of the specified interface on the Agent.



.. rubric:: Parameters:

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

	*
		- ta_name

		- Test Agent name where CSAP will be created

	*
		- sid

		- RCF session;

	*
		- ifname

		- Name of an interface the CSAP is attached to (frames are sent/captured from/on this interface)

	*
		- own_mac_addr

		- 
		  Default MAC address used on the Agent:
		  
		  * source MAC address of outgoing from the CASP frames,

	*
		- peer_mac_addr

		- 
		  Default peer MAC address:
		  
		  * source MAC address of incoming into the CSAP frames

	*
		- stp_csap

		- Created STP CSAP (OUT)



.. rubric:: Returns:

Status of the operation

.. index:: pair: function; tapi_stp_bpdu_send
.. _doxid-group__tapi__tad__stp_1ga3e9251c12dc4fde4a43cbf8cce275278:

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

	int tapi_stp_bpdu_send(const char* ta_name, int sid, :ref:`csap_handle_t<doxid-tad__common_8h_1a7e2c7bef7cfecc60d78d3abd2c200ea8>` stp_csap, const :ref:`asn_value<doxid-structasn__value>`* templ)

Sends STP BPDU from the specified CSAP



.. rubric:: Parameters:

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

	*
		- ta_name

		- Test Agent name

	*
		- sid

		- RCF session identifier

	*
		- stp_csap

		- CSAP handle

	*
		- templ

		- Traffic template

	*
		- TE_EINVAL

		- This code is returned if "peer_mac_addr" value wasn't specified on creating the CSAP and "dst_mac_addr" parameter is NULL.

	*
		- 0

		- BPDU is sent



.. rubric:: Returns:

Status of the operation