saicounter.h File Reference

This module defines SAI Counter interface. More...

#include <saitypes.h>

Go to the source code of this file.

Classes
struct	_sai_counter_api_t
	Counter methods table retrieved with sai_api_query() More...

Typedefs
typedef enum _sai_counter_type_t	sai_counter_type_t
	Counter type.
typedef enum _sai_counter_attr_t	sai_counter_attr_t
	Attribute Id in sai_set_counter_attribute() and sai_get_counter_attribute() calls.
typedef sai_status_t(*	sai_create_counter_fn) (_Out_ sai_object_id_t *counter_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Create counter.
typedef sai_status_t(*	sai_remove_counter_fn) (_In_ sai_object_id_t counter_id)
	Remove counter.
typedef sai_status_t(*	sai_set_counter_attribute_fn) (_In_ sai_object_id_t counter_id, _In_ const sai_attribute_t *attr)
	Set counter attribute Value.
typedef sai_status_t(*	sai_get_counter_attribute_fn) (_In_ sai_object_id_t counter_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get counter attribute Value.
typedef enum _sai_counter_stat_t	sai_counter_stat_t
	Enum defining statistics for Counter.
typedef sai_status_t(*	sai_get_counter_stats_fn) (_In_ sai_object_id_t counter_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids, _Out_ uint64_t *counters)
	Get counter statistics counters. Deprecated for backward compatibility.
typedef sai_status_t(*	sai_get_counter_stats_ext_fn) (_In_ sai_object_id_t counter_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 counter statistics counters extended.
typedef sai_status_t(*	sai_clear_counter_stats_fn) (_In_ sai_object_id_t counter_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids)
	Clear counter statistics counters.
typedef struct _sai_counter_api_t	sai_counter_api_t
	Counter methods table retrieved with sai_api_query()

Enumerations
enum	_sai_counter_type_t { SAI_COUNTER_TYPE_REGULAR }
	Counter type. More...
enum	_sai_counter_attr_t {   SAI_COUNTER_ATTR_START , SAI_COUNTER_ATTR_TYPE = SAI_COUNTER_ATTR_START , SAI_COUNTER_ATTR_LABEL , SAI_COUNTER_ATTR_END ,   SAI_COUNTER_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_COUNTER_ATTR_CUSTOM_RANGE_END }
	Attribute Id in sai_set_counter_attribute() and sai_get_counter_attribute() calls. More...
enum	_sai_counter_stat_t { SAI_COUNTER_STAT_PACKETS = 0x00000000 , SAI_COUNTER_STAT_BYTES = 0x00000001 , SAI_COUNTER_STAT_CUSTOM_RANGE_BASE = 0x10000000 }
	Enum defining statistics for Counter. More...

Detailed Description

This module defines SAI Counter interface.

Copyright (c) 2014 Microsoft Open Technologies, Inc.

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.

Abstract

This module defines SAI Counter API.

Definition in file saicounter.h.