Class Search

Represents an M-SEARCH payload

Hierarchy

Payload
- Search

Index

Constructors

Properties

host isReply method port

Accessors

headers isAlive isByeBye isUpdate

Methods

clearHeaders deleteHeader getHeader hasHeader setHeader toBuffer toString _decode decode

Constructors

constructor

new Search(host: string, port: number): Search
Constructs a new instance of the object
Parameters
- host: string
- port: number
Returns Search
Overrides Payload.constructor

Properties

`Readonly`host

host: string

`Readonly`isReply

isReply: boolean = false

`Readonly`method

method: "reply" | "m-search" | "notify"

`Readonly`port

port: number

Accessors

`Protected`headers

get headers(): Headers
Protected
Returns the headers contained in the payload

Returns Headers
Inherited from Payload.headers
set headers(value: Headers): void
Protected
Sets the headers contained in the payload
Parameters
- value: Headers
Returns void
Inherited from Payload.headers

isAlive

get isAlive(): boolean
Returns whether this is a ssdp:alive message

Returns boolean
Inherited from Payload.isAlive

isByeBye

get isByeBye(): boolean
Returns whether this is a ssdp::byebye message

Returns boolean
Inherited from Payload.isByeBye

isUpdate

get isUpdate(): boolean
Returns whether this is as ssdp:update message

Returns boolean
Inherited from Payload.isUpdate

Methods

clearHeaders

clearHeaders(): void
Clears all the headers

Returns void
Inherited from Payload.clearHeaders

deleteHeader

deleteHeader(key: string): void
Deletes the specified header
Parameters
- key: string
Returns void
Inherited from Payload.deleteHeader

getHeader

getHeader(key: string): undefined | string
Attempts to retrieve the specified header
Parameters
- key: string
Returns undefined | string
Inherited from Payload.getHeader

hasHeader

hasHeader(key: string): boolean
Returns whether the specified header exists
Parameters
- key: string
Returns boolean
Inherited from Payload.hasHeader

setHeader

setHeader(key: string, value: string | number): void
Sets the specified header to the specified value
Parameters
- key: string
- value: string | number
Returns void
Inherited from Payload.setHeader

toBuffer

toBuffer(): Buffer
Returns a Buffer representation of the object

Returns Buffer
Inherited from Payload.toBuffer

toString

toString(): string
Returns a string representation of the instance

Returns string
Inherited from Payload.toString

`Protected` `Static`_decode

_decode(payload: string | Buffer<ArrayBufferLike>): Headers
Protected
Decodes the headers from the specified payload
Parameters
- payload: string | Buffer<ArrayBufferLike>
Returns Headers
Inherited from Payload._decode

`Static`decode

decode(
    payload: string | Buffer<ArrayBufferLike>,
    host: string,
    port: number,
): Search
Decodes a payload into an instance of the object
Parameters
- payload: string | Buffer<ArrayBufferLike>
- host: string
- port: number
Returns Search