com.caucho.management.server.TcpConnectionMXBean Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 1998-2018 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package com.caucho.management.server;

import com.caucho.jmx.Description;
import com.caucho.jmx.Units;

/**
 * Represents a tcp-connection
 *
 *  * resin:type=TcpConnection,name=foo.com-80-237
 *  */
@Description("A TCP connection")
public interface TcpConnectionMXBean extends ManagedObjectMXBean {
  //
  // State
  //
  
  /**
   * Returns the thread-id.  Management applications will use the
   * thread-id in conjunction with the JDK's ThreadMXBean to get more
   * Thread information.
   */
  @Description("The connections thread id.  If no thread is attached, returns -1")
  public long getThreadId();

  /**
   * Returns the connection state.
   */
  @Description("The current lifecycle state")
  public String getState();

  /**
   * Returns the current url being processed
   */
  @Description("The current url")
  public String getUrl();

  /**
   * Returns the remote address of the connection
   */
  @Description("The current remote client")
  public String getRemoteAddress();

  //
  // Statistics
  //

  /**
   * Returns the connection state.
   */
  @Description("The user display state")
  public String getDisplayState();

  /**
   * Returns the time this request has spent in the active state.
   */
  @Units("milliseconds")
  @Description("The current time in milliseconds that the connection has been active for the request it is servicing")
  public long getRequestActiveTime();
}