Class DataStreamServer

constructor

• new DataStreamServer(): DataStreamServer

  Returns DataStreamServer

preparedSessions

Static Readonlyversion

destroy

• destroy(): void

  This method will fully stop the DataStreamServer

  Returns void

emit

• emit(event: "connection-opened", connection: DataStreamConnection): boolean

  Parameters

  • event: "connection-opened"
  • connection: DataStreamConnection

  Returns boolean

• emit(event: "connection-closed", connection: DataStreamConnection): boolean

  Parameters

  • event: "connection-closed"
  • connection: DataStreamConnection

  Returns boolean

on

• on(
      event: "connection-opened",
      listener: (connection: DataStreamConnection) => void,
  ): this

  Parameters

  • event: "connection-opened"
  • listener: (connection: DataStreamConnection) => void

  Returns this

• on(
      event: "connection-closed",
      listener: (connection: DataStreamConnection) => void,
  ): this

  Parameters

  • event: "connection-closed"
  • listener: (connection: DataStreamConnection) => void

  Returns this

onEventMessage

• onEventMessage(
      protocol: string,
      event: string,
      handler: GlobalEventHandler,
  ): this

  Registers a new event handler to handle incoming event messages. The handler is only called for a connection if for the give protocol no ProtocolHandler was registered on the connection level.

  Parameters

  • protocol: string

    name of the protocol to register the handler for
  • event: string

    name of the event (also referred to as topic. See Topics for some known ones)
  • handler: GlobalEventHandler

    function to be called for every occurring event

  Returns this

onRequestMessage

• onRequestMessage(
      protocol: string,
      request: string,
      handler: GlobalRequestHandler,
  ): this

  Registers a new request handler to handle incoming request messages. The handler is only called for a connection if for the give protocol no ProtocolHandler was registered on the connection level.

  Parameters

  • protocol: string

    name of the protocol to register the handler for
  • request: string

    name of the request (also referred to as topic. See Topics for some known ones)
  • handler: GlobalRequestHandler

    function to be called for every occurring request

  Returns this

prepareSession

• prepareSession(
      connection: HAPConnection,
      controllerKeySalt: Buffer,
      callback: PrepareSessionCallback,
  ): void

  Parameters

  • connection: HAPConnection
  • controllerKeySalt: Buffer
  • callback: PrepareSessionCallback

  Returns void

removeEventHandler

• removeEventHandler(
      protocol: string,
      event: string,
      handler: GlobalEventHandler,
  ): this

  Removes a registered event handler.

  Parameters

  • protocol: string

    name of the protocol to unregister the handler for
  • event: string

    name of the event (also referred to as topic. See Topics for some known ones)
  • handler: GlobalEventHandler

    registered event handler

  Returns this

removeRequestHandler

• removeRequestHandler(
      protocol: string,
      request: string,
      handler: GlobalRequestHandler,
  ): this

  Removes a registered request handler.

  Parameters

  • protocol: string

    name of the protocol to unregister the handler for
  • request: string

    name of the request (also referred to as topic. See Topics for some known ones)
  • handler: GlobalRequestHandler

    registered request handler

  Returns this