|
Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.11.1.2
|
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 |
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... | |
| open_error_t openapiMvrAdminModeGet | ( | openapiClientHandle_t * | client_handle, |
| OPEN_CONTROL_t * | adminMode | ||
| ) |
Gets the MVR admin mode.
| [in] | client_handle | client handle from registration API |
| [out] | adminMode | MVR admin mode |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrAdminModeSet | ( | openapiClientHandle_t * | client_handle, |
| OPEN_CONTROL_t | adminMode | ||
| ) |
Sets the MVR admin mode.
| [in] | client_handle | client handle from registration API |
| [in] | adminMode | MVR admin mode |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrEntryGetNext | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | groupIp, | ||
| uint32_t * | nextGroupIp | ||
| ) |
Get next group IP address.
| [in] | client_handle | client handle from registration API |
| [in] | groupIp | Group IP |
| [out] | nextGroupIp | Next group IP |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrGroupEntryGetNext | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | groupId, | ||
| uint32_t * | nextGroupId | ||
| ) |
Get next group ID.
| [in] | client_handle | client handle from registration API |
| [in] | groupId | Group ID |
| [out] | nextGroupId | Next group Id |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrGroupIdGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | groupIp, | ||
| uint32_t * | groupId | ||
| ) |
Get the group ID of the given IP address.
| [in] | client_handle | client handle from registration API |
| [in] | groupIp | Group IP address |
| [out] | groupId | Group ID |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrGroupIpAdd | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | groupIp | ||
| ) |
Add static group IP address.
| [in] | client_handle | client handle from registration API |
| [in] | groupIp | Group IP address |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrGroupIpDelete | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | groupIp | ||
| ) |
Delete static group IP address.
| [in] | client_handle | client handle from registration API |
| [in] | groupIp | Group IP address |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrGroupIpGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | groupId, | ||
| uint32_t * | groupIp | ||
| ) |
Get the ip address of the group with specified ID.
| [in] | client_handle | client handle from registration API |
| [in] | groupId | Group Id |
| [out] | groupIp | Group IP address |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrGroupNumGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t * | groupEntries | ||
| ) |
Get the number of the group entries.
| [in] | client_handle | client handle from registration API |
| [out] | groupEntries | Number of the group entries |
| OPEN_E_NONE | On success. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrGroupStatusGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | groupId, | ||
| OPEN_BOOL_t * | status | ||
| ) |
Get the group status whether active or not.
| [in] | client_handle | client handle from registration API |
| [in] | groupId | Group ID |
| [out] | status | Group status |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| 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.
| [in] | client_handle | client handle from registration API |
| [in] | ifNum | interface |
| [in] | groupId | Group Id |
| [out] | intfType | Entry type |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrIntfGetNext | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | ifNum, | ||
| uint32_t * | nextIfNum | ||
| ) |
Get next MVR interface.
| [in] | client_handle | client handle from registration API |
| [in] | ifNum | interface |
| [out] | nextIfNum | Next MVR interface |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| 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.
| [in] | client_handle | client handle from registration API |
| [in] | groupId | Group Id |
| [in] | ifNum | interface |
| [out] | nextIfNum | Next MVR interface |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrIntfGroupIdGetNext | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | ifNum, | ||
| uint32_t | groupId, | ||
| uint32_t * | nextGroupId | ||
| ) |
Get next group registered on specified interface.
| [in] | client_handle | client handle from registration API |
| [in] | ifNum | interface |
| [in] | groupId | Group Id |
| [out] | nextGroupId | Next registered group ID on the interface |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrIntfGroupIpAdd | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | ifNum, | ||
| uint32_t | groupIp | ||
| ) |
Add specified interface to the group.
| [in] | client_handle | client handle from registration API |
| [in] | ifNum | interface |
| [in] | groupIp | Group IP address |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrIntfGroupIpDelete | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | ifNum, | ||
| uint32_t | groupIp | ||
| ) |
Delete specified interface from the group.
| [in] | client_handle | client handle from registration API |
| [in] | ifNum | interface |
| [in] | groupIp | Group IP address |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrIntfImmediateModeGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | ifNum, | ||
| OPEN_CONTROL_t * | immediateMode | ||
| ) |
Gets the immediate leave mode of a specified interface.
| [in] | client_handle | client handle from registration API |
| [in] | ifNum | interface |
| [out] | immediateMode | Immediate leave mode |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrIntfImmediateModeSet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | ifNum, | ||
| OPEN_CONTROL_t | immediateMode | ||
| ) |
Sets the immediate leave mode of a specified interface.
| [in] | client_handle | client handle from registration API |
| [in] | ifNum | interface |
| [in] | immediateMode | Immediate leave mode |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrIntfModeGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | ifNum, | ||
| OPEN_CONTROL_t * | intfMode | ||
| ) |
Gets the MVR interface mode.
| [in] | client_handle | client handle from registration API |
| [in] | ifNum | interface |
| [out] | intfMode | MVR interface mode |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrIntfModeSet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | ifNum, | ||
| OPEN_CONTROL_t | intfMode | ||
| ) |
Sets the MVR interface mode.
| [in] | client_handle | client handle from registration API |
| [in] | ifNum | interface |
| [in] | intfMode | MVR interface mode |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| 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.
| [in] | client_handle | client handle from registration API |
| [in] | ifNum | interface |
| [out] | intfMvrType | Interface MVR type |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| 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.
| [in] | client_handle | client handle from registration API |
| [in] | ifNum | interface |
| [in] | intfMvrType | Interface MVR type |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| 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.
| [in] | client_handle | client handle from registration API |
| [in] | ifNum | interface |
| [in] | groupIp | Group IP |
| [out] | nextGroupIp | Next statically registered group IP on the interface |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrIsReceiversInVlan | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | vlanId, | ||
| OPEN_BOOL_t * | rxVlanParticipationStatus | ||
| ) |
Check if receivers participate in specific vlan.
| [in] | client_handle | client handle from registration API |
| [in] | vlanId | MVR multicast vlan |
| [out] | rxVlanParticipationStatus | Receiver's vlan participation status |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrModeTypeGet | ( | openapiClientHandle_t * | client_handle, |
| OPEN_MVR_MODE_TYPE_t * | modeType | ||
| ) |
Gets the MVR mode type.
| [in] | client_handle | client handle from registration API |
| [out] | modeType | MVR mode type |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrModeTypeSet | ( | openapiClientHandle_t * | client_handle, |
| OPEN_MVR_MODE_TYPE_t | modeType | ||
| ) |
Sets the MVR mode type.
| [in] | client_handle | client handle from registration API |
| [in] | modeType | MVR mode type |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrMulticastVlanGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t * | multicastVlan | ||
| ) |
Gets the MVR multicast vlan.
| [in] | client_handle | client handle from registration API |
| [out] | multicastVlan | MVR multicast vlan |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrMulticastVlanSet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | multicastVlan | ||
| ) |
Sets the MVR multicast vlan.
| [in] | client_handle | client handle from registration API |
| [in] | multicastVlan | MVR multicast vlan |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrPduCounterGet | ( | openapiClientHandle_t * | client_handle, |
| OPEN_MVR_PDU_COUNTER_t | counterType, | ||
| uint32_t * | counterValue | ||
| ) |
Get the global pdu counter values.
| [in] | client_handle | client handle from registration API |
| [in] | counterType | Type of the counter |
| [out] | counterValue | Counter value |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrQueryTimeGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t * | queryTime | ||
| ) |
Gets the MVR query time.
| [in] | client_handle | client handle from registration API |
| [out] | queryTime | MVR query time |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25
| open_error_t openapiMvrQueryTimeSet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | queryTime | ||
| ) |
Sets the MVR query time.
| [in] | client_handle | client handle from registration API |
| [in] | queryTime | MVR query time |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | Feature not available |
OpEN API Version: 1.25