jdk.dio

Class RoundCompletionEvent<P extends Device<? super P>,B extends java.nio.Buffer>

java.lang.Object

jdk.dio.DeviceEvent<P>

jdk.dio.RoundCompletionEvent<P,B>

Type Parameters:

P - the device type the event is defined for.

B - the I/O buffer type.

public class RoundCompletionEvent<P extends Device<? super P>,B extends java.nio.Buffer>
extends DeviceEvent<P>

The RoundCompletionEvent class encapsulates the completion condition of a round of I/O operation.
RoundCompletionEvents are never coalesced.

Since:

1.0

See Also:

InputRoundListener, OutputRoundListener

Field Summary

Fields inherited from class jdk.dio.DeviceEvent

count, device, lastTimeStamp, lastTimeStampMicros, timeStamp, timeStampMicros

Constructor Summary

Constructors

Constructor and Description
RoundCompletionEvent(P device, B buffer, int number) Creates a new RoundCompletionEvent with the specified I/O buffer and time-stamped with the current time.
RoundCompletionEvent(P device, B buffer, int number, boolean onError) Creates a new RoundCompletionEvent with the specified I/O buffer and error status and time-stamped with the current time.
RoundCompletionEvent(P device, B buffer, int number, boolean onError, long timeStamp, int timeStampMicros) Creates a new RoundCompletionEvent with the specified I/O buffer, error status and timestamp.
RoundCompletionEvent(P device, B buffer, int number, long timeStamp, int timeStampMicros) Creates a new RoundCompletionEvent with the specified I/O buffer and timestamp.

Method Summary

Methods

Modifier and Type	Method and Description
B	getBuffer() Returns the input or output buffer.
int	getNumber() Return the number of elements input or output during the round.
boolean	isOnError() Indicates whether an input buffer overrun or output buffer underrun condition occurred and the I/O operation had to be suspended temporarily.

Methods inherited from class jdk.dio.DeviceEvent

getCount, getDevice, getLastTimeStamp, getLastTimeStampMicros, getTimeStamp, getTimeStampMicros

Methods inherited from class java.lang.Object

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

Constructor Detail

RoundCompletionEvent

public RoundCompletionEvent(P device,
                    B buffer,
                    int number)

Creates a new RoundCompletionEvent with the specified I/O buffer and time-stamped with the current time. The onError flag is set to false.

Parameters:

device - the source device.

buffer - the input or output buffer.

number - the number of elements input or output during the round.

Throws:

java.lang.NullPointerException - if device or buffer is null.

java.lang.IllegalArgumentException - if number is negative.

RoundCompletionEvent

public RoundCompletionEvent(P device,
                    B buffer,
                    int number,
                    long timeStamp,
                    int timeStampMicros)

Creates a new RoundCompletionEvent with the specified I/O buffer and timestamp. The onError flag is set to false.

Parameters:

device - the source device.

buffer - the I/O buffer.

number - the number of elements input or output during the round.

timeStamp - the timestamp (in milliseconds).

timeStampMicros - the additional microseconds to the timestamp.

Throws:

java.lang.NullPointerException - if device or buffer is null.

java.lang.IllegalArgumentException - if timeStamp, timeStampMicros or number is negative.

RoundCompletionEvent

public RoundCompletionEvent(P device,
                    B buffer,
                    int number,
                    boolean onError)

Creates a new RoundCompletionEvent with the specified I/O buffer and error status and time-stamped with the current time.

Parameters:

device - the source device.

buffer - the input or output buffer.

number - the number of elements input or output during the round.

onError - whether an input buffer overrun or output buffer underrun condition occurred.

Throws:

java.lang.NullPointerException - if device or buffer is null.

java.lang.IllegalArgumentException - if number is negative.

RoundCompletionEvent

public RoundCompletionEvent(P device,
                    B buffer,
                    int number,
                    boolean onError,
                    long timeStamp,
                    int timeStampMicros)

Creates a new RoundCompletionEvent with the specified I/O buffer, error status and timestamp.

Parameters:

device - the source device.

buffer - the I/O buffer.

number - the number of elements input or output during the round.

onError - whether an input buffer overrun or output buffer underrun condition occurred.

timeStamp - the timestamp (in milliseconds).

timeStampMicros - the additional microseconds to the timestamp.

Throws:

java.lang.NullPointerException - if device or buffer is null.

java.lang.IllegalArgumentException - if timeStamp, timeStampMicros or number is negative.

Method Detail

getBuffer

public B getBuffer()

Returns the input or output buffer.

Returns:

the input or output buffer.

getNumber

public int getNumber()

Return the number of elements input or output during the round.

Returns:

the number of elements input or output during the round.

isOnError

public boolean isOnError()

Indicates whether an input buffer overrun or output buffer underrun condition occurred and the I/O operation had to be suspended temporarily.

Returns:

true if an input buffer overrun or output buffer underrun condition occurred; false otherwise.