Class Advertiser

Readonlyuuid

services

• get services(): [string, Headers][]

  The advertiser's currently active services

  Returns [string, Headers][]

announce

• announce(service: string, headers: HeadersInit): void

  Adds the service to the advertiser

  Parameters

  • service: string
  • headers: HeadersInit

  Returns void

announceNow

• announceNow(): void

  Immediately sends NOTIFY messages for all services

  Returns void

destroy

• destroy(): void

  Destroys the instance

  Returns void

off

• off(
      event: "search",
      listener: (
          target: string,
          payload: Search,
          remote: RemoteInfo,
          local: AddressInfo,
      ) => void,
  ): this

  Emitted when we receive an M-SEARCH message that we will handle

  Parameters

  • event: "search"
  • listener: (
        target: string,
        payload: Search,
        remote: RemoteInfo,
        local: AddressInfo,
    ) => void

  Returns this

• off(event: "error", listener: (error: Error) => void): this

  Emitted when we encounter an error

  Parameters

  • event: "error"
  • listener: (error: Error) => void

  Returns this

on

• on(
      event: "search",
      listener: (
          target: string,
          payload: Search,
          remote: RemoteInfo,
          local: AddressInfo,
      ) => void,
  ): this

  Emitted when we receive an M-SEARCH message that we will handle

  Parameters

  • event: "search"
  • listener: (
        target: string,
        payload: Search,
        remote: RemoteInfo,
        local: AddressInfo,
    ) => void

  Returns this

• on(event: "error", listener: (error: Error) => void): this

  Emitted when we encounter an error

  Parameters

  • event: "error"
  • listener: (error: Error) => void

  Returns this

once

• once(
      event: "search",
      listener: (
          target: string,
          payload: Search,
          remote: RemoteInfo,
          local: AddressInfo,
      ) => void,
  ): this

  Emitted when we receive an M-SEARCH message that we will handle

  Parameters

  • event: "search"
  • listener: (
        target: string,
        payload: Search,
        remote: RemoteInfo,
        local: AddressInfo,
    ) => void

  Returns this

• once(event: "error", listener: (error: Error) => void): this

  Emitted when we encounter an error

  Parameters

  • event: "error"
  • listener: (error: Error) => void

  Returns this

withdraw

• withdraw(service: string): boolean

  Withdraws the service from the advertiser

  Parameters

  • service: string

  Returns boolean

Staticcreate

• create(options?: Partial<Advertiser.Options>): Promise<Advertiser>

  Constructs a new instance of a SSDP advertiser

  Parameters

  • options: Partial<Advertiser.Options> = {}

  Returns Promise<Advertiser>