File Explorer

1/**2 *3 * A module containing a grab bag of support for core network I/O functionality, including sockets, TLS, DNS, logging,4 * error handling, streams, and connection -> thread mapping.5 *6 * Categories include:7 * - Network: socket configuration8 * - TLS: tls configuration9 * - Logging: logging controls and configuration10 * - IO: everything else11 *12 * @packageDocumentation13 * @module io14 */15/**16 * TLS Version17 *18 * @category TLS19 */20export declare enum TlsVersion {21    SSLv3 = 0,22    TLSv1 = 1,23    TLSv1_1 = 2,24    TLSv1_2 = 3,25    TLSv1_3 = 4,26    Default = 12827}28/**29 * @category Network30 */31export declare enum SocketType {32    /**33     * A streaming socket sends reliable messages over a two-way connection.34     * This means TCP when used with {@link SocketDomain.IPV4}/{@link SocketDomain.IPV6},35     * and Unix domain sockets when used with {@link SocketDomain.LOCAL }36      */37    STREAM = 0,38    /**39     * A datagram socket is connectionless and sends unreliable messages.40     * This means UDP when used with {@link SocketDomain.IPV4}/{@link SocketDomain.IPV6}.41     * {@link SocketDomain.LOCAL} is not compatible with {@link DGRAM}42     */43    DGRAM = 144}45/**46 * @category Network47 */48export declare enum SocketDomain {49    /** IPv4 sockets */50    IPV4 = 0,51    /** IPv6 sockets */52    IPV6 = 1,53    /** UNIX domain socket/Windows named pipes */54    LOCAL = 255}56/**57 * The amount of detail that will be logged58 * @category Logging59 */60export declare enum LogLevel {61    /** No logging whatsoever. */62    NONE = 0,63    /** Only fatals. In practice, this will not do much, as the process will log and then crash (intentionally) if a fatal condition occurs */64    FATAL = 1,65    /** Only errors */66    ERROR = 2,67    /** Only warnings and errors */68    WARN = 3,69    /** Information about connection/stream creation/destruction events */70    INFO = 4,71    /** Enough information to debug the chain of events a given network connection encounters */72    DEBUG = 5,73    /** Everything. Only use this if you really need to know EVERY single call */74    TRACE = 675}76/**77 * Sets the amount of detail that will be logged78 * @param level - maximum level of logging detail.  Log invocations at a higher level of detail will be ignored.79 *80 * @category Logging81 */82export declare function setLogLevel(level: LogLevel): void;83export declare function logFatal(subject: string, logLine: string): void;84export declare function logError(subject: string, logLine: string): void;85export declare function logWarn(subject: string, logLine: string): void;86export declare function logInfo(subject: string, logLine: string): void;87export declare function logDebug(subject: string, logLine: string): void;88export declare function logTrace(subject: string, logLine: string): void;89