com.mesosphere.sdk.queue

Class OfferQueue

java.lang.Object

com.mesosphere.sdk.queue.OfferQueue

public class OfferQueue
extends java.lang.Object

This class acts as a buffer of Offers from Mesos. By default it holds a maximum of 100 Offers.

Constructor Summary

Constructors

Constructor and Description
OfferQueue()
OfferQueue(int capacity) Creates a new queue with the provided capacity.

Method Summary

Modifier and Type	Method and Description
(package private) int	getRemainingCapacity() This method returns the remaining capacity in the queue.
(package private) int	getSize() This method returns the number of elements in the queue.
boolean	isEmpty() This method specifies whether any offers are in the queue.
boolean	offer(Protos.Offer offer) This method enqueues an Offer from Mesos if there is capacity.
void	remove(Protos.OfferID offerID) This method removes an offer from the queue based on its OfferID.
java.util.List<Protos.Offer>	takeAll() Calling this method will wait for Offers for a static duration of DEFAULT_CAPACITY.
java.util.List<Protos.Offer>	takeAll(java.time.Duration duration) Calling this method will wait for Offers for the provided duration.

Methods inherited from class java.lang.Object

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

Constructor Detail

OfferQueue

public OfferQueue()

OfferQueue

public OfferQueue(int capacity)

Creates a new queue with the provided capacity.

Parameters:

capacity - the maximum size of the queue, or zero for unlimited queue size

Method Detail

takeAll

public java.util.List<Protos.Offer> takeAll(java.time.Duration duration)

Calling this method will wait for Offers for the provided duration. It returns all Offers currently in the queue if any are present and none otherwise.

takeAll

public java.util.List<Protos.Offer> takeAll()

Calling this method will wait for Offers for a static duration of DEFAULT_CAPACITY. It returns all Offers currently in the queue if any are present and an empty list if the duration of DEFAULT_OFFER_WAIT is reached.

offer

public boolean offer(Protos.Offer offer)

This method enqueues an Offer from Mesos if there is capacity. If there is not capacity the Offer is not added to the queue.

Returns:

true if the Offer was successfully put in the queue, false otherwise

remove

public void remove(Protos.OfferID offerID)

This method removes an offer from the queue based on its OfferID.

isEmpty

public boolean isEmpty()

This method specifies whether any offers are in the queue.

getSize

int getSize()

This method returns the number of elements in the queue.

getRemainingCapacity

int getRemainingCapacity()

This method returns the remaining capacity in the queue.