com.oracle.deviceaccess

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

java.lang.Object

com.oracle.deviceaccess.PeripheralEvent<P>

com.oracle.deviceaccess.RoundCompletionEvent<P,B>

Type Parameters:

P - the peripheral type the event is defined for.

B - the I/O buffer type.

public class RoundCompletionEvent<P extends Peripheral<? super P>,B extends java.nio.Buffer>
extends PeripheralEvent<P>

The RoundCompletionEvent class encapsulates the completion condition of a round of I/O operation.
This kind of events is never coalesced.

See Also:

InputRoundListener, OutputRoundListener

Field Summary

Fields inherited from class com.oracle.deviceaccess.PeripheralEvent

count, lastTimeStamp, lastTimeStampMicros, peripheral, timeStamp, timeStampMicros

Constructor Summary

Constructors

Constructor and Description
RoundCompletionEvent(P peripheral, B buffer, int number) Creates a new RoundCompletionEvent with the specified I/O buffer and time-stamped with the current time.
RoundCompletionEvent(P peripheral, 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 com.oracle.deviceaccess.PeripheralEvent

getCount, getLastTimeStamp, getLastTimeStampMicros, getPeripheral, getTimeStamp, getTimeStampMicros

Methods inherited from class java.lang.Object

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

Constructor Detail

RoundCompletionEvent

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

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

Parameters:

peripheral - the source peripheral.

buffer - the input or output buffer.

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

Throws:

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

java.lang.IllegalArgumentException - if number is negative.

RoundCompletionEvent

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

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

Parameters:

peripheral - the source peripheral.

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 peripheral 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.