Options
All
  • Public
  • Public/Protected
  • All
Menu

The options that can be passed to an ElkSocketConnection.

Hierarchy

  • ElkSocketConnectionOptions

Index

Properties

connectTimeout

connectTimeout: number

The default timeout when waiting to connect or disconnect.

host

host: string

The host name or ip address of the Elk M1 to connect to.

idleTimeout

idleTimeout: number

Number of milliseconds to kill a socket connection after it has been idle. We should receive an ethernet text response ("XK") every 30 seconds, so if we don't receive any responses for longer than that, likely there has been a problem.

port

port: number

The port number to connect to.

secure

secure: boolean

true to use a secure connection; false to use an insecure connection.

Optional secureOptions

secureOptions: TlsOptions

Additional options that can be overriden for secure connections. These are passed directly to the tls.connect call.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc