ch.icosys.popjava.core.broker

Class RequestQueue

java.lang.Object

ch.icosys.popjava.core.broker.RequestQueue

public class RequestQueue
extends java.lang.Object

This class represents the request queue used in the broker-side Every requests are put into this request queue and are served in FIFO order

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_REQUEST_QUEUE_SIZE

Constructor Summary

Constructors

Constructor and Description
RequestQueue() Creates a new instance of POPRequestQueue

Method Summary

Modifier and Type	Method and Description
boolean	add(Request request) Put a new request in the queue
boolean	canPeek() Check if there is request to peek
boolean	clear() Clear the queue
int	getMaxQueue() Return the maximum number of requests in the queue
Request	peek(int time, java.util.concurrent.TimeUnit timeUnit) Peek a request in the queue.
boolean	remove(Request request) Remove a specific request from the queue
void	setMaxQueue(int maxQueue) Set the maximum number of requests in the queue
int	size() Give the actual number of requests in the queue

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REQUEST_QUEUE_SIZE

public static final int DEFAULT_REQUEST_QUEUE_SIZE

See Also:

Constant Field Values

Constructor Detail

RequestQueue

public RequestQueue()

Creates a new instance of POPRequestQueue

Method Detail

size

public int size()

Give the actual number of requests in the queue

Returns:

number of requests

getMaxQueue

public int getMaxQueue()

Return the maximum number of requests in the queue

Returns:

max requests number in the queue

setMaxQueue

public void setMaxQueue(int maxQueue)

Set the maximum number of requests in the queue

Parameters:

maxQueue - Maximum number of requests

add

public boolean add(Request request)

Put a new request in the queue

Parameters:

request - Request to add

Returns:

true if the request is added correctly

peek

public Request peek(int time,
                    java.util.concurrent.TimeUnit timeUnit)

Peek a request in the queue. If there is no request to peek, this method waits the time passed in parameters

Parameters:

time - Time to wait

timeUnit - Unit of time

Returns:

Request peeked in the queue

remove

public boolean remove(Request request)

Remove a specific request from the queue

Parameters:

request - Request to be removed

Returns:

true if the request is correctly removed

clear

public boolean clear()

Clear the queue

Returns:

true if the queue if correctly cleared

canPeek

public boolean canPeek()

Check if there is request to peek

Returns:

true if a request can be peeked