SAI Metadata
Loading...
Searching...
No Matches
saineighbor.h File Reference

This module defines SAI Neighbor interface. More...

#include <saitypes.h>

Go to the source code of this file.

Classes

struct  _sai_neighbor_entry_t
 Neighbor entry. More...
 
struct  _sai_neighbor_api_t
 Neighbor table methods, retrieved via sai_api_query() More...
 

Typedefs

typedef enum _sai_neighbor_entry_attr_t sai_neighbor_entry_attr_t
 Attribute Id for SAI neighbor object.
 
typedef struct _sai_neighbor_entry_t sai_neighbor_entry_t
 Neighbor entry.
 
typedef sai_status_t(* sai_create_neighbor_entry_fn) (_In_ const sai_neighbor_entry_t *neighbor_entry, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
 Create neighbor entry.
 
typedef sai_status_t(* sai_remove_neighbor_entry_fn) (_In_ const sai_neighbor_entry_t *neighbor_entry)
 Remove neighbor entry.
 
typedef sai_status_t(* sai_set_neighbor_entry_attribute_fn) (_In_ const sai_neighbor_entry_t *neighbor_entry, _In_ const sai_attribute_t *attr)
 Set neighbor attribute value.
 
typedef sai_status_t(* sai_get_neighbor_entry_attribute_fn) (_In_ const sai_neighbor_entry_t *neighbor_entry, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
 Get neighbor attribute value.
 
typedef sai_status_t(* sai_remove_all_neighbor_entries_fn) (_In_ sai_object_id_t switch_id)
 Remove all neighbor entries.
 
typedef sai_status_t(* sai_bulk_create_neighbor_entry_fn) (_In_ uint32_t object_count, _In_ const sai_neighbor_entry_t *neighbor_entry, _In_ const uint32_t *attr_count, _In_ const sai_attribute_t **attr_list, _In_ sai_bulk_op_error_mode_t mode, _Out_ sai_status_t *object_statuses)
 Bulk create Neighbor entry.
 
typedef sai_status_t(* sai_bulk_remove_neighbor_entry_fn) (_In_ uint32_t object_count, _In_ const sai_neighbor_entry_t *neighbor_entry, _In_ sai_bulk_op_error_mode_t mode, _Out_ sai_status_t *object_statuses)
 Bulk remove Neighbor entry.
 
typedef sai_status_t(* sai_bulk_set_neighbor_entry_attribute_fn) (_In_ uint32_t object_count, _In_ const sai_neighbor_entry_t *neighbor_entry, _In_ const sai_attribute_t *attr_list, _In_ sai_bulk_op_error_mode_t mode, _Out_ sai_status_t *object_statuses)
 Bulk set attribute on Neighbor entry.
 
typedef sai_status_t(* sai_bulk_get_neighbor_entry_attribute_fn) (_In_ uint32_t object_count, _In_ const sai_neighbor_entry_t *neighbor_entry, _In_ const uint32_t *attr_count, _Inout_ sai_attribute_t **attr_list, _In_ sai_bulk_op_error_mode_t mode, _Out_ sai_status_t *object_statuses)
 Bulk get attribute on Neighbor entry.
 
typedef struct _sai_neighbor_api_t sai_neighbor_api_t
 Neighbor table methods, retrieved via sai_api_query()
 

Enumerations

enum  _sai_neighbor_entry_attr_t {
  SAI_NEIGHBOR_ENTRY_ATTR_START , SAI_NEIGHBOR_ENTRY_ATTR_DST_MAC_ADDRESS = SAI_NEIGHBOR_ENTRY_ATTR_START , SAI_NEIGHBOR_ENTRY_ATTR_PACKET_ACTION , SAI_NEIGHBOR_ENTRY_ATTR_USER_TRAP_ID ,
  SAI_NEIGHBOR_ENTRY_ATTR_NO_HOST_ROUTE , SAI_NEIGHBOR_ENTRY_ATTR_META_DATA , SAI_NEIGHBOR_ENTRY_ATTR_COUNTER_ID , SAI_NEIGHBOR_ENTRY_ATTR_ENCAP_INDEX ,
  SAI_NEIGHBOR_ENTRY_ATTR_ENCAP_IMPOSE_INDEX , SAI_NEIGHBOR_ENTRY_ATTR_IS_LOCAL , SAI_NEIGHBOR_ENTRY_ATTR_IP_ADDR_FAMILY , SAI_NEIGHBOR_ENTRY_ATTR_END ,
  SAI_NEIGHBOR_ENTRY_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_NEIGHBOR_ENTRY_ATTR_CUSTOM_RANGE_END
}
 Attribute Id for SAI neighbor object. More...
 

Detailed Description

This module defines SAI Neighbor 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 neighbor table API The table contains both IPv4 and IPv6 neighbors

Definition in file saineighbor.h.