com.mixer.interactive.resources.core

Class ThrottleState

java.lang.Object

com.mixer.interactive.resources.core.ThrottleState

public class ThrottleState
extends Object

A class that represents the state of how packets have been sent and dropped as a result of throttling rules set up in InteractiveMethod.SET_BANDWIDTH_THROTTLE. It contains the number of sent packets (ones inserted into the bucket) and the number of rejected packets.

Since:

1.0.0

Author:

Microsoft Corporation

Constructor Summary

Constructors

Constructor and Description
ThrottleState(int inserted, int rejected) Initializes a new ThrottleState.

Method Summary

Modifier and Type	Method and Description
int	getInsertedPacketCount() Returns a count of how many packets have been successfully sent.
int	getRejectedPacketCount() Returns a count of how many packets have been dropped (were not sent successfully) as a result of throttling rules.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ThrottleState

public ThrottleState(int inserted,
                     int rejected)

Initializes a new ThrottleState.

Parameters:

inserted - A count of how many packets have been successfully sent

rejected - A count of how many packets have been dropped (were not sent successfully)

Since:

1.0.0

Method Detail

getInsertedPacketCount

public int getInsertedPacketCount()

Returns a count of how many packets have been successfully sent.

Returns:

A count of how many packets have been successfully sent

Since:

1.0.0

getRejectedPacketCount

public int getRejectedPacketCount()

Returns a count of how many packets have been dropped (were not sent successfully) as a result of throttling rules.

Returns:

A count of how many packets have been dropped (were not sent successfully)

Since:

1.0.0