com.mixer.interactive.resources.core

Class BandwidthThrottle

java.lang.Object

com.mixer.interactive.resources.core.BandwidthThrottle

public class BandwidthThrottle
extends Object

A BandwidthThrottle represents a throttle to be used by the Interactive service when sending messages to the client.

Since:

1.0.0

Author:

Microsoft Corporation

See Also:

GameClient.setBandwidthThrottle(Map)

Constructor Summary

Constructors

Constructor and Description
BandwidthThrottle(int capacity, int drainRate) Initializes a new BandwidthThrottle.

Method Summary

Modifier and Type	Method and Description
int	getCapacity() Returns the total bucket capacity.
int	getDrainRate() Returns the drain rate (in bytes per second) for the bucket.

Methods inherited from class java.lang.Object

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

Constructor Detail

BandwidthThrottle

public BandwidthThrottle(int capacity,
                         int drainRate)

Initializes a new BandwidthThrottle.

Parameters:

capacity - The total bucket capacity (in bytes)

drainRate - The drain rate (in bytes per second) for the bucket

Since:

1.0.0

Method Detail

getCapacity

public int getCapacity()

Returns the total bucket capacity.

Returns:

The total bucket capacity

Since:

1.0.0

getDrainRate

public int getDrainRate()

Returns the drain rate (in bytes per second) for the bucket.

Returns:

The drain rate (in bytes per second) for the bucket

Since:

1.0.0