1 /*
   2  * Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package jdk.jfr.events;
  27 
  28 import jdk.jfr.Category;
  29 import jdk.jfr.Description;
  30 import jdk.jfr.Label;
  31 import jdk.jfr.DataAmount;
  32 import jdk.jfr.Name;
  33 import jdk.jfr.Timespan;
  34 
  35 @Name("com.oracle.jdk.SocketRead")
  36 @Label("Socket Read")
  37 @Category("Java Application")
  38 @Description("Reading data from a socket")
  39 public final class SocketReadEvent extends AbstractJDKEvent {
  40 
  41     public static final ThreadLocal<SocketReadEvent> EVENT =
  42         new ThreadLocal<>() {
  43             @Override protected SocketReadEvent initialValue() {
  44                 return new SocketReadEvent();
  45             }
  46         };
  47 
  48     @Label("Remote Host")
  49     public String host;
  50 
  51     @Label("Remote Address")
  52     public String address;
  53 
  54     @Label("Remote Port")
  55     public int port;
  56 
  57     @Label("Timeout Value")
  58     @Timespan(Timespan.MILLISECONDS)
  59     public long timeout;
  60 
  61     @Label("Bytes Read")
  62     @Description("Number of bytes read from the socket")
  63     @DataAmount
  64     public long bytesRead;
  65 
  66     @Label("End of Stream")
  67     @Description("If end of stream was reached")
  68     public boolean endOfStream;
  69 
  70     public void reset() {
  71         host = null;
  72         address = null;
  73         port = 0;
  74         timeout = 0;
  75         bytesRead = 0L;
  76         endOfStream = false;
  77     }
  78 }