public abstract Class AbstractEventStream

Implements jdk.jfr.consumer.EventStream.awaitTermination.

Doc from jdk.jfr.consumer.EventStream.awaitTermination.

Blocks until all actions are completed, or the stream is closed, or the current thread is interrupted, whichever happens first.

Annotations

@Override

Exceptions

InterruptedException:

if interrupted while waiting

Implements jdk.jfr.consumer.EventStream.awaitTermination.

Doc from jdk.jfr.consumer.EventStream.awaitTermination.

Blocks until all actions are completed, or the stream is closed, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Annotations

@Override

Exceptions

InterruptedException:

if interrupted while waiting

Redeclares jdk.jfr.consumer.EventStream.close.

Doc from jdk.jfr.consumer.EventStream.close.

Releases all resources associated with this stream.

If a stream is started, asynchronously or synchronously, it is stopped immediately or after the next flush. This method does NOT guarantee that all registered actions are completed before return.

Closing a previously closed stream has no effect.

Annotations

@Override

Implements jdk.jfr.consumer.EventStream.onClose.

Doc from jdk.jfr.consumer.EventStream.onClose.

Registers an action to perform when the stream is closed.

If the stream is already closed, the action will be performed immediately in the current thread.

Annotations

@Override

Implements jdk.jfr.consumer.EventStream.onError.

Doc from jdk.jfr.consumer.EventStream.onError.

Registers an action to perform if an exception occurs.

If an action is not registered, an exception stack trace is printed to standard error.

Registering an action overrides the default behavior. If multiple actions have been registered, they are performed in the order of registration.

If this method itself throws an exception, resulting behavior is undefined.

Annotations

@Override

Implements jdk.jfr.consumer.EventStream.onEvent.

Doc from jdk.jfr.consumer.EventStream.onEvent.

Registers an action to perform on all events in the stream.

To perform an action on a subset of event types, consider using onEvent(String, Consumer) and onMetadata(Consumer) as it is likely more performant than any selection or filtering mechanism implemented in a generic action.

Annotations

@Override

Implements jdk.jfr.consumer.EventStream.onEvent.

Doc from jdk.jfr.consumer.EventStream.onEvent.

Registers an action to perform on all events matching a name.

Annotations

@Override

Implements jdk.jfr.consumer.EventStream.onFlush.

Doc from jdk.jfr.consumer.EventStream.onFlush.

Registers an action to perform after the stream has been flushed.

Annotations

@Override

Overrides default jdk.jfr.consumer.EventStream.onMetadata.

Doc from jdk.jfr.consumer.EventStream.onMetadata.

Registers an action to perform when new metadata arrives in the stream. The event type of an event always arrives sometime before the actual event. The action must be registered before the stream is started.

The following example shows how to listen to new event types, register an action if the event type name matches a regular expression and increase a counter if a matching event is found. A benefit of using an action per event type, instead of the generic onEvent(Consumer) method, is that a stream implementation can avoid reading events that are of no interest.

static long count = 0;
public static void main(String... args) throws IOException {
    Path file = Path.of(args[0]);
    String regExp = args[1];
    var pr = Pattern.compile(regExp).asMatchPredicate();
    try (var s = EventStream.openFile(file)) {
        s.setOrdered(false);
        s.onMetadata(metadata -> metadata.getAddedEventTypes()
         .stream().map(EventType::getName).filter(pr)
         .forEach(eventName -> s.onEvent(eventName, event -> count++)));
        s.start();
        System.out.println(count + " events matches " + regExp);
    }
}

Annotations

@Override

Implements jdk.jfr.consumer.EventStream.remove.

Doc from jdk.jfr.consumer.EventStream.remove.

Unregisters an action.

If the action has been registered multiple times, all instances are unregistered.

Annotations

@Override

Implements jdk.jfr.consumer.EventStream.setEndTime.

Doc from jdk.jfr.consumer.EventStream.setEndTime.

Specifies the end time of the stream.

The end time must be set before starting the stream.

At end time, the stream is closed.

Annotations

@Override

Implements jdk.jfr.consumer.EventStream.setOrdered.

Doc from jdk.jfr.consumer.EventStream.setOrdered.

Specifies that events arrive in chronological order, sorted by the time they were committed to the stream.

Annotations

@Override

Implements jdk.jfr.consumer.EventStream.setReuse.

Doc from jdk.jfr.consumer.EventStream.setReuse.

Specifies that the event object in an onEvent(Consumer) action can be reused.

If reuse is set to true, an action should not keep a reference to the event object after the action has completed.

Annotations

@Override

Implements jdk.jfr.consumer.EventStream.setStartTime.

Doc from jdk.jfr.consumer.EventStream.setStartTime.

Specifies the start time of the stream.

The start time must be set before starting the stream

Annotations

@Override

Redeclares jdk.jfr.consumer.EventStream.start.

Doc from jdk.jfr.consumer.EventStream.start.

Starts processing of actions.

Actions are performed in the current thread.

To stop the stream, use the close() method.

Annotations

@Override

Redeclares jdk.jfr.consumer.EventStream.startAsync.

Doc from jdk.jfr.consumer.EventStream.startAsync.

Starts asynchronous processing of actions.

Actions are performed in a single separate thread.

To stop the stream, use the close() method.

Annotations

@Override