org.hobbit.core.rabbit

Class DataReceiverImpl

java.lang.Object

org.hobbit.core.rabbit.DataReceiverImpl

All Implemented Interfaces:

Closeable, AutoCloseable, DataReceiver

public class DataReceiverImpl
extends Object
implements DataReceiver

Implementation of the DataReceiver interface.

Use the internal DataReceiverImpl.Builder class for creating instances of the DataReceiverImpl class. Note that the created DataReceiverImpl will either use a given RabbitQueue or create a new one. In both cases the receiver will become the owner of the queue, i.e., if the DataReceiverImpl instance is closed the queue will be closed as well.

Internally, the receiver uses a multithreaded consumer that handles incoming streams, sorts the messages that belong to these streams and sends the received data via an InputStream to the given IncomingStreamHandler instance. Note that since the consumer is multithreaded the IncomingStreamHandler.handleIncomingStream(String, InputStream) should be thread safe since it might be called in parallel. Even setting the maximum number of parallel processed messages to 1 (via DataReceiverImpl.Builder.maxParallelProcessedMsgs(int)) the given handler might be called with several InputStream instances in parallel.

The DataReceiverImpl owns recources that need to be freed if its work is done. This can be achieved by closing the receiver. In most cases, this should be done using the closeWhenFinished() method which waits until all incoming messages are processed and all streams are closed. Note that using the close() method leads to a direct shutdown of the queue which could lead to data loss and threads getting stuck.

Author:

Michael Röder (roeder@informatik.uni-leipzig.de)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataReceiverImpl.Builder

Field Summary

Fields

Modifier and Type	Field and Description
private static int	CHECKS_BEFORE_CLOSING
private MessageConsumer	consumer
private IncomingStreamHandler	dataHandler
private int	errorCount
private static org.slf4j.Logger	LOGGER
private String	name
protected RabbitQueue	queue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataReceiverImpl(RabbitQueue queue, IncomingStreamHandler handler, MessageConsumerBuilder consumerBuilder, int maxParallelProcessedMsgs, String name)

Method Summary

Modifier and Type	Method and Description
static DataReceiverImpl.Builder	builder() Returns a newly created DataReceiverImpl.Builder.
void	close() A rude way to close the receiver.
void	closeWhenFinished() This method waits for the data receiver to finish its work and closes the incoming queue as well as the internal thread pool after that.
IncomingStreamHandler	getDataHandler()
int	getErrorCount() Returns the number of errors that have been encountered while receiving data.
RabbitQueue	getQueue()
void	increaseErrorCount()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

CHECKS_BEFORE_CLOSING

private static final int CHECKS_BEFORE_CLOSING

See Also:

Constant Field Values

queue

protected RabbitQueue queue

errorCount

private int errorCount

dataHandler

private IncomingStreamHandler dataHandler

consumer

private MessageConsumer consumer

name

private String name

Constructor Detail

DataReceiverImpl

protected DataReceiverImpl(RabbitQueue queue,
                           IncomingStreamHandler handler,
                           MessageConsumerBuilder consumerBuilder,
                           int maxParallelProcessedMsgs,
                           String name)
                    throws IOException

Throws:

IOException

Method Detail

getDataHandler

public IncomingStreamHandler getDataHandler()

Specified by:

getDataHandler in interface DataReceiver

increaseErrorCount

public void increaseErrorCount()

Specified by:

increaseErrorCount in interface DataReceiver

getErrorCount

public int getErrorCount()

Description copied from interface: DataReceiver

Returns the number of errors that have been encountered while receiving data. If this number is not 0 the receiver can not guarantee that all data has been received correctly.

Specified by:

getErrorCount in interface DataReceiver

Returns:

the number of errors encountered during the receiving of data

getQueue

public RabbitQueue getQueue()

Specified by:

getQueue in interface DataReceiver

closeWhenFinished

public void closeWhenFinished()

This method waits for the data receiver to finish its work and closes the incoming queue as well as the internal thread pool after that.

Specified by:

closeWhenFinished in interface DataReceiver

close

public void close()

A rude way to close the receiver. Note that this method directly closes the incoming queue and only notifies the internal consumer to stop its work but won't wait for the handler threads to finish their work.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

builder

public static DataReceiverImpl.Builder builder()

Returns a newly created DataReceiverImpl.Builder.

Returns:

a new DataReceiverImpl.Builder instance