com.google.cloud.hadoop.fs.gcs.GhfsInputStreamStatistics Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gcs-connector Show documentation

An implementation of org.apache.hadoop.fs.FileSystem targeting Google Cloud Storage

There is a newer version: 3.1.3

/*
 * Copyright 2021 Google LLC
 *
 * 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.google.cloud.hadoop.fs.gcs;

/**
 * Statistics updated by a {@link GoogleHadoopFSInputStream} during its use. It also contains
 * getters for tests.
 */
interface GhfsInputStreamStatistics extends AutoCloseable, GhfsStatisticInterface {

  /**
   * Seek backwards, incrementing the seek and backward seek counters.
   *
   * @param negativeOffset how far was the seek? This is expected to be negative.
   */
  void seekBackwards(long negativeOffset);

  /**
   * Record a forward seek, adding a seek operation, a forward seek operation.
   *
   * @param skipped bytes moved forward in stream If the seek was implemented by a close + reopen,
   *     set this to zero.
   */
  void seekForwards(long skipped);

  /** An ignored stream read exception was received. */
  void readException();

  /**
   * Increment the bytes read counter by the number of bytes; no-op if the argument is negative.
   *
   * @param bytes number of bytes read
   */
  void bytesRead(long bytes);

  /**
   * A read operation has completed.
   *
   * @param requested number of requested bytes
   * @param actual the actual number of bytes
   */
  void readOperationCompleted(int requested, int actual);

  /** Return the aggregated bytesBread across multiple read and readVectoredOperation */
  long getBytesRead();

  @Override
  void close();
}