Package com.wavefront.agent.queueing

Class DataSubmissionQueue<T extends DataSubmissionTask<T>>

java.lang.Object

com.squareup.tape2.ObjectQueue<T>

com.wavefront.agent.queueing.DataSubmissionQueue<T>

Type Parameters:

T - type of objects stored.

All Implemented Interfaces:

TaskQueue<T>, Closeable, AutoCloseable, Iterable<T>

public class DataSubmissionQueue<T extends DataSubmissionTask<T>>
extends com.squareup.tape2.ObjectQueue<T>
implements TaskQueue<T>

Implements proxy-specific queue interface as a wrapper over tape ObjectQueue

Author:

[email protected]

Nested Class Summary

Nested classes/interfaces inherited from class com.squareup.tape2.ObjectQueue

com.squareup.tape2.ObjectQueue.Converter<T extends Object>

Constructor Summary

Constructors

Constructor	Description
DataSubmissionQueue(com.squareup.tape2.ObjectQueue<T> delegate, String handle, com.wavefront.data.ReportableEntityType entityType)

Method Summary

Modifier and Type	Method	Description
void	add(T t)	Add a task to the end of the queue
void	clear()	Empty and re-initialize the queue.
void	close()	Close the queue.
com.squareup.tape2.QueueFile	file()
Long	getAvailableBytes()	Returns the total number of pre-allocated but unused bytes in the backing file.
Iterator<T>	iterator()
T	peek()	Retrieve a task that is currently at the head of the queue.
List<T>	peek(int max)
void	remove(int tasksToRemove)
int	size()	Returns a number of tasks currently in the queue.
Long	weight()	Returns the total weight of the queue (sum of weights of all tasks).

Methods inherited from class com.squareup.tape2.ObjectQueue

asList, create, createInMemory, isEmpty, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.wavefront.agent.queueing.TaskQueue

remove

Constructor Detail

DataSubmissionQueue

public DataSubmissionQueue(com.squareup.tape2.ObjectQueue<T> delegate,
                           @Nullable
                           String handle,
                           @Nullable
                           com.wavefront.data.ReportableEntityType entityType)

Parameters:

delegate - delegate ObjectQueue.

handle - pipeline handle.

entityType - entity type.

Method Detail

file

public com.squareup.tape2.QueueFile file()

Specified by:

file in class com.squareup.tape2.ObjectQueue<T extends DataSubmissionTask<T>>

peek

public List<T> peek(int max)

Overrides:

peek in class com.squareup.tape2.ObjectQueue<T extends DataSubmissionTask<T>>

peek

public T peek()

Description copied from interface: TaskQueue

Retrieve a task that is currently at the head of the queue.

Specified by:

peek in interface TaskQueue<T extends DataSubmissionTask<T>>

Specified by:

peek in class com.squareup.tape2.ObjectQueue<T extends DataSubmissionTask<T>>

Returns:

task object

add

public void add(@Nonnull
                T t)
         throws IOException

Description copied from interface: TaskQueue

Add a task to the end of the queue

Specified by:

add in interface TaskQueue<T extends DataSubmissionTask<T>>

Specified by:

add in class com.squareup.tape2.ObjectQueue<T extends DataSubmissionTask<T>>

Parameters:

t - task

Throws:

IOException - IO exceptions caught by the storage engine

clear

public void clear()

Description copied from interface: TaskQueue

Empty and re-initialize the queue.

Specified by:

clear in interface TaskQueue<T extends DataSubmissionTask<T>>

Overrides:

clear in class com.squareup.tape2.ObjectQueue<T extends DataSubmissionTask<T>>

remove

public void remove(int tasksToRemove)

Specified by:

remove in class com.squareup.tape2.ObjectQueue<T extends DataSubmissionTask<T>>

size

public int size()

Description copied from interface: TaskQueue

Returns a number of tasks currently in the queue.

Specified by:

size in interface TaskQueue<T extends DataSubmissionTask<T>>

Specified by:

size in class com.squareup.tape2.ObjectQueue<T extends DataSubmissionTask<T>>

Returns:

number of tasks

close

public void close()

Description copied from interface: TaskQueue

Close the queue. Should be invoked before a graceful shutdown.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface TaskQueue<T extends DataSubmissionTask<T>>

iterator

@Nonnull
public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends DataSubmissionTask<T>>

weight

@Nullable
public Long weight()

Description copied from interface: TaskQueue

Returns the total weight of the queue (sum of weights of all tasks).

Specified by:

weight in interface TaskQueue<T extends DataSubmissionTask<T>>

Returns:

weight of the queue (null if unknown)

getAvailableBytes

@Nullable
public Long getAvailableBytes()

Description copied from interface: TaskQueue

Returns the total number of pre-allocated but unused bytes in the backing file. May return null if not applicable.

Specified by:

getAvailableBytes in interface TaskQueue<T extends DataSubmissionTask<T>>

Returns:

total number of available bytes in the file or null