com.github.rholder.moar.concurrent.thread.ThreadProfiler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of moar-concurrent Show documentation

This module contains a collection of useful builders and concurrency classes to assist in modeling complex or overly tweakable concurrent processing pipelines.

There is a newer version: 1.0.3

Show newest version

/*
 * Copyright 2012-2013 Ray Holder
 *
 * 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 com.github.rholder.moar.concurrent.thread;

/**
 * Implementations of this interface provide Thread profiling information.
 */
public interface ThreadProfiler {

    /**
     * Return the number of nanoseconds of CPU time used by the thread with the
     * given id. The difference of successive calls to this method should result
     * the CPU time used by the thread
     *
     * @param threadId id of the target thread
     */
    public long getThreadCpuTime(long threadId);

    /**
     * Return the number of nanoseconds of waiting time used by the thread with
     * the given id. The difference of successive calls to this method should
     * result in the wait time used by the thread
     *
     * @param threadId id of the target thread
     */
    public long getThreadWaitTime(long threadId);
}