Node JS version

node_modules/cassandra-driver/lib/metrics/client-metrics.js

@@ -0,0 +1,129 @@
+/*
+ * 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.
+ */
+
+'use strict';
+
+/**
+ * Represents a base class that is used to measure events from the server and the client as seen by the driver.
+ * @alias module:metrics~ClientMetrics
+ * @interface
+ */
+class ClientMetrics {
+  /**
+   * Method invoked when an authentication error is obtained from the server.
+   * @param {AuthenticationError|Error} e The error encountered.
+   */
+  onAuthenticationError(e) {}
+
+  /**
+   * Method invoked when an error (different than a server or client timeout, authentication or connection error) is
+   * encountered when executing a request.
+   * @param {OperationTimedOutError} e The timeout error.
+   */
+  onClientTimeoutError(e) {}
+
+  /**
+   * Method invoked when there is a connection error.
+   * @param {Error} e The error encountered.
+   */
+  onConnectionError(e) {}
+
+  /**
+   * Method invoked when an error (different than a server or client timeout, authentication or connection error) is
+   * encountered when executing a request.
+   * @param {Error} e The error encountered.
+   */
+  onOtherError(e) {}
+
+  /**
+   * Method invoked when a read timeout error is obtained from the server.
+   * @param {ResponseError} e The error encountered.
+   */
+  onReadTimeoutError(e) {}
+
+  /**
+   * Method invoked when a write timeout error is obtained from the server.
+   * @param {ResponseError} e The error encountered.
+   */
+  onWriteTimeoutError(e) {}
+
+  /**
+   * Method invoked when an unavailable error is obtained from the server.
+   * @param {ResponseError} e The error encountered.
+   */
+  onUnavailableError(e) {}
+
+  /**
+   * Method invoked when an execution is retried as a result of a client-level timeout.
+   * @param {Error} e The error that caused the retry.
+   */
+  onClientTimeoutRetry(e) {}
+
+  /**
+   * Method invoked when an error (other than a server or client timeout) is retried.
+   * @param {Error} e The error that caused the retry.
+   */
+  onOtherErrorRetry(e) {}
+
+  /**
+   * Method invoked when an execution is retried as a result of a read timeout from the server (coordinator to replica).
+   * @param {Error} e The error that caused the retry.
+   */
+  onReadTimeoutRetry(e) {}
+
+  /**
+   * Method invoked when an execution is retried as a result of an unavailable error from the server.
+   * @param {Error} e The error that caused the retry.
+   */
+  onUnavailableRetry(e) {}
+
+  /**
+   * Method invoked when an execution is retried as a result of a write timeout from the server (coordinator to
+   * replica).
+   * @param {Error} e The error that caused the retry.
+   */
+  onWriteTimeoutRetry(e) {}
+
+  /**
+   * Method invoked when an error is marked as ignored by the retry policy.
+   * @param {Error} e The error that was ignored by the retry policy.
+   */
+  onIgnoreError(e) {}
+
+  /**
+   * Method invoked when a speculative execution is started.
+   */
+  onSpeculativeExecution() {}
+
+  /**
+   * Method invoked when a response is obtained successfully.
+   * @param {Array<Number>} latency The latency represented in a <code>[seconds, nanoseconds]</code> tuple
+   * Array, where nanoseconds is the remaining part of the real time that can't be represented in second precision.
+   */
+  onSuccessfulResponse(latency) {}
+
+  /**
+   * Method invoked when any response is obtained, the response can be the result of a successful execution or a
+   * server-side error.
+   * @param {Array<Number>} latency The latency represented in a <code>[seconds, nanoseconds]</code> tuple
+   * Array, where nanoseconds is the remaining part of the real time that can't be represented in second precision.
+   */
+  onResponse(latency) {
+
+  }
+}
+
+module.exports = ClientMetrics;