jdk.dio.pwm

Interface GenerationListener

All Superinterfaces:

AsyncErrorHandler<PWMChannel>, DeviceEventListener

public interface GenerationListener
extends DeviceEventListener, AsyncErrorHandler<PWMChannel>

The GenerationListener interface defines methods for getting notified of pulse generation completion conditions (i.e. maximum generated pulse count value reached) as well as device errors.

A GenerationListener can be registered using the PWMChannel.startGeneration method.

Since:

1.0

See Also:

PWMChannel.startGeneration(int, int, GenerationListener)

Method Summary

Methods

Modifier and Type	Method and Description
void	failed(java.lang.Throwable exception, PWMChannel source) Invoked when an I/O operation fails.
void	pulseGenerationCompleted(GenerationEvent event) Invoked when the generated pulse count has reached the maximum value.

Method Detail

pulseGenerationCompleted

void pulseGenerationCompleted(GenerationEvent event)

Invoked when the generated pulse count has reached the maximum value.

The corresponding pulse generation operation being completed another asynchronous pulse generation operation may be started from within this method (see PWMChannel.startGeneration(int). This may be used to generate a subsequent pulse train with different specifications: pulse period and/or width/duty cycle.

Parameters:

event - the event that occurred.

failed

void failed(java.lang.Throwable exception,
          PWMChannel source)

Invoked when an I/O operation fails.

Specified by:

failed in interface AsyncErrorHandler<PWMChannel>

Parameters:

exception - The exception to indicate why the I/O operation failed

source - The PWMChannel instance that generated the error.