Class HAPConnection

Manages a single iOS-initiated HTTP connection during its lifetime.

Hierarchy

EventEmitter
- HAPConnection

Constructors

constructor

new HAPConnection(server: EventedHTTPServer, clientSocket: Socket): HAPConnection
Parameters
- server: EventedHTTPServer
- clientSocket: Socket
Returns HAPConnection
- Defined in lib/util/eventedhttp.ts:382

Properties

`Optional` _pairSetupState

_pairSetupState?: number

`Optional` _pairVerifyState

_pairVerifyState?: number

`Optional` encryption

encryption?: HAPEncryption

lastSocketOperation

lastSocketOperation: number = ...

`Readonly` localAddress

localAddress: string

`Readonly` networkInterface

networkInterface: string

`Readonly` remoteAddress

remoteAddress: string

`Readonly` remotePort

remotePort: number

`Readonly` sessionID

sessionID: string

`Optional` srpServer

srpServer?: SrpServer

`Optional` timedWritePid

timedWritePid?: number

`Optional` timedWriteTimeout

timedWriteTimeout?: Timeout

`Optional` username

username?: string

Methods

addListener

addListener(event: string | symbol, listener: ((...args: any[]) => void)): HAPConnection
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns HAPConnection
- Defined in lib/util/eventedhttp.ts:432

clearRegisteredEvents

clearRegisteredEvents(): void
Returns void
- Defined in lib/util/eventedhttp.ts:629

close

close(): void
Returns void
- Defined in lib/util/eventedhttp.ts:472

closeConnectionAsOfUnpair

closeConnectionAsOfUnpair(initiator: HAPConnection): void
Parameters
- initiator: HAPConnection
Returns void
- Defined in lib/util/eventedhttp.ts:481

connectionAuthenticated

connectionAuthenticated(username: string): void
This method is called once the connection has gone through pair-verify. As any HomeKit controller will initiate a pair-verify after the pair-setup procedure, this method gets not called on the initial pair-setup.

Once this method has been called, the connection is authenticated and encryption is turned on.
Parameters
- username: string
Returns void
- Defined in lib/util/eventedhttp.ts:461

disableEventNotifications

disableEventNotifications(aid: number, iid: number): void
Parameters
- aid: number
- iid: number
Returns void
- Defined in lib/util/eventedhttp.ts:617

emit

emit(event: "request", request: IncomingMessage, response: ServerResponse): boolean
Parameters
- event: "request"
- request: IncomingMessage
- response: ServerResponse
Returns boolean
- Defined in lib/util/eventedhttp.ts:332
emit(event: "authenticated", username: string): boolean
Parameters
- event: "authenticated"
- username: string
Returns boolean
- Defined in lib/util/eventedhttp.ts:333
emit(event: "closed"): boolean
Parameters
- event: "closed"
Returns boolean
- Defined in lib/util/eventedhttp.ts:334

enableEventNotifications

enableEventNotifications(aid: number, iid: number): void
Parameters
- aid: number
- iid: number
Returns void
- Defined in lib/util/eventedhttp.ts:613

getLocalAddress

getLocalAddress(ipVersion: "ipv4" | "ipv6"): string
Parameters
- ipVersion: "ipv4" | "ipv6"
Returns string
- Defined in lib/util/eventedhttp.ts:805

getRegisteredEvents

getRegisteredEvents(): Set<string>
Returns Set<string>
- Defined in lib/util/eventedhttp.ts:625

hasEventNotifications

hasEventNotifications(aid: number, iid: number): boolean
Parameters
- aid: number
- iid: number
Returns boolean
- Defined in lib/util/eventedhttp.ts:621

isAuthenticated

isAuthenticated(): boolean
Returns boolean
- Defined in lib/util/eventedhttp.ts:468

off

off(event: string | symbol, listener: ((...args: any[]) => void)): HAPConnection
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns HAPConnection
- Defined in lib/util/eventedhttp.ts:447

on

on(event: "request", listener: ((request: IncomingMessage, response: ServerResponse) => void)): HAPConnection
Parameters
- event: "request"
- listener: ((request: IncomingMessage, response: ServerResponse) => void)
  - - (request: IncomingMessage, response: ServerResponse): void
    - Parameters
      
      request: IncomingMessage
      
      response: ServerResponse
      
      Returns void
Returns HAPConnection
- Defined in lib/util/eventedhttp.ts:328
on(event: "authenticated", listener: ((username: string) => void)): HAPConnection
Parameters
- event: "authenticated"
- listener: ((username: string) => void)
  - - (username: string): void
    - Parameters
      
      username: string
      
      Returns void
Returns HAPConnection
- Defined in lib/util/eventedhttp.ts:329
on(event: "closed", listener: (() => void)): HAPConnection
Parameters
- event: "closed"
- listener: (() => void)
  - - (): void
    - Returns void
Returns HAPConnection
- Defined in lib/util/eventedhttp.ts:330
on(event: string | symbol, listener: ((...args: any[]) => void)): HAPConnection
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns HAPConnection
- Defined in lib/util/eventedhttp.ts:425

removeListener

removeListener(event: string | symbol, listener: ((...args: any[]) => void)): HAPConnection
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns HAPConnection
- Defined in lib/util/eventedhttp.ts:439

sendEvent

sendEvent(aid: number, iid: number, value: Nullable<CharacteristicValue>, immediateDelivery?: boolean): void
Parameters
- aid: number
- iid: number
- value: Nullable<CharacteristicValue>
- Optional immediateDelivery: boolean
Returns void
- Defined in lib/util/eventedhttp.ts:492

Class HAPConnection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

server: EventedHTTPServer

clientSocket: Socket

Returns HAPConnection

Properties

Optional _pairSetupState

Optional _pairVerifyState

Optional encryption

lastSocketOperation

Readonly localAddress

Readonly networkInterface

Readonly remoteAddress

Readonly remotePort

Readonly sessionID

Optional srpServer

Optional timedWritePid

Optional timedWriteTimeout

Optional username

Methods

addListener

Parameters

event: string | symbol

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns HAPConnection

clearRegisteredEvents

Returns void

close

Returns void

closeConnectionAsOfUnpair

Parameters

initiator: HAPConnection

Returns void

connectionAuthenticated

Parameters

username: string

Returns void

disableEventNotifications

Parameters

aid: number

iid: number

Returns void

emit

Parameters

event: "request"

request: IncomingMessage

response: ServerResponse

Returns boolean

Parameters

event: "authenticated"

username: string

Returns boolean

Parameters

event: "closed"

Returns boolean

enableEventNotifications

Parameters

aid: number

iid: number

Returns void

getLocalAddress

Parameters

ipVersion: "ipv4" | "ipv6"

Returns string

getRegisteredEvents

Returns Set<string>

hasEventNotifications

Parameters

aid: number

iid: number

`Optional` _pairSetupState

`Optional` _pairVerifyState

`Optional` encryption

`Readonly` localAddress

`Readonly` networkInterface

`Readonly` remoteAddress

`Readonly` remotePort

`Readonly` sessionID

`Optional` srpServer

`Optional` timedWritePid

`Optional` timedWriteTimeout

`Optional` username

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` immediateDelivery: boolean