You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
74 lines
3.3 KiB
JavaScript
74 lines
3.3 KiB
JavaScript
1 year ago
|
/*
|
||
|
|
* 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';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Tracks request execution for a {@link Client}.
|
||
|
|
* <p>
|
||
|
|
* A {@link RequestTracker} can be configured in the client options. The <code>Client</code> will execute
|
||
|
|
* {@link RequestTracker#onSuccess} or {@link RequestTracker#onError} for every query or batch
|
||
|
|
* executed (QUERY, EXECUTE and BATCH requests).
|
||
|
|
* </p>
|
||
|
|
* @interface
|
||
|
|
* @alias module:tracker~RequestTracker
|
||
|
|
*/
|
||
|
|
class RequestTracker {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Invoked each time a query or batch request succeeds.
|
||
|
|
* @param {Host} host The node that acted as coordinator of the request.
|
||
|
|
* @param {String|Array} query In the case of prepared or unprepared query executions, the provided
|
||
|
|
* query string. For batch requests, an Array containing the queries and parameters provided.
|
||
|
|
* @param {Array|Object|null} parameters In the case of prepared or unprepared query executions, the provided
|
||
|
|
* parameters.
|
||
|
|
* @param {ExecutionOptions} executionOptions The information related to the execution of the request.
|
||
|
|
* @param {Number} requestLength Length of the body of the request.
|
||
|
|
* @param {Number} responseLength Length of the body of the response.
|
||
|
|
* @param {Array<Number>} latency An array containing [seconds, nanoseconds] tuple, where nanoseconds is the
|
||
|
|
* remaining part of the real time that can't be represented in second precision (see <code>process.hrtime()</code>).
|
||
|
|
*/
|
||
|
|
onSuccess(host, query, parameters, executionOptions, requestLength, responseLength, latency) {
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Invoked each time a query or batch request fails.
|
||
|
|
* @param {Host} host The node that acted as coordinator of the request.
|
||
|
|
* @param {String|Array} query In the case of prepared or unprepared query executions, the provided
|
||
|
|
* query string. For batch requests, an Array containing the queries and parameters provided.
|
||
|
|
* @param {Array|Object|null} parameters In the case of prepared or unprepared query executions, the provided
|
||
|
|
* parameters.
|
||
|
|
* @param {ExecutionOptions} executionOptions The information related to the execution of the request.
|
||
|
|
* @param {Number} requestLength Length of the body of the request. When the failure occurred before the request was
|
||
|
|
* written to the wire, the length will be <code>0</code>.
|
||
|
|
* @param {Error} err The error that caused that caused the request to fail.
|
||
|
|
* @param {Array<Number>} latency An array containing [seconds, nanoseconds] tuple, where nanoseconds is the
|
||
|
|
* remaining part of the real time that can't be represented in second precision (see <code>process.hrtime()</code>).
|
||
|
|
*/
|
||
|
|
onError(host, query, parameters, executionOptions, requestLength, err, latency) {
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Invoked when the Client is being shutdown.
|
||
|
|
*/
|
||
|
|
shutdown() {
|
||
|
|
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
module.exports = RequestTracker;
|