org.refcodes.component

Interface Closable

All Known Subinterfaces:

BidirectionalConnectionComponent<INPUT,OUTPUT>, BidirectionalConnectionComponent.BidirectionalConnectionAutomaton<INPUT,OUTPUT>, Closable.CloseAutomaton, CompositeComponent, CompositeComponent.ExtendedCompositeComponent<CTX,CON>, ConnectableComponent, ConnectableComponent.ConnectableAutomaton, ConnectionComponent<CON>, ConnectionComponent.ConnectionAutomaton<CON>, LinkComponent, LinkComponent.LinkAutomaton

All Known Implementing Classes:

AbstractConnectableAutomaton, AbstractDeviceAutomaton, CompositeComponentImpl, CompositeComponentImpl.ExtendedCompositeComponentImpl, ConnectionAutomatonImpl, DeviceAutomatonImpl

public interface Closable

This mixin might be implemented by a component in order to provide closing connection(s) facilities.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Closable.CloseAutomaton The Closable.CloseAutomaton interface defines those methods related to the closing of connection(s) life-cycle.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the component's connection(s).
default void	closeIn(int aCloseInMillis) Tries to close the component's connection(s) after the given time in milliseconds.

Method Detail

close

void close()
    throws CloseException

Closes the component's connection(s). Throws a CloseException as upon close we may have to do things like flushing buffers which can fail (and would otherwise fail unhandled or even worse unnoticed).

Throws:

CloseException - in case closing or pre-closing (flushing) fails.

closeIn

default void closeIn(int aCloseInMillis)

Tries to close the component's connection(s) after the given time in milliseconds. This method doesn't throw an exception as it immediately returns and closes after the given time expired. In case of an exception it will be wrapped in a HiddenException. Use (if implemented) ClosedAccessor.isClosed() to finally determine whether the close operation succeeded.

Parameters:

aCloseInMillis - The time in milliseconds to pass till close() is called.