Package org.jgrapes.io.events

Class Input<T extends Buffer>

java.lang.Object

org.jgrapes.core.internal.EventBase<Void>

org.jgrapes.core.Event<Void>

org.jgrapes.io.events.IOEvent<T>

org.jgrapes.io.events.Input<T>

Type Parameters:

T - the type of data used in this event

All Implemented Interfaces:

Future<Void>, Associator, Eligible

public final class Input<T extends Buffer>
extends IOEvent<T>

This event signals that a new chunk of data has successfully been obtained from some source.

This type of event is commonly used for data flowing into the application.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Field Summary

Fields inherited from class org.jgrapes.core.internal.EventBase

completed, completionEvents, invokedFor

Method Summary

Modifier and Type	Method	Description
static <B extends Buffer> Input<B>	fromSink(ManagedBuffer<B> buffer, boolean endOfRecord)	Create a new event with the given buffer.
static <B extends Buffer> Input<B>	fromSource(ManagedBuffer<B> buffer, boolean endOfRecord)	Create a new event with the given buffer.

Methods inherited from class org.jgrapes.io.events.IOEvent

buffer, data, handled, hasRemaining, isEndOfRecord, remaining, toString

Methods inherited from class org.jgrapes.core.Event

addCompletionEvent, associated, cancel, channels, channels, completionEvents, currentResults, defaultCriterion, forChannels, get, get, handlingError, isCancelled, isDone, isEligibleFor, isStopped, processedBy, results, results, resumeHandling, setAssociated, setChannels, setRequiresResult, setResult, stop, suspendHandling, suspendHandling, tieTo

Methods inherited from class org.jgrapes.core.internal.EventBase

disableTracking, enqueued, firstResultAssigned, isTracked, onCompletion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgrapes.core.Associator

associated, associated, associated, associatedGet

Methods inherited from interface java.util.concurrent.Future

exceptionNow, resultNow, state

Method Details

fromSource

public static <B extends Buffer> Input<B> fromSource(ManagedBuffer<B> buffer,
 boolean endOfRecord)

Create a new event with the given buffer.

The buffer must have been prepared for invoking get-methods.

Parameters:

buffer - the buffer with the data

endOfRecord - if the event ends a data record

fromSink

public static <B extends Buffer> Input<B> fromSink(ManagedBuffer<B> buffer,
 boolean endOfRecord)

Create a new event with the given buffer.

Creating the event flips the buffer, which is assumed to have been used for collecting data up to now.

Parameters:

buffer - the buffer with the data

endOfRecord - if the event ends a data record