SAI - Multicast FDB specific API definitions

Classes
struct	_sai_mcast_fdb_entry_t
	MCAST FDB entry key. More...
struct	_sai_mcast_fdb_api_t
	Multicast FDB method table retrieved with sai_api_query() More...

Typedefs
typedef struct _sai_mcast_fdb_entry_t	sai_mcast_fdb_entry_t
	MCAST FDB entry key.
typedef enum _sai_mcast_fdb_entry_attr_t	sai_mcast_fdb_entry_attr_t
	Attribute Id for multicast FDB entry.
typedef sai_status_t(*	sai_create_mcast_fdb_entry_fn) (_In_ const sai_mcast_fdb_entry_t *mcast_fdb_entry, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Create Multicast FDB entry.
typedef sai_status_t(*	sai_remove_mcast_fdb_entry_fn) (_In_ const sai_mcast_fdb_entry_t *mcast_fdb_entry)
	Remove Multicast FDB entry.
typedef sai_status_t(*	sai_set_mcast_fdb_entry_attribute_fn) (_In_ const sai_mcast_fdb_entry_t *mcast_fdb_entry, _In_ const sai_attribute_t *attr)
	Set multicast FDB entry attribute value.
typedef sai_status_t(*	sai_get_mcast_fdb_entry_attribute_fn) (_In_ const sai_mcast_fdb_entry_t *mcast_fdb_entry, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get FDB entry attribute value.
typedef struct _sai_mcast_fdb_api_t	sai_mcast_fdb_api_t
	Multicast FDB method table retrieved with sai_api_query()

Enumerations
enum	_sai_mcast_fdb_entry_attr_t {   SAI_MCAST_FDB_ENTRY_ATTR_START , SAI_MCAST_FDB_ENTRY_ATTR_GROUP_ID = SAI_MCAST_FDB_ENTRY_ATTR_START , SAI_MCAST_FDB_ENTRY_ATTR_PACKET_ACTION , SAI_MCAST_FDB_ENTRY_ATTR_META_DATA ,   SAI_MCAST_FDB_ENTRY_ATTR_END , SAI_MCAST_FDB_ENTRY_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_MCAST_FDB_ENTRY_ATTR_CUSTOM_RANGE_END }
	Attribute Id for multicast FDB entry. More...

Detailed Description

Typedef Documentation

sai_create_mcast_fdb_entry_fn

typedef sai_status_t(* sai_create_mcast_fdb_entry_fn) (_In_ const sai_mcast_fdb_entry_t *mcast_fdb_entry, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)

Create Multicast FDB entry.

Parameters

[in]	mcast_fdb_entry	FDB entry
[in]	attr_count	Number of attributes
[in]	attr_list	Array of attributes

Returns

SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 123 of file saimcastfdb.h.

sai_get_mcast_fdb_entry_attribute_fn

typedef sai_status_t(* sai_get_mcast_fdb_entry_attribute_fn) (_In_ const sai_mcast_fdb_entry_t *mcast_fdb_entry, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)

Get FDB entry attribute value.

Parameters

[in]	mcast_fdb_entry	FDB entry
[in]	attr_count	Number of attributes
[in,out]	attr_list	Array of attributes

Returns

SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 159 of file saimcastfdb.h.

sai_remove_mcast_fdb_entry_fn

typedef sai_status_t(* sai_remove_mcast_fdb_entry_fn) (_In_ const sai_mcast_fdb_entry_t *mcast_fdb_entry)

Remove Multicast FDB entry.

Parameters

[in]

mcast_fdb_entry

FDB entry

Returns

SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 135 of file saimcastfdb.h.

sai_set_mcast_fdb_entry_attribute_fn

typedef sai_status_t(* sai_set_mcast_fdb_entry_attribute_fn) (_In_ const sai_mcast_fdb_entry_t *mcast_fdb_entry, _In_ const sai_attribute_t *attr)

Set multicast FDB entry attribute value.

Parameters

[in]	mcast_fdb_entry	FDB entry
[in]	attr	Attribute

Returns

SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 146 of file saimcastfdb.h.

Enumeration Type Documentation

_sai_mcast_fdb_entry_attr_t

enum _sai_mcast_fdb_entry_attr_t

Attribute Id for multicast FDB entry.

Enumerator
SAI_MCAST_FDB_ENTRY_ATTR_START	Start of attributes.
SAI_MCAST_FDB_ENTRY_ATTR_GROUP_ID	Multicast FDB entry group id. The group id refers to a L2MC group object. In case of empty group, packets will be discarded. Value Type: sai_object_id_t Flags: MANDATORY_ON_CREATE | CREATE_AND_SET Allowed object types SAI_OBJECT_TYPE_L2MC_GROUP
SAI_MCAST_FDB_ENTRY_ATTR_PACKET_ACTION	Multicast FDB entry packet action. Value Type: sai_packet_action_t Flags: MANDATORY_ON_CREATE | CREATE_AND_SET
SAI_MCAST_FDB_ENTRY_ATTR_META_DATA	User based Meta Data. Value Range SAI_SWITCH_ATTR_FDB_DST_USER_META_DATA_RANGE Value Type: sai_uint32_t Flags: CREATE_AND_SET Default value: 0
SAI_MCAST_FDB_ENTRY_ATTR_END	End of attributes.
SAI_MCAST_FDB_ENTRY_ATTR_CUSTOM_RANGE_START	Start of custom range base value
SAI_MCAST_FDB_ENTRY_ATTR_CUSTOM_RANGE_END	End of custom range

Definition at line 63 of file saimcastfdb.h.