This module defines SAI Two-Way Active Measurement Protocol interface. More...

#include <saitypes.h>

Classes
struct	_sai_twamp_session_stats_data_t
	Notification data format received from SAI TWAMP callback. More...

struct	_sai_twamp_session_event_notification_data_t
	Defines the operational status of the TWAMP session. More...

struct	_sai_twamp_api_t
	Two-Way Active Measurement Protocol method table retrieved with sai_api_query() More...

Typedefs
typedef enum _sai_twamp_session_auth_mode_t	sai_twamp_session_auth_mode_t
	SAI Two-Way Active Measurement Protocol session authentication mode, there are three modes: unauthenticated, authenticated, and encrypted.

typedef enum _sai_twamp_session_role_t	sai_twamp_session_role_t
	SAI Two-Way Active Measurement Protocol role.

typedef enum _sai_twamp_mode_t	sai_twamp_mode_t
	SAI Two-Way Active Measurement Protocol mode.

typedef enum _sai_twamp_pkt_tx_mode_t	sai_twamp_pkt_tx_mode_t
	SAI Two-Way Active Measurement transmitting mode.

typedef enum _sai_twamp_timestamp_format_t	sai_twamp_timestamp_format_t
	SAI Two-Way Active Measurement format of timestamp.

typedef enum _sai_twamp_encapsulation_type_t	sai_twamp_encapsulation_type_t
	SAI Two-Way Active Measurement Protocol type of encapsulation.

typedef enum _sai_twamp_session_attr_t	sai_twamp_session_attr_t
	SAI attributes for Two-Way Active Measurement Protocol session.

typedef enum _sai_twamp_session_stat_t	sai_twamp_session_stat_t
	Two-Way Active Measurement Protocol Session counter IDs in sai_get_twamp_session_stats() call.

typedef enum _sai_twamp_session_state_t	sai_twamp_session_state_t
	SAI TWAMP session state.

typedef struct _sai_twamp_session_stats_data_t	sai_twamp_session_stats_data_t
	Notification data format received from SAI TWAMP callback.

typedef struct _sai_twamp_session_event_notification_data_t	sai_twamp_session_event_notification_data_t
	Defines the operational status of the TWAMP session.

typedef sai_status_t(*	sai_create_twamp_session_fn) (_Out_ sai_object_id_t twamp_session_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t attr_list)
	Create Two-Way Active Measurement Protocol session.

typedef sai_status_t(*	sai_remove_twamp_session_fn) (_In_ sai_object_id_t twamp_session_id)
	Remove Two-Way Active Measurement Protocol session.

typedef sai_status_t(*	sai_set_twamp_session_attribute_fn) (_In_ sai_object_id_t twamp_session_id, _In_ const sai_attribute_t *attr)
	Set Two-Way Active Measurement Protocol session attributes.

