Package org.jgrapes.io.events

Class Closed

java.lang.Object

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

org.jgrapes.core.Event<Void>

org.jgrapes.io.events.Closed

All Implemented Interfaces:

Future<Void>, Associator, Eligible

public class Closed
extends Event<Void>

This event signals that an I/O subchannel will no longer be used.

Components that have allocated resources for that channel should release them in response to receiving this event.

Field Summary

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

completed, completionEvents

Constructor Summary

Constructors

Constructor	Description
Closed()	Creates a new event that signals a regular close.
Closed(Throwable error)	Creates a new event that signals a close in response to an error (usually an IOException.

Method Summary

Modifier and Type	Method	Description
Optional<Throwable>	error()	Returns the cause of the Closed event in case of error.

Methods inherited from class org.jgrapes.core.Event

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

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

Constructor Details

Closed

public Closed(Throwable error)

Creates a new event that signals a close in response to an error (usually an IOException.

Closed

public Closed()

Creates a new event that signals a regular close.

Method Details

error

public Optional<Throwable> error()

Returns the cause of the Closed event in case of error.

Returns:

the optional failure