org.apache.oozie.event
Interface EventQueue

All Known Implementing Classes:
MemoryEventQueue

public interface EventQueue

Interface to define the queue operations for the events system


Nested Class Summary
static class EventQueue.EventQueueElement
           
 
Method Summary
 void add(org.apache.oozie.client.event.Event e)
          Add event to queue
 void clear()
          Clear the events queue
 int getBatchSize()
          Get the batch size used during polling events
 void init(org.apache.hadoop.conf.Configuration conf)
          Initialize the event queue
 boolean isEmpty()
          Find out if queue is empty
 org.apache.oozie.client.event.Event peek()
          Read topmost event from queue but do not pop from it
 org.apache.oozie.client.event.Event poll()
          Fetch single event from queue
 List<org.apache.oozie.client.event.Event> pollBatch()
          Fetch events from queue in batch
 int size()
          Get current queue size
 

Method Detail

init

void init(org.apache.hadoop.conf.Configuration conf)
Initialize the event queue

Parameters:
conf -

add

void add(org.apache.oozie.client.event.Event e)
Add event to queue

Parameters:
event -

pollBatch

List<org.apache.oozie.client.event.Event> pollBatch()
Fetch events from queue in batch

Returns:
events set

poll

org.apache.oozie.client.event.Event poll()
Fetch single event from queue

Returns:
event

isEmpty

boolean isEmpty()
Find out if queue is empty

Returns:
boolean

size

int size()
Get current queue size

Returns:
size

peek

org.apache.oozie.client.event.Event peek()
Read topmost event from queue but do not pop from it

Returns:
event

getBatchSize

int getBatchSize()
Get the batch size used during polling events

Returns:
batchSize

clear

void clear()
Clear the events queue



Copyright © 2013 Apache Software Foundation. All Rights Reserved.