/*

 * Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code 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.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package jdk.jfr.events;

import jdk.jfr.Category;

import jdk.jfr.Description;

import jdk.jfr.Label;

import jdk.jfr.DataAmount;

import jdk.jfr.Name;

import jdk.jfr.Timespan;

import jdk.jfr.internal.Type;

@Name(Type.EVENT_NAME_PREFIX + "SocketRead")

@Label("Socket Read")

@Category("Java Application")

@Description("Reading data from a socket")

public final class SocketReadEvent extends AbstractJDKEvent {

    public static final ThreadLocal<SocketReadEvent> EVENT =

        new ThreadLocal<>() {

            @Override protected SocketReadEvent initialValue() {

                return new SocketReadEvent();

            }

        };

    @Label("Remote Host")

    public String host;

    @Label("Remote Address")

    public String address;

    @Label("Remote Port")

    public int port;

    @Label("Timeout Value")

    @Timespan(Timespan.MILLISECONDS)

    public long timeout;

    @Label("Bytes Read")

    @Description("Number of bytes read from the socket")

    @DataAmount

    public long bytesRead;

    @Label("End of Stream")

    @Description("If end of stream was reached")

    public boolean endOfStream;

    public void reset() {

        host = null;

        address = null;

        port = 0;

        timeout = 0;

        bytesRead = 0L;

        endOfStream = false;

    }

}