saimetadatautils.h File Reference

This module defines SAI Metadata Utilities. More...

#include "saimetadatatypes.h"

Go to the source code of this file.

Functions
bool	sai_metadata_is_allowed_object_type (_In_ const sai_attr_metadata_t *metadata, _In_ sai_object_type_t object_type)
	Is allowed object type.
bool	sai_metadata_is_allowed_enum_value (_In_ const sai_attr_metadata_t *metadata, _In_ int value)
	Is allowed enum value.
const sai_attr_metadata_t *	sai_metadata_get_attr_metadata (_In_ sai_object_type_t object_type, _In_ sai_attr_id_t attr_id)
	Gets attribute metadata based on object type and attribute id.
const sai_attr_metadata_t *	sai_metadata_get_attr_metadata_by_attr_id_name (_In_ const char *attr_id_name)
	Gets attribute metadata based on attribute id name.
const sai_attr_metadata_t *	sai_metadata_get_attr_metadata_by_attr_id_name_ext (_In_ const char *attr_id_name)
	Gets attribute metadata based on attribute id name, supporting case of attribute id name is in deserialized buffer and terminated by characters listed in function sai_serialize_is_char_allowed.
const sai_attr_metadata_t *	sai_metadata_get_ignored_attr_metadata_by_attr_id_name (_In_ const char *attr_id_name)
	Gets ignored attribute metadata based on attribute id name.
const char *	sai_metadata_get_enum_value_name (_In_ const sai_enum_metadata_t *metadata, _In_ int value)
	Gets string representation of enum value.
const sai_attribute_t *	sai_metadata_get_attr_by_id (_In_ sai_attr_id_t id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Gets attribute from attribute list by attribute id.
const sai_object_type_info_t *	sai_metadata_get_object_type_info (_In_ sai_object_type_t object_type)
	Gets object type info.
bool	sai_metadata_is_object_type_valid (_In_ sai_object_type_t object_type)
	Checks if object type is valid.
bool	sai_metadata_is_object_type_oid (_In_ sai_object_type_t object_type)
	Checks whether object type is OID object type.
bool	sai_metadata_is_condition_met (_In_ const sai_attr_metadata_t *metadata, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Check if condition met.
bool	sai_metadata_is_validonly_met (_In_ const sai_attr_metadata_t *metadata, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Check if valid only condition is met.
sai_api_version_t	sai_metadata_query_api_version (void)
	Metadata query API version.

Detailed Description

This module defines SAI Metadata Utilities.

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.

Definition in file saimetadatautils.h.