src/jdk.jfr/share/classes/jdk/jfr/FlightRecorderListener.java
author egahlin
Tue, 15 May 2018 20:24:34 +0200
changeset 50113 caf115bb98ad
permissions -rw-r--r--
8199712: Flight Recorder Reviewed-by: coleenp, ihse, erikj, dsamersoff, mseledtsov, egahlin, mgronlun Contributed-by: erik.gahlin@oracle.com, markus.gronlund@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     1
/*
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     2
 * Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     4
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    10
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    15
 * accompanied this code).
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    16
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    20
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    23
 * questions.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    24
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    25
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    26
package jdk.jfr;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    27
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    28
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
/**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
 * Callback interface to monitor Flight Recorder's life cycle.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
 * @since 9
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
public interface FlightRecorderListener {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
     * Receives notification when Flight Recorder is initialized.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
     * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
     * This method is also be invoked when a listener is added to an already
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
     * initialized Flight Recorder.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
     * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
     * This method allows clients to implement their own initialization mechanism
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
     * that is executed before a {@code FlightRecorder} instance is returned by
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
     * {@code FlightRecorder#getFlightRecorder()}.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
     * @implNote This method should return as soon as possible, to avoid blocking
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
     *           initialization of Flight Recorder. To avoid deadlocks or unexpected
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
     *           behavior, this method should not call
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
     *           {@link FlightRecorder#getFlightRecorder()} or start new recordings.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
     * @implSpec The default implementation of this method is empty.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
     * @param recorder Flight Recorder instance, not {@code null}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
     * @see FlightRecorder#addListener(FlightRecorderListener)
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
    default void recorderInitialized(FlightRecorder recorder) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    61
     * Receives notification when the state of a recording changes.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    62
     * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    63
     * Callback is invoked when a recording reaches the {@code RUNNING},
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
     * {@code STOPPED} and {@code CLOSED} state.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    65
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    66
     * @implNote The implementation of this method should return as soon as possible
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    67
     *           to avoid blocking normal operation of Flight Recorder.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    68
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    69
     * @implSpec The default implementation of this method is empty.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    70
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
     * @param recording the recording where the state change occurred, not
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    72
     *        {@code null}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    73
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    74
     * @see FlightRecorder#addListener(FlightRecorderListener)
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    75
     * @see RecordingState
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    76
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    77
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    78
    default void recordingStateChanged(Recording recording) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    79
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    80
}