@webex/plugin-meetings 3.7.0 → 3.8.0

package/dist/reachability/index.d.ts

@@ -0,0 +1,105 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+import ReachabilityRequest from './request';
+import { ClusterReachability, ClusterReachabilityResult } from './clusterReachability';
+export type ReachabilityMetrics = {
+    reachability_public_udp_success: number;
+    reachability_public_udp_failed: number;
+    reachability_public_tcp_success: number;
+    reachability_public_tcp_failed: number;
+    reachability_vmn_udp_success: number;
+    reachability_vmn_udp_failed: number;
+    reachability_vmn_tcp_success: number;
+    reachability_vmn_tcp_failed: number;
+};
+/**
+ * This is the type that matches what backend expects us to send to them. It is a bit weird, because
+ * it uses strings instead of booleans and numbers, but that's what they require.
+ */
+export type TransportResultForBackend = {
+    reachable?: 'true' | 'false';
+    latencyInMilliseconds?: string;
+    clientMediaIPs?: string[];
+    untested?: 'true';
+};
+export type ReachabilityResultForBackend = {
+    udp: TransportResultForBackend;
+    tcp: TransportResultForBackend;
+    xtls: TransportResultForBackend;
+};
+export type ReachabilityResultsForBackend = Record<string, ReachabilityResultForBackend>;
+export type ReachabilityResults = Record<string, ClusterReachabilityResult & {
+    isVideoMesh?: boolean;
+}>;
+/**
+ * @class Reachability
+ * @export
+ */
+export default class Reachability {
+    namespace: string;
+    webex: object;
+    reachabilityRequest: ReachabilityRequest;
+    clusterReachability: {
+        [key: string]: ClusterReachability;
+    };
+    /**
+     * Creates an instance of Reachability.
+     * @param {object} webex
+     * @memberof Reachability
+     */
+    constructor(webex: object);
+    /**
+     * Gets a list of media clusters from the backend and performs reachability checks on all the clusters
+     * @returns {Promise<ReachabilityResults>} reachability results
+     * @public
+     * @memberof Reachability
+     */
+    gatherReachability(): Promise<ReachabilityResults>;
+    /**
+     * Returns statistics about last reachability results. The returned value is an object
+     * with a flat list of properties so that it can be easily sent with metrics
+     *
+     * @returns {Promise} Promise with metrics values, it never rejects/throws.
+     */
+    getReachabilityMetrics(): Promise<ReachabilityMetrics>;
+    /**
+     * Maps our internal transport result to the format that backend expects
+     * @param {TransportResult} transportResult
+     * @returns {TransportResultForBackend}
+     */
+    private mapTransportResultToBackendDataFormat;
+    /**
+     * Reachability results as an object in the format that backend expects
+     *
+     * @returns {any} reachability results that need to be sent to the backend
+     */
+    getReachabilityResults(): Promise<ReachabilityResultsForBackend | undefined>;
+    /**
+     * fetches reachability data and checks for cluster reachability
+     * @returns {boolean}
+     * @public
+     * @memberof Reachability
+     */
+    isAnyPublicClusterReachable(): Promise<boolean>;
+    /**
+     * Get list of all unreachable clusters
+     * @returns {array} Unreachable clusters
+     * @private
+     * @memberof Reachability
+     */
+    private getUnreachableClusters;
+    /**
+     * Make a log of unreachable clusters.
+     * @returns {undefined}
+     * @private
+     * @memberof Reachability
+     */
+    private logUnreachableClusters;
+    /**
+     * Performs reachability checks for all clusters
+     * @param {ClusterList} clusterList
+     * @returns {Promise<ReachabilityResults>} reachability check results
+     */
+    private performReachabilityChecks;
+}