File Explorer

1/*2 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.3 * SPDX-License-Identifier: Apache-2.0.4 */5 6/**7 *8 * A module containing a grab bag of support for core network I/O functionality, including sockets, TLS, DNS, logging,9 * error handling, streams, and connection -> thread mapping.10 *11 * Categories include:12 * - Network: socket configuration13 * - TLS: tls configuration14 * - Logging: logging controls and configuration15 * - IO: everything else16 *17 * @packageDocumentation18 * @module io19 */20 21/**22 * TLS Version23 *24 * @category TLS25 */26export enum TlsVersion {27    SSLv3 = 0,28    TLSv1 = 1,29    TLSv1_1 = 2,30    TLSv1_2 = 3,31    TLSv1_3 = 4,32    Default = 128,33}34 35/**36 * @category Network37 */38export enum SocketType {39    /**40     * A streaming socket sends reliable messages over a two-way connection.41     * This means TCP when used with {@link SocketDomain.IPV4}/{@link SocketDomain.IPV6},42     * and Unix domain sockets when used with {@link SocketDomain.LOCAL }43      */44    STREAM = 0,45    /**46     * A datagram socket is connectionless and sends unreliable messages.47     * This means UDP when used with {@link SocketDomain.IPV4}/{@link SocketDomain.IPV6}.48     * {@link SocketDomain.LOCAL} is not compatible with {@link DGRAM}49     */50    DGRAM = 1,51}52 53/**54 * @category Network55 */56export enum SocketDomain {57    /** IPv4 sockets */58    IPV4 = 0,59 60    /** IPv6 sockets */61    IPV6 = 1,62 63    /** UNIX domain socket/Windows named pipes */64    LOCAL = 2,65}66 67/**68 * The amount of detail that will be logged69 * @category Logging70 */71export enum LogLevel {72    /** No logging whatsoever. */73    NONE = 0,74    /** Only fatals. In practice, this will not do much, as the process will log and then crash (intentionally) if a fatal condition occurs */75    FATAL = 1,76    /** Only errors */77    ERROR = 2,78    /** Only warnings and errors */79    WARN = 3,80    /** Information about connection/stream creation/destruction events */81    INFO = 4,82    /** Enough information to debug the chain of events a given network connection encounters */83    DEBUG = 5,84    /** Everything. Only use this if you really need to know EVERY single call */85    TRACE = 686}87 88let logLevel : LogLevel = LogLevel.NONE;89 90/**91 * Sets the amount of detail that will be logged92 * @param level - maximum level of logging detail.  Log invocations at a higher level of detail will be ignored.93 *94 * @category Logging95 */96export function setLogLevel(level: LogLevel) {97    logLevel = level;98}99 100/*101 * The logging API is exported to library-internal, but stays private beyond the package boundary, so the following API102 * decisions are not binding.103 */104 105export function logFatal(subject: string, logLine: string) {106    if (logLevel < LogLevel.FATAL) {107        return;108    }109 110    let currentTime = new Date().toISOString();111    console.log(`[FATAL] [${currentTime}] [${subject}] - ${logLine}`);112}113 114export function logError(subject: string, logLine: string) {115    if (logLevel < LogLevel.ERROR) {116        return;117    }118 119    let currentTime = new Date().toISOString();120    console.log(`[ERROR] [${currentTime}] [${subject}] - ${logLine}`);121}122 123export function logWarn(subject: string, logLine: string) {124    if (logLevel < LogLevel.WARN) {125        return;126    }127 128    let currentTime = new Date().toISOString();129    console.log(`[WARN] [${currentTime}] [${subject}] - ${logLine}`);130}131 132export function logInfo(subject: string, logLine: string) {133    if (logLevel < LogLevel.INFO) {134        return;135    }136 137    let currentTime = new Date().toISOString();138    console.log(`[INFO] [${currentTime}] [${subject}] - ${logLine}`);139}140 141export function logDebug(subject: string, logLine: string) {142    if (logLevel < LogLevel.DEBUG) {143        return;144    }145 146    let currentTime = new Date().toISOString();147    console.log(`[DEBUG] [${currentTime}] [${subject}] - ${logLine}`);148}149 150export function logTrace(subject: string, logLine: string) {151    if (logLevel < LogLevel.TRACE) {152        return;153    }154 155    let currentTime = new Date().toISOString();156    console.log(`[TRACE] [${currentTime}] [${subject}] - ${logLine}`);157}