org.dc.riot.lol.rx.service

Class TicketBucket

java.lang.Object

org.dc.riot.lol.rx.service.TicketBucket

public class TicketBucket
extends java.lang.Object

Rate throttling semaphore. This is the primary rate throttling service. A single instance of this class should exist per ApiKey per Region.

Since:

1.0.0

See Also:

ApiFactory, Region, ApiKey.getTicketBucket(Region)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TicketBucket.Ticket Rate control ticket.

Method Summary

Modifier and Type	Method and Description
long	getBuffer()
protected long	getTime() Android subclasses can override this to provide a more Android appropriate method.
void	put(TicketBucket.Ticket... tickets) Return a set of TicketBucket.Ticket to the appropriate Bucket(s)
void	setBuffer(int buffer, java.util.concurrent.TimeUnit unit) Set additional buffer time to wait between valid requests.
void	stall(long delay, java.util.concurrent.TimeUnit timeUnit)
TicketBucket.Ticket[]	take() Takes a TicketBucket.Ticket from each Bucket in this semaphore.

Methods inherited from class java.lang.Object

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

Method Detail

take

public TicketBucket.Ticket[] take()
                           throws java.lang.InterruptedException

Takes a TicketBucket.Ticket from each Bucket in this semaphore. Blocks until each Bucket yields a TicketBucket.Ticket

Returns:

a TicketBucket.Ticket from each Bucket

Throws:

java.lang.InterruptedException - if cancelled

put

public void put(TicketBucket.Ticket... tickets)
         throws java.lang.InterruptedException

Return a set of TicketBucket.Ticket to the appropriate Bucket(s)

Parameters:

tickets - set of TicketBucket.Tickets retrieved using take()

Throws:

java.lang.InterruptedException - if cancelled

setBuffer

public void setBuffer(int buffer,
                      java.util.concurrent.TimeUnit unit)

Set additional buffer time to wait between valid requests.

Parameters:

buffer - time buffer

unit - time unit

getBuffer

public long getBuffer()

Returns:

the current time buffer

stall

public void stall(long delay,
                  java.util.concurrent.TimeUnit timeUnit)

Parameters:

delay - pause this TicketBucket for this many time units

timeUnit - time unit, usually seconds

getTime

protected long getTime()

Android subclasses can override this to provide a more Android appropriate method.

Returns:

the current system time