typedef sai_status_t(*	sai_get_twamp_session_attribute_fn) (_In_ sai_object_id_t twamp_session_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get Two-Way Active Measurement Protocol session attributes.

typedef sai_status_t(*	sai_get_twamp_session_stats_fn) (_In_ sai_object_id_t twamp_session_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t counter_ids, _Out_ uint64_t counters)
	Get Two-Way Active Measurement Protocol session statistics counters.

typedef sai_status_t(*	sai_get_twamp_session_stats_ext_fn) (_In_ sai_object_id_t twamp_session_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t counter_ids, _In_ sai_stats_mode_t mode, _Out_ uint64_t counters)
	Get Two-Way Active Measurement Protocol session statistics counters extended.

typedef sai_status_t(*	sai_clear_twamp_session_stats_fn) (_In_ sai_object_id_t twamp_session_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids)
	Clear Two-Way Active Measurement Protocol session statistics counters.

typedef void(*	sai_twamp_session_event_notification_fn) (_In_ uint32_t count, _In_ const sai_twamp_session_event_notification_data_t *data)
	TWAMP session notification.

typedef struct _sai_twamp_api_t	sai_twamp_api_t
	Two-Way Active Measurement Protocol method table retrieved with sai_api_query()

Enumerations
enum	_sai_twamp_session_auth_mode_t { SAI_TWAMP_SESSION_AUTH_MODE_UNAUTHENTICATED = 0 , SAI_TWAMP_SESSION_AUTH_MODE_AUTHENTICATED , SAI_TWAMP_SESSION_AUTH_MODE_ENCRYPTED }
	SAI Two-Way Active Measurement Protocol session authentication mode, there are three modes: unauthenticated, authenticated, and encrypted. More...

enum	_sai_twamp_session_role_t { SAI_TWAMP_SESSION_ROLE_SENDER = 0 , SAI_TWAMP_SESSION_ROLE_REFLECTOR }
	SAI Two-Way Active Measurement Protocol role. More...

enum	_sai_twamp_mode_t { SAI_TWAMP_MODE_FULL = 0 , SAI_TWAMP_MODE_LIGHT }
	SAI Two-Way Active Measurement Protocol mode. More...

enum	_sai_twamp_pkt_tx_mode_t { SAI_TWAMP_PKT_TX_MODE_CONTINUOUS = 0 , SAI_TWAMP_PKT_TX_MODE_PACKET_COUNT , SAI_TWAMP_PKT_TX_MODE_PERIOD }
	SAI Two-Way Active Measurement transmitting mode. More...

enum	_sai_twamp_timestamp_format_t { SAI_TWAMP_TIMESTAMP_FORMAT_NTP = 0 , SAI_TWAMP_TIMESTAMP_FORMAT_PTP }
	SAI Two-Way Active Measurement format of timestamp. More...

enum	_sai_twamp_encapsulation_type_t { SAI_TWAMP_ENCAPSULATION_TYPE_IP = 0 , SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L2VPN , SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L3VPN , SAI_TWAMP_ENCAPSULATION_TYPE_VXLAN }
	SAI Two-Way Active Measurement Protocol type of encapsulation. More...

enum	_sai_twamp_session_attr_t { SAI_TWAMP_SESSION_ATTR_START , SAI_TWAMP_SESSION_ATTR_TWAMP_MODE = SAI_TWAMP_SESSION_ATTR_START , SAI_TWAMP_SESSION_ATTR_SESSION_ROLE , SAI_TWAMP_SESSION_ATTR_AUTH_MODE , SAI_TWAMP_SESSION_ATTR_HW_LOOKUP_VALID , SAI_TWAMP_SESSION_ATTR_VIRTUAL_ROUTER , SAI_TWAMP_SESSION_ATTR_SRC_MAC , SAI_TWAMP_SESSION_ATTR_DST_MAC , SAI_TWAMP_SESSION_ATTR_VLAN_ID , SAI_TWAMP_SESSION_ATTR_VLAN_PRI , SAI_TWAMP_SESSION_ATTR_VLAN_CFI , SAI_TWAMP_SESSION_ATTR_VLAN_HEADER_VALID , SAI_TWAMP_SESSION_ATTR_SRC_IP , SAI_TWAMP_SESSION_ATTR_DST_IP , SAI_TWAMP_SESSION_ATTR_UDP_SRC_PORT , SAI_TWAMP_SESSION_ATTR_UDP_DST_PORT , SAI_TWAMP_SESSION_ATTR_DSCP , SAI_TWAMP_SESSION_ATTR_TTL , SAI_TWAMP_SESSION_ATTR_TUNNEL_SRC_MAC , SAI_TWAMP_SESSION_ATTR_TUNNEL_DST_MAC , SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_ID , SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_PRI , SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_CFI , SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_HEADER_VALID , SAI_TWAMP_SESSION_ATTR_TUNNEL_LABELSTACK , SAI_TWAMP_SESSION_ATTR_TUNNEL_SRC_IP , SAI_TWAMP_SESSION_ATTR_TUNNEL_DST_IP , SAI_TWAMP_SESSION_ATTR_TUNNEL_VNI , SAI_TWAMP_SESSION_ATTR_TUNNEL_UDP_SRC_PORT , SAI_TWAMP_SESSION_ATTR_TUNNEL_UDP_DST_PORT , SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE , SAI_TWAMP_SESSION_ATTR_TWAMP_TIMESTAMP_FORMAT , SAI_TWAMP_SESSION_ATTR_SESSION_ENABLE_TRANSMIT , SAI_TWAMP_SESSION_ATTR_PACKET_LENGTH , SAI_TWAMP_SESSION_ATTR_PORT , SAI_TWAMP_SESSION_ATTR_TRANSMIT_PORT , SAI_TWAMP_SESSION_ATTR_RECEIVE_PORT , SAI_TWAMP_SESSION_ATTR_TWAMP_PKT_TX_MODE , SAI_TWAMP_SESSION_ATTR_TX_PKT_CNT , SAI_TWAMP_SESSION_ATTR_TX_PKT_PERIOD , SAI_TWAMP_SESSION_ATTR_TX_INTERVAL , SAI_TWAMP_SESSION_ATTR_TIMEOUT , SAI_TWAMP_SESSION_ATTR_STATISTICS_INTERVAL , SAI_TWAMP_SESSION_ATTR_END , SAI_TWAMP_SESSION_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_TWAMP_SESSION_ATTR_CUSTOM_RANGE_END }
	SAI attributes for Two-Way Active Measurement Protocol session. More...

enum	_sai_twamp_session_stat_t { SAI_TWAMP_SESSION_STAT_RX_PACKETS , SAI_TWAMP_SESSION_STAT_RX_BYTE , SAI_TWAMP_SESSION_STAT_TX_PACKETS , SAI_TWAMP_SESSION_STAT_TX_BYTE , SAI_TWAMP_SESSION_STAT_DROP_PACKETS , SAI_TWAMP_SESSION_STAT_MAX_LATENCY , SAI_TWAMP_SESSION_STAT_MIN_LATENCY , SAI_TWAMP_SESSION_STAT_AVG_LATENCY , SAI_TWAMP_SESSION_STAT_MAX_JITTER , SAI_TWAMP_SESSION_STAT_MIN_JITTER , SAI_TWAMP_SESSION_STAT_AVG_JITTER , SAI_TWAMP_SESSION_STAT_FIRST_TS , SAI_TWAMP_SESSION_STAT_LAST_TS , SAI_TWAMP_SESSION_STAT_DURATION_TS }
	Two-Way Active Measurement Protocol Session counter IDs in sai_get_twamp_session_stats() call. More...

enum	_sai_twamp_session_state_t { SAI_TWAMP_SESSION_STATE_INACTIVE , SAI_TWAMP_SESSION_STATE_ACTIVE }
	SAI TWAMP session state. More...

Detailed Description

This module defines SAI Two-Way Active Measurement Protocol interface.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

THIS CODE IS PROVIDED ON AN AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY OR NON-INFRINGEMENT.

See the Apache Version 2.0 License for specific language governing permissions and limitations under the License.

Microsoft would like to thank the following companies for their review and assistance with these files: Intel Corporation, Mellanox Technologies Ltd, Dell Products, L.P., Facebook, Inc., Marvell International Ltd.

Definition in file saitwamp.h.

Classes

Typedefs

Enumerations

Detailed Description