Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EIPSocketPool

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

CIPTypes

CIPTypes: ICIPTypes = CIPTypes

Micro800

Micro800: boolean = false

_connected

_connected: boolean = false

_connecting

_connecting: boolean = false

Optional _pool

_pool: Pool<EIPSocket>

allowHalfOpen

allowHalfOpen: boolean = true

connectTimeout

connectTimeout: number = 5000

connectionPath

connectionPath: Array<number> = [0x20, 0x02, 0x24, 0x01]

connectionPathSize

connectionPathSize: number = 3

connectionSize

connectionSize: number = 508

host

host: string = ""

knownTags

knownTags: IKnownTags

port

port: number = 44818

processorSlot

processorSlot: number = 0

Optional programNames

programNames: string[]

structIdentifier

structIdentifier: number = 4046

Optional tagList

tagList: Array<LgxTag>

timeoutReceive

timeoutReceive: number = 15000

vendorId

vendorId: number = 4919

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

available

  • get available(): number
  • description

    returns number of unused connections in the pool

    property

    Returns number

borrowed

  • get borrowed(): number
  • description

    Number of connections that are currently acquired by userland code

    property

    Returns number

max

  • get max(): number
  • description

    returns number of maxixmum number of connections allowed by pool

    property

    Returns number

min

  • get min(): number
  • description

    returns number of minimum number of connections allowed by pool

    property

    Returns number

pending

  • get pending(): number
  • description

    returns number of callers waiting to acquire a connection

    property

    Returns number

size

  • get size(): number
  • description

    returns number of connections in the pool regardless of whether they are free or in use

    property

    Returns number

spareResourceCapacity

  • get spareResourceCapacity(): number
  • description

    How many many more resources can the pool manage/create

    property

    Returns number

Methods

acquire

  • acquire(priority: number | string | function): Bluebird<any> | any
  • override
    description

    This function is for when you want to "borrow" a connection from the pool

    Parameters

    • priority: number | string | function

      if a Number return only socket if a function release socket on resolve o destroy on reject

    Returns Bluebird<any> | any

addListener

  • addListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string, listener: function): any
  • override

    Parameters

    • event: string
    • listener: function
        • (...args: []): void

        • Parameters

          • Rest ...args: []

          Returns void

    Returns any

once

  • once(event: string, listener: function): any
  • override

    Parameters

    • event: string
    • listener: function
        • (...args: []): void

        • Parameters

          • Rest ...args: []

          Returns void

    Returns any

prependListener

  • prependListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc