SAI Metadata
Loading...
Searching...
No Matches
SAI - Extension specific API definitions

Classes

struct  _sai_vip_entry_t
 Entry for vip_entry. More...
 
struct  _sai_dash_vip_api_t
 

Typedefs

typedef enum _sai_vip_entry_action_t sai_vip_entry_action_t
 Attribute data for SAI_VIP_ENTRY_ATTR_ACTION.
 
typedef struct _sai_vip_entry_t sai_vip_entry_t
 Entry for vip_entry.
 
typedef enum _sai_vip_entry_attr_t sai_vip_entry_attr_t
 Attribute ID for dash_vip_vip_entry.
 
typedef sai_status_t(* sai_create_vip_entry_fn) (_In_ const sai_vip_entry_t *vip_entry, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
 Create dash_vip_vip_entry.
 
typedef sai_status_t(* sai_remove_vip_entry_fn) (_In_ const sai_vip_entry_t *vip_entry)
 Remove dash_vip_vip_entry.
 
typedef sai_status_t(* sai_set_vip_entry_attribute_fn) (_In_ const sai_vip_entry_t *vip_entry, _In_ const sai_attribute_t *attr)
 Set attribute for dash_vip_vip_entry.
 
typedef sai_status_t(* sai_get_vip_entry_attribute_fn) (_In_ const sai_vip_entry_t *vip_entry, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
 Get attribute for dash_vip_vip_entry.
 
typedef sai_status_t(* sai_bulk_create_vip_entry_fn) (_In_ uint32_t object_count, _In_ const sai_vip_entry_t *vip_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 dash_vip_vip_entry.
 
typedef sai_status_t(* sai_bulk_remove_vip_entry_fn) (_In_ uint32_t object_count, _In_ const sai_vip_entry_t *vip_entry, _In_ sai_bulk_op_error_mode_t mode, _Out_ sai_status_t *object_statuses)
 Bulk remove dash_vip_vip_entry.
 
typedef struct _sai_dash_vip_api_t sai_dash_vip_api_t
 

Enumerations

enum  _sai_vip_entry_action_t { SAI_VIP_ENTRY_ACTION_ACCEPT }
 Attribute data for SAI_VIP_ENTRY_ATTR_ACTION. More...
 
enum  _sai_vip_entry_attr_t {
  SAI_VIP_ENTRY_ATTR_START , SAI_VIP_ENTRY_ATTR_ACTION = SAI_VIP_ENTRY_ATTR_START , SAI_VIP_ENTRY_ATTR_IP_ADDR_FAMILY , SAI_VIP_ENTRY_ATTR_END ,
  SAI_VIP_ENTRY_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_VIP_ENTRY_ATTR_CUSTOM_RANGE_END
}
 Attribute ID for dash_vip_vip_entry. More...
 

Detailed Description

Typedef Documentation

◆ sai_bulk_create_vip_entry_fn

typedef sai_status_t(* sai_bulk_create_vip_entry_fn) (_In_ uint32_t object_count, _In_ const sai_vip_entry_t *vip_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 dash_vip_vip_entry.

Parameters
[in]object_countNumber of objects to create
[in]vip_entryList of object to create
[in]attr_countList of attr_count. Caller passes the number of attribute for each object to create.
[in]attr_listList of attributes for every object.
[in]modeBulk operation error handling mode.
[out]object_statusesList of status for every object. Caller needs to allocate the buffer
Returns
SAI_STATUS_SUCCESS on success when all objects are created or SAI_STATUS_FAILURE when any of the objects fails to create. When there is failure, Caller is expected to go through the list of returned statuses to find out which fails and which succeeds.

Definition at line 172 of file saiexperimentaldashvip.h.

◆ sai_bulk_remove_vip_entry_fn

typedef sai_status_t(* sai_bulk_remove_vip_entry_fn) (_In_ uint32_t object_count, _In_ const sai_vip_entry_t *vip_entry, _In_ sai_bulk_op_error_mode_t mode, _Out_ sai_status_t *object_statuses)

Bulk remove dash_vip_vip_entry.

Parameters
[in]object_countNumber of objects to remove
[in]vip_entryList of objects to remove
[in]modeBulk operation error handling mode.
[out]object_statusesList of status for every object. Caller needs to allocate the buffer
Returns
SAI_STATUS_SUCCESS on success when all objects are removed or SAI_STATUS_FAILURE when any of the objects fails to remove. When there is failure, Caller is expected to go through the list of returned statuses to find out which fails and which succeeds.

Definition at line 194 of file saiexperimentaldashvip.h.

◆ sai_create_vip_entry_fn

typedef sai_status_t(* sai_create_vip_entry_fn) (_In_ const sai_vip_entry_t *vip_entry, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)

Create dash_vip_vip_entry.

Parameters
[in]vip_entryEntry
[in]attr_countNumber of attributes
[in]attr_listArray of attributes
Returns
SAI_STATUS_SUCCESS on success Failure status code on error

Definition at line 114 of file saiexperimentaldashvip.h.

◆ sai_get_vip_entry_attribute_fn

typedef sai_status_t(* sai_get_vip_entry_attribute_fn) (_In_ const sai_vip_entry_t *vip_entry, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)

Get attribute for dash_vip_vip_entry.

Parameters
[in]vip_entryEntry
[in]attr_countNumber of attributes
[in,out]attr_listArray of attributes
Returns
SAI_STATUS_SUCCESS on success Failure status code on error

Definition at line 150 of file saiexperimentaldashvip.h.

◆ sai_remove_vip_entry_fn

typedef sai_status_t(* sai_remove_vip_entry_fn) (_In_ const sai_vip_entry_t *vip_entry)

Remove dash_vip_vip_entry.

Parameters
[in]vip_entryEntry
Returns
SAI_STATUS_SUCCESS on success Failure status code on error

Definition at line 126 of file saiexperimentaldashvip.h.

◆ sai_set_vip_entry_attribute_fn

typedef sai_status_t(* sai_set_vip_entry_attribute_fn) (_In_ const sai_vip_entry_t *vip_entry, _In_ const sai_attribute_t *attr)

Set attribute for dash_vip_vip_entry.

Parameters
[in]vip_entryEntry
[in]attrAttribute
Returns
SAI_STATUS_SUCCESS on success Failure status code on error

Definition at line 137 of file saiexperimentaldashvip.h.

Enumeration Type Documentation

◆ _sai_vip_entry_action_t

Attribute data for SAI_VIP_ENTRY_ATTR_ACTION.

Definition at line 39 of file saiexperimentaldashvip.h.

◆ _sai_vip_entry_attr_t

Attribute ID for dash_vip_vip_entry.

Enumerator
SAI_VIP_ENTRY_ATTR_START 

Start of attributes.

SAI_VIP_ENTRY_ATTR_ACTION 

Action.

Value Type:
sai_vip_entry_action_t
Flags:
CREATE_AND_SET
Default value:
SAI_VIP_ENTRY_ACTION_ACCEPT
SAI_VIP_ENTRY_ATTR_IP_ADDR_FAMILY 

IP address family for resource accounting.

Value Type:
sai_ip_addr_family_t
Flags:
READ_ONLY
IsResourceType:
true
SAI_VIP_ENTRY_ATTR_END 

End of attributes.

SAI_VIP_ENTRY_ATTR_CUSTOM_RANGE_START 

Custom range base value

SAI_VIP_ENTRY_ATTR_CUSTOM_RANGE_END 

End of custom range base

Definition at line 67 of file saiexperimentaldashvip.h.