Data Structures
struct	OPEN_MSRP_RESERVATION_INFO_t

struct	OPEN_MSRP_STEAM_INFO_t

Macros
#define	OPEN_MSRP_INTF_MAX_COUNT 1024
	< Maximum number of MSRP interfaces in the system.

Enumerations
enum	OPEN_MSRP_DECLARATION_t { OPEN_MSRP_DECTYPE_INVALID = 0, OPEN_MSRP_DECTYPE_ADVERTISE, OPEN_MSRP_DECTYPE_FAILED, OPEN_MSRP_DECTYPE_ASKING_FAILED, OPEN_MSRP_DECTYPE_READY, OPEN_MSRP_DECTYPE_READY_FAILED, OPEN_MSRP_DECTYPE_DOMAIN }

enum	OPEN_MSRP_QAV_STREAMCLASS_t { OPEN_MSRP_QAV_STREAM_CLASS_A = 0, OPEN_MSRP_QAV_STREAM_CLASS_B }

enum	OPEN_MSRP_STATS_t { OPEN_MSRP_STATS_RX = 0, OPEN_MSRP_STATS_RX_BAD_HEADER, OPEN_MSRP_STATS_RX_BAD_FORMAT, OPEN_MSRP_STATS_TX, OPEN_MSRP_STATS_TX_FAILURE, OPEN_MSRP_STATS_MSG }

Functions
open_error_t	openapiMsrpBoundaryPropagateModeGet (openapiClientHandle_t client_handle, OPEN_CONTROL_t adminMode)
	Get the MSRP boundary propagate mode.

open_error_t	openapiMsrpBoundaryPropagateModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Set the MSRP boundary propagate mode.

open_error_t	openapiMsrpFailedRegistrationCounterGet (openapiClientHandle_t client_handle, uint32_t intIfNum, uint32_t counter)
	Get Failed Registration Counter.

open_error_t	openapiMsrpIntfModeGet (openapiClientHandle_t client_handle, uint32_t intIfNum, OPEN_CONTROL_t adminMode)
	Get the MSRP mode for the specified interface.

open_error_t	openapiMsrpIntfModeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t mode)
	Set the MSRP mode for the given interface.

open_error_t	openapiMsrpIntfTrafficPduCounterGet (openapiClientHandle_t client_handle, uint32_t intIfNum, OPEN_MSRP_STATS_t type, uint32_t counter)
	Get the value of specified MSRP counter for an interface.

open_error_t	openapiMsrpIsBoundaryPortGet (openapiClientHandle_t client_handle, uint32_t intIfNum, OPEN_MSRP_QAV_STREAMCLASS_t trClass, OPEN_BOOL_t isBoundary)
	Check if a port is boundary port.

open_error_t	openapiMsrpMaxFanInPortsGet (openapiClientHandle_t client_handle, uint32_t maxFanInPorts)
	Get the maximum number of the ports, where MSRP registrations are allowed.

open_error_t	openapiMsrpMaxFanInPortsSet (openapiClientHandle_t *client_handle, uint32_t maxFanInPorts)
	Set the maximum number of the ports, where MSRP registrations are allowed.

open_error_t	openapiMsrpModeGet (openapiClientHandle_t client_handle, OPEN_CONTROL_t adminMode)
	Get the global MSRP mode.

open_error_t	openapiMsrpModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	set the global MSRP mode.

open_error_t	openapiMsrpQavCurrentBandwidthGet (openapiClientHandle_t client_handle, uint32_t intIfNum, uint64_t trClassA, uint64_t trClassB, uint64_t total)
	Get the current used bandwidth values for the interface.

open_error_t	openapiMsrpQavDeltaBandwidthGet (openapiClientHandle_t client_handle, uint32_t intIfNum, uint32_t deltaClassA, uint32_t *deltaClassB)
	Get the delta bandwidth values for the interface.

