Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChristiePort

Class for communicating over TCP/IP with Christie projectors.

example
const port = new ChristiePort();
port.connect('127.0.0.1', 9999);
// Do stuff
port.close();

Hierarchy

  • ChristiePort

Implements

  • any

Index

Constructors

constructor

Properties

Private buffer

buffer: string

Private callbacks

callbacks: {}

Type declaration

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

Private emitter

emitter: EventEmitter

Private ip

ip: string | undefined

Private port

port: number | undefined

Private sock

sock: Socket

Methods

close

  • close(): void

connect

  • connect(ip: string, port: number): Promise<void>
  • Initiates the connection.

    Parameters

    • ip: string

      The destination IP address

    • port: number

      The destination port

    Returns Promise<void>

Private flushCallbacks

  • flushCallbacks(): void

receive

send

  • send(what: string): Promise<void>

sink

  • sink(event: "data" | "async" | "executed" | "rejected" | "error", once: boolean, callback: (...args: any[]) => void): void
  • Registers a listener to events.

    Parameters

    • event: "data" | "async" | "executed" | "rejected" | "error"

      The event for which to register the callback.

    • once: boolean

      Specify whether or not the callback is only called once.

    • callback: (...args: any[]) => void

      Function to be called when event is triggered.

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

unsink

  • unsink(event: "data" | "async" | "executed" | "rejected" | "error", callback: (...args: any[]) => void): void
  • Unregisters a listener.

    Parameters

    • event: "data" | "async" | "executed" | "rejected" | "error"

      The event for which to remove the listener.

    • callback: (...args: any[]) => void

      The listener to be removed.

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

unsinkAll

  • unsinkAll(event?: "data" | "async" | "executed" | "rejected" | "error"): void
  • Removes all listeners.

    Parameters

    • Optional event: "data" | "async" | "executed" | "rejected" | "error"

    Returns void

Generated using TypeDoc