openapi_mvr.h File Reference

#include "openapi_common.h"

Go to the source code of this file.

Macros
#define	OPEN_MVR_MULT_IP_ADDR_MAX   0xefffffff
#define	OPEN_MVR_MULT_IP_ADDR_MIN   0xe0000100
#define	OPEN_MVR_QUERY_TIME_MAX   100
#define	OPEN_MVR_QUERY_TIME_MIN   1

Enumerations
enum	OPEN_MVR_ENTRY_TYPE_t { OPEN_MVR_NONE_TYPE = 0, OPEN_MVR_STATIC_TYPE, OPEN_MVR_DYNAMIC_TYPE }
enum	OPEN_MVR_INTF_TYPE_t { OPEN_MVR_NONE_PORT_TYPE = 0, OPEN_MVR_SOURCE_PORT_TYPE, OPEN_MVR_RECEIVER_PORT_TYPE, OPEN_MVR_LAST_TYPE }
enum	OPEN_MVR_MODE_TYPE_t { OPEN_MVR_NONE_MODE = 0, OPEN_MVR_COMPATIBLE_MODE, OPEN_MVR_DYNAMIC_MODE }
enum	OPEN_MVR_PDU_COUNTER_t {   OPEN_MVR_PKT_IGMP_QUERY_RX_COUNTER = 0, OPEN_MVR_PKT_IGMP_REPORT_V1_RX_COUNTER, OPEN_MVR_PKT_IGMP_REPORT_V2_RX_COUNTER, OPEN_MVR_PKT_IGMP_LEAVE_RX_COUNTER,   OPEN_MVR_PKT_IGMP_QUERY_TX_COUNTER, OPEN_MVR_PKT_IGMP_REPORT_V1_TX_COUNTER, OPEN_MVR_PKT_IGMP_REPORT_V2_TX_COUNTER, OPEN_MVR_PKT_IGMP_LEAVE_TX_COUNTER,   OPEN_MVR_PKT_RX_FAILURE_COUNTER, OPEN_MVR_PKT_TX_FAILURE_COUNTER, OPEN_MVR_PKT_COUNTER_LAST }

Functions
open_error_t	openapiMvrAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
	Gets the MVR admin mode. More...
open_error_t	openapiMvrAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
	Sets the MVR admin mode. More...
open_error_t	openapiMvrEntryGetNext (openapiClientHandle_t *client_handle, uint32_t groupIp, uint32_t *nextGroupIp)
	Get next group IP address. More...
open_error_t	openapiMvrGroupEntryGetNext (openapiClientHandle_t *client_handle, uint32_t groupId, uint32_t *nextGroupId)
	Get next group ID. More...
open_error_t	openapiMvrGroupIdGet (openapiClientHandle_t *client_handle, uint32_t groupIp, uint32_t *groupId)
	Get the group ID of the given IP address. More...
open_error_t	openapiMvrGroupIpAdd (openapiClientHandle_t *client_handle, uint32_t groupIp)
	Add static group IP address. More...
open_error_t	openapiMvrGroupIpDelete (openapiClientHandle_t *client_handle, uint32_t groupIp)
	Delete static group IP address. More...
open_error_t	openapiMvrGroupIpGet (openapiClientHandle_t *client_handle, uint32_t groupId, uint32_t *groupIp)
	Get the ip address of the group with specified ID. More...
open_error_t	openapiMvrGroupNumGet (openapiClientHandle_t *client_handle, uint32_t *groupEntries)
	Get the number of the group entries. More...
open_error_t	openapiMvrGroupStatusGet (openapiClientHandle_t *client_handle, uint32_t groupId, OPEN_BOOL_t *status)
	Get the group status whether active or not. More...
open_error_t	openapiMvrIntfEntryTypeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t groupId, OPEN_MVR_ENTRY_TYPE_t *type)
	Get the interface type static or dynamic. More...
open_error_t	openapiMvrIntfGetNext (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *nextIfNum)
	Get next MVR interface. More...
open_error_t	openapiMvrIntfGroupGetNext (openapiClientHandle_t *client_handle, uint32_t groupId, uint32_t ifNum, uint32_t *nextIfNum)
	Get next interface from the group with specified ID. More...
open_error_t	openapiMvrIntfGroupIdGetNext (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t groupId, uint32_t *nextGroupId)
	Get next group registered on specified interface. More...
open_error_t	openapiMvrIntfGroupIpAdd (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t groupIp)
	Add specified interface to the group. More...
open_error_t	openapiMvrIntfGroupIpDelete (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t groupIp)
	Delete specified interface from the group. More...
open_error_t	openapiMvrIntfImmediateModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *immediateMode)
	Gets the immediate leave mode of a specified interface. More...
open_error_t	openapiMvrIntfImmediateModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t immediateMode)
	Sets the immediate leave mode of a specified interface. More...
open_error_t	openapiMvrIntfModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *intfMode)
	Gets the MVR interface mode. More...
open_error_t	openapiMvrIntfModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t intfMode)
	Sets the MVR interface mode. More...
open_error_t	openapiMvrIntfMvrTypeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_MVR_INTF_TYPE_t *intfMvrType)
	Gets the interface MVR type of a specified interface. More...
open_error_t	openapiMvrIntfMvrTypeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_MVR_INTF_TYPE_t intfMvrType)
	Sets the interface MVR type of a specified interface. More...
open_error_t	openapiMvrIntfStaticGroupIpGetNext (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t groupIp, uint32_t *nextGroupIp)
	Get next group IP statically registered on specified interface. More...
open_error_t	openapiMvrIsReceiversInVlan (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_BOOL_t *rxVlanParticipationStatus)
	Check if receivers participate in specific vlan. More...
open_error_t	openapiMvrModeTypeGet (openapiClientHandle_t *client_handle, OPEN_MVR_MODE_TYPE_t *modeType)
	Gets the MVR mode type. More...
open_error_t	openapiMvrModeTypeSet (openapiClientHandle_t *client_handle, OPEN_MVR_MODE_TYPE_t modeType)
	Sets the MVR mode type. More...
open_error_t	openapiMvrMulticastVlanGet (openapiClientHandle_t *client_handle, uint32_t *multicastVlan)
	Gets the MVR multicast vlan. More...
open_error_t	openapiMvrMulticastVlanSet (openapiClientHandle_t *client_handle, uint32_t multicastVlan)
	Sets the MVR multicast vlan. More...
open_error_t	openapiMvrPduCounterGet (openapiClientHandle_t *client_handle, OPEN_MVR_PDU_COUNTER_t counterType, uint32_t *counterValue)
	Get the global pdu counter values. More...
open_error_t	openapiMvrQueryTimeGet (openapiClientHandle_t *client_handle, uint32_t *queryTime)
	Gets the MVR query time. More...
open_error_t	openapiMvrQueryTimeSet (openapiClientHandle_t *client_handle, uint32_t queryTime)
	Sets the MVR query time. More...