Options
All
  • Public
  • Public/Protected
  • All
Menu

Module IO

A module containing a grab bag of support for core network I/O functionality, including sockets, TLS, DNS, logging, error handling, streams, and connection -> thread mapping.

Categories include:

  • Network: socket configuration
  • TLS: tls configuration
  • Logging: logging controls and configuration
  • IO: everything else

Index

Logging Enumerations

Network Enumerations

TLS Enumerations

IO Classes

Network Classes

TLS Classes

Logging Functions

System Functions

TLS Functions

Logging Functions

enable_logging

  • Enables logging of the native AWS CRT libraries.

    Parameters

    • level: LogLevel

      The logging level to filter to. It is not possible to log less than WARN.

      nodejs only.

    Returns void

System Functions

error_code_to_name

  • error_code_to_name(error_code: number): string
  • Convert a native error code into a human-readable identifier

    see

    CrtError

    nodejs only.

    Parameters

    • error_code: number

      An error code returned from a native API call, or delivered via callback.

    Returns string

    error name as a string

error_code_to_string

  • error_code_to_string(error_code: number): string
  • Convert a native error code into a human-readable string

    see

    CrtError

    nodejs only.

    Parameters

    • error_code: number

      An error code returned from a native API call, or delivered via callback.

    Returns string

    Long-form description of the error

TLS Functions

is_alpn_available

  • is_alpn_available(): boolean
  • Returns true if ALPN is available on this platform natively

    Returns boolean

    true if ALPN is supported natively, false otherwise

    nodejs only.

Generated using TypeDoc