open_error_t	openapiMsrpQavDeltaBandwidthSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_MSRP_QAV_STREAMCLASS_t trafficClass, uint32_t deltaBandwidth)
	Get the delta bandwidth values for the interface.

open_error_t	openapiMsrpQavMaxRateGet (openapiClientHandle_t client_handle, uint32_t intIfNum, uint64_t trClassA, uint64_t trClassB, uint64_t total)
	Get the max free bandwidth values for the interface.

open_error_t	openapiMsrpReservationInformationGet (openapiClientHandle_t client_handle, uint32_t streamId, uint32_t intIfNum, open_buffdesc reservationInfo)
	Get the MSRP Reservation Information.

open_error_t	openapiMsrpSRclassPVIDGet (openapiClientHandle_t client_handle, uint32_t intIfNum, uint32_t pvid)
	Get the MSRP SR class PVID value on the interface.

open_error_t	openapiMsrpSRclassPVIDSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t pvid)
	Set the MSRP SR class PVID value on the interface.

open_error_t	openapiMsrpSrQavPriorityGet (openapiClientHandle_t client_handle, uint32_t intIfNum, OPEN_MSRP_QAV_STREAMCLASS_t trClass, uint32_t priority)
	Get the 802.1Qav priority.

open_error_t	openapiMsrpSrQavPrioritySet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_MSRP_QAV_STREAMCLASS_t trClass, uint32_t priority)
	Set the 802.1Qav priority.

open_error_t	openapiMsrpSrQavRePriorityGet (openapiClientHandle_t client_handle, uint32_t intIfNum, OPEN_MSRP_QAV_STREAMCLASS_t trClass, uint32_t remap)
	Get the 802.1Qav remapped priority.

open_error_t	openapiMsrpSrQavRePrioritySet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_MSRP_QAV_STREAMCLASS_t trClass, uint32_t remap)
	Set the 802.1Qav remapped priority.

open_error_t	openapiMsrpStreamIndexedNextGet (openapiClientHandle_t client_handle, uint16_t currentIndex, uint16_t nextIndex)
	Given the next stream index to the given index.

open_error_t	openapiMsrpStreamInformationGet (openapiClientHandle_t client_handle, uint32_t streamId, open_buffdesc streamInfo)
	Get the MSRP Stream Information.

open_error_t	openapiMsrpTalkerPruningModeGet (openapiClientHandle_t client_handle, OPEN_CONTROL_t adminMode)
	Get the MSRP talker pruning mode.

open_error_t	openapiMsrpTalkerPruningModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Set the MSRP talker pruning mode.

open_error_t	openapiMsrpTrafficCountersClear (openapiClientHandle_t *client_handle)
	Clear all MSRP traffic counters.

open_error_t	openapiMsrpTrafficCountersPerIfClear (openapiClientHandle_t *client_handle, uint32_t intIfNum)
	Clear MSRP traffic counters on specified interface.

open_error_t	openapiMsrpTrafficPduCounterGet (openapiClientHandle_t client_handle, OPEN_MSRP_STATS_t type, uint32_t counter)
	Get the value of specified MSRP counter.

Detailed Description

Macro Definition Documentation

#define OPEN_MSRP_INTF_MAX_COUNT 1024

< Maximum number of MSRP interfaces in the system.

< call openapiMaxInterfaceCountGet() to get the number of interfaces in the system AVB standard defines 2 SR classes

Definition at line 45 of file openapi_msrp.h.

Enumeration Type Documentation

enum OPEN_MSRP_DECLARATION_t

Enumerator:

OPEN_MSRP_DECTYPE_INVALID	Uninitialized.
OPEN_MSRP_DECTYPE_ADVERTISE	Advertise.
OPEN_MSRP_DECTYPE_FAILED	Failed.
OPEN_MSRP_DECTYPE_ASKING_FAILED	Asking failed.
OPEN_MSRP_DECTYPE_READY	Ready.
OPEN_MSRP_DECTYPE_READY_FAILED	Ready failed.
OPEN_MSRP_DECTYPE_DOMAIN	Domain attributes.

Definition at line 89 of file openapi_msrp.h.

enum OPEN_MSRP_QAV_STREAMCLASS_t

Enumerator:

OPEN_MSRP_QAV_STREAM_CLASS_A	Class A.
OPEN_MSRP_QAV_STREAM_CLASS_B	Class B.

Definition at line 48 of file openapi_msrp.h.

enum OPEN_MSRP_STATS_t

Enumerator:

OPEN_MSRP_STATS_RX	Flag for all received msrp PDUs.
OPEN_MSRP_STATS_RX_BAD_HEADER	Flag for received msrp PDUs with bad header.
OPEN_MSRP_STATS_RX_BAD_FORMAT	Flag for received msrp PDUs with bad data field.
OPEN_MSRP_STATS_TX	Flag for all transmitted msrp PDUs.
OPEN_MSRP_STATS_TX_FAILURE	Flag for msrp PDUs which failed.
OPEN_MSRP_STATS_MSG	Flag for message queue send failed.

Definition at line 100 of file openapi_msrp.h.

Function Documentation

open_error_t openapiMsrpBoundaryPropagateModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	adminMode
	)

Get the MSRP boundary propagate mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	mode	Boundary propagate mode.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpBoundaryPropagateModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Set the MSRP boundary propagate mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Boundary propagate mode.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpFailedRegistrationCounterGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	counter
	)

Get Failed Registration Counter.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.
[out]	counter	Counter value.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpIntfModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t *	adminMode
	)

Get the MSRP mode for the specified interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.
[out]	mode	Interface MSRP admin mode.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpIntfModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t	mode
	)

Set the MSRP mode for the given interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.
[in]	mode	Interface MSRP admin mode.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpIntfTrafficPduCounterGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_MSRP_STATS_t	type,
		uint32_t *	counter
	)

Get the value of specified MSRP counter for an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.
[in]	type	Type of counter.
[out]	counter	Counter value.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpIsBoundaryPortGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_MSRP_QAV_STREAMCLASS_t	trClass,
		OPEN_BOOL_t *	isBoundary
	)

Check if a port is boundary port.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.
[in]	trClass	EAV class.
[out]	isBoundary	Flag to check if the port is bondary port.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpMaxFanInPortsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	maxFanInPorts
	)

Get the maximum number of the ports, where MSRP registrations are allowed.

Parameters

[in]	client_handle	client handle from registration API
[out]	maxFanInPorts	Number of the ports where MSRP registrations are allowed.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpMaxFanInPortsSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	maxFanInPorts
	)

Set the maximum number of the ports, where MSRP registrations are allowed.

Parameters

[in]	client_handle	client handle from registration API
[in]	maxFanInPorts	Number of the ports where MSRP registrations are allowed.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	adminMode
	)

Get the global MSRP mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	mode	Global admin mode.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

Note: MSRP Can be enabled/disabled at global or interface level. This API gets the global admin mode status.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

set the global MSRP mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Global admin mode.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

Note: MSRP Can be enabled/disabled at global or interface level. This API sets the global admin mode status.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpQavCurrentBandwidthGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint64_t *	trClassA,
		uint64_t *	trClassB,
		uint64_t *	total
	)

Get the current used bandwidth values for the interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.
[out]	trClassA	class A free bandwidth.
[out]	trClassB	class B free bandwidth.
[out]	total	Total free bandwidth.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

Note: Total, classA, classB values are read.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpQavDeltaBandwidthGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	deltaClassA,
		uint32_t *	deltaClassB
	)

Get the delta bandwidth values for the interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.
[out]	deltaClassA	class A delta bandwidth.
[out]	deltaClassB	class B delta bandwidth.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

Note: Both delta classA, delta classB bandwidth values are read.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpQavDeltaBandwidthSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_MSRP_QAV_STREAMCLASS_t	trafficClass,
		uint32_t	deltaBandwidth
	)

Get the delta bandwidth values for the interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.
[in]	trafficClass	Stream class (A or B).
[in]	deltaBandwidth	Delta bandwidth.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

Note: Both delta classA, delta classB bandwidth values are read.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpQavMaxRateGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint64_t *	trClassA,
		uint64_t *	trClassB,
		uint64_t *	total
	)

Get the max free bandwidth values for the interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.
[out]	trClassA	class A free bandwidth.
[out]	trClassB	class B free bandwidth.
[out]	total	Total free bandwidth.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

Note: Total classA, classB values are read.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpReservationInformationGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	streamId,
		uint32_t	intIfNum,
		open_buffdesc *	reservationInfo
	)

Get the MSRP Reservation Information.

Parameters

[in]	client_handle	client handle from registration API
[in]	streamId	streamId.
[in]	intIfNum	Interface Number.
[out]	reservationInfo	Reservation information.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpSRclassPVIDGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	pvid
	)

Get the MSRP SR class PVID value on the interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.
[out]	pvid	SRclassPVID.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpSRclassPVIDSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	pvid
	)

Set the MSRP SR class PVID value on the interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.
[in]	pvid	SRclassPVID.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpSrQavPriorityGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_MSRP_QAV_STREAMCLASS_t	trClass,
		uint32_t *	priority
	)

Get the 802.1Qav priority.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.
[in]	trClass	EAV class.
[out]	priority	Priority.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpSrQavPrioritySet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_MSRP_QAV_STREAMCLASS_t	trClass,
		uint32_t	priority
	)

Set the 802.1Qav priority.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.
[in]	trClass	EAV class.
[in]	priority	Priority.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpSrQavRePriorityGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_MSRP_QAV_STREAMCLASS_t	trClass,
		uint32_t *	remap
	)

Get the 802.1Qav remapped priority.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.
[in]	trClass	EAV class.
[out]	remap	Remapped priority.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpSrQavRePrioritySet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_MSRP_QAV_STREAMCLASS_t	trClass,
		uint32_t	remap
	)

Set the 802.1Qav remapped priority.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.
[in]	trClass	EAV class.
[in]	remap	Remapped priority.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpStreamIndexedNextGet	(	openapiClientHandle_t *	client_handle,
		uint16_t	currentIndex,
		uint16_t *	nextIndex
	)

Given the next stream index to the given index.

Parameters

[in]	client_handle	client handle from registration API
[in]	currentIndex	Present index.
[out]	nextIndex	Next index.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

Note: To get the first stream index, pass 0 as the given index.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpStreamInformationGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	streamId,
		open_buffdesc *	streamInfo
	)

Get the MSRP Stream Information.

Parameters

[in]	client_handle	client handle from registration API
[in]	streamId	Stream id.
[out]	streamInfo	Stream information.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpTalkerPruningModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	adminMode
	)

Get the MSRP talker pruning mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	mode	Talker pruning mode.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpTalkerPruningModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Set the MSRP talker pruning mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Talker pruning mode.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpTrafficCountersClear ( openapiClientHandle_t * client_handle )

Clear all MSRP traffic counters.

Parameters

[in] client_handle client handle from registration API

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpTrafficCountersPerIfClear	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum
	)

Clear MSRP traffic counters on specified interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Interface Number.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

open_error_t openapiMsrpTrafficPduCounterGet	(	openapiClientHandle_t *	client_handle,
		OPEN_MSRP_STATS_t	type,
		uint32_t *	counter
	)

Get the value of specified MSRP counter.

Parameters

[in]	client_handle	client handle from registration API
[in]	type	Type of counter.
[out]	counter	Counter value.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	MSRP feature is not supported.

OpEN API Version: 1.20

Examples:: msrp_example.c.

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation