node-rsyslog
Options
All
  • Public
  • Public/Protected
  • All
Menu

A rsyslog client. Sends over UDP.

Hierarchy

  • EventEmitter
    • RSyslog

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private options

options: RSyslogOptions

Private pending

pending: Buffer[]

Private running

running: boolean

Private Optional tpcSocket

tpcSocket: net.Socket

Private Optional udpSocket

udpSocket: dgram.Socket

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: keyof symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Private connectTCP

  • connectTCP(): Promise<Socket>

  • Create an open a socket, if necessary. Either way, return it.

    Returns Promise<Socket>

Private connectUDP

  • connectUDP(): Promise<Socket>

  • Create an open a socket, if necessary. Either way, return it.

    Returns Promise<Socket>

Private continue

  • continue(): void

  • Continue sending if there are more packets, else stop.

    Returns void

disconnect

  • disconnect(): void

  • Close the socket, if it's still open.

    Returns void

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

Private handleSendResult

  • handleSendResult(err?: Error | null, bytes?: undefined | number): void

  • Handle send results. On errors, report them upstream. That could be ignored, result in our destruction and re-creation, or result in the process crashing. So, we keep sending anyway, as we're the only object with a reference to the unsent messages.

    Parameters

    • Optional err: Error | null
    • Optional bytes: undefined | number

    Returns void

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: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Private queueMessage

  • queueMessage(buf: Buffer): void

  • Queue another buffer to be sent.

    Parameters

    • buf: Buffer

    Returns void

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: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

send

Private sendNextMessage

  • sendNextMessage(): Promise<void>

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

Private socketClose

  • socketClose(): void

Private socketError

  • socketError(err: Error): void

  • Propagate the socket's error event.

    Parameters

    • err: Error

    Returns void

Private start

  • start(): void

Private stop

  • stop(): void

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Legend

  • Constructor
  • Method
  • Private property
  • Private method
  • Inherited method

Generated using TypeDoc