com.xeiam.xchange.dto.meta

Class RateLimit

java.lang.Object

com.xeiam.xchange.dto.meta.RateLimit

public class RateLimit
extends Object

Describe a call rate limit as a number of calls per some time span.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RateLimit.TimeUnitDeserializer

Field Summary

Fields

Modifier and Type	Field and Description
int	calls
int	timeSpan
TimeUnit	timeUnit

Constructor Summary

Constructors

Constructor and Description
RateLimit() Constructor
RateLimit(int calls, int timeSpan, TimeUnit timeUnit)

Method Summary

Modifier and Type	Method and Description
long	getPollDelayMillis()

Methods inherited from class java.lang.Object

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

Field Detail

calls

public int calls

timeUnit

public TimeUnit timeUnit

timeSpan

public int timeSpan

Constructor Detail

RateLimit

public RateLimit()

Constructor

RateLimit

public RateLimit(int calls,
                 int timeSpan,
                 TimeUnit timeUnit)

Method Detail

getPollDelayMillis

public long getPollDelayMillis()

Returns:

this rate limit as a number of milliseconds required between any two remote calls, assuming the client makes consecutive calls without any bursts or breaks for an infinite period of time.