/*
 * Copyright DataStax, Inc.
 *
 * 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.datastax.oss.driver.api.core.cql;

import edu.umd.cs.findbugs.annotations.Nullable;
import java.net.InetAddress;
import java.net.InetSocketAddress;

An event in a QueryTrace. /** An event in a {@link QueryTrace}. */
public interface TraceEvent {

  
Which activity this event corresponds to. /** Which activity this event corresponds to. */
  @Nullable
  String getActivity();

  
The server-side timestamp of the event. /** The server-side timestamp of the event. */
  long getTimestamp();

  
Deprecated:
returns the source IP, but getSourceAddress() should be preferred, since C* 4.0 and above now returns the port was well./**
   * @deprecated returns the source IP, but {@link #getSourceAddress()} should be preferred, since
   *     C* 4.0 and above now returns the port was well.
   */
  @Nullable
  @Deprecated
  InetAddress getSource();

  
The IP and Port of the host having generated this event. Prior to C* 4.0 the port will be set
to zero.
This method's default implementation returns getSource() with the port set to 0. The only reason it exists is to preserve binary compatibility. Internally, the driver overrides it to set the correct port. 
Since:
4.6.0/**
   * The IP and Port of the host having generated this event. Prior to C* 4.0 the port will be set
   * to zero.
   *
   * <p>This method's default implementation returns {@link #getSource()} with the port set to 0.
   * The only reason it exists is to preserve binary compatibility. Internally, the driver overrides
   * it to set the correct port.
   *
   * @since 4.6.0
   */
  @Nullable
  default InetSocketAddress getSourceAddress() {
    return new InetSocketAddress(getSource(), 0);
  }
  
The number of microseconds elapsed on the source when this event occurred since the moment when
the source started handling the query.
/**
   * The number of microseconds elapsed on the source when this event occurred since the moment when
   * the source started handling the query.
   */
  int getSourceElapsedMicros();

  
The name of the thread on which this event occurred. /** The name of the thread on which this event occurred. */
  @Nullable
  String getThreadName();
}