nl.talsmasoftware.context.timing.ContextTimer Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016-2018 Talsma ICT
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package nl.talsmasoftware.context.timing;

import java.util.concurrent.TimeUnit;

/**
 * Minimal Service Provider Interface for services that wish to get informed of context switching metrics.
 * 
 * Currently the following timed operations are updated:
 * 

 * {@code ContextManagers.createContextSnapshot}
 * {@code ContextSnapshot.reactivate}
 * {@code ContextManager.initializeNewContext}(*)
 * {@code ContextManager.getActiveContext}(*)
 * 
 * 
 * (*) Timing is updated for each concrete {@code ContextManager} implementation class
 *
 * @author Sjoerd Talsma
 */
public interface ContextTimer {

    /**
     * Provides a new update for the context timer.
     *
     * @param type     The class being called
     * @param method   The method being called
     * @param duration The duration of the method
     * @param unit     The unit of the duration
     */
    void update(Class type, String method, long duration, TimeUnit unit);

}