org.thales.punch.libraries.utils.api

Class Async<T>

java.lang.Object

org.thales.punch.libraries.utils.api.Async<T>

All Implemented Interfaces:

Runnable

public class Async<T>
extends Object
implements Runnable

A very simple facility to execute an asynchronous action. It basically combines finite queue with a tread continuously polling that queue and invoking your callback.

What is the point ? Send many message using a best effort strategy using some third party API that is not really non blocking. You can then decide to discard the messages or do something on your own but not put your main threads at risk.

The usage is straightrorward:

    async = new Async(1000, "kafka-reporter", consumer);
    
    ...
    
    if (!async.add("some string")) {
      // it could not be processed
    }
 }
 
 

Author:

dimi

Constructor Summary

Constructors

Constructor and Description
Async(int size, String name, Consumer<T> consumer)

Method Summary

Modifier and Type	Method and Description
boolean	add(T item)
void	run()
void	stop() Stop this async.

Methods inherited from class java.lang.Object

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

Constructor Detail

Async

public Async(int size,
             String name,
             Consumer<T> consumer)

Parameters:

size - the max queue size. If more than that number of items are enquued you will fail adding more.

name - the name of the underlying thread

consumer - the consumer in charge of performing a blocking or possibly slow operation

Method Detail

add

public boolean add(T item)

Parameters:

item - an item to handle

Returns:

true if it was accepted. Your consumer will be called shortly for that item

stop

public void stop()

Stop this async.

run

public void run()

Specified by:

run in interface Runnable