Class HMessage

Hierarchy

HMessage

Index

Constructors

Accessors

Methods

equals getDestination getIndex getPacket isCorrupted stringify

Constructors

constructor

new HMessage(fromString): HMessage
Parameters
- fromString: string | String
Returns HMessage
- Defined in lib/protocol/hmessage.d.ts:5
new HMessage(message): HMessage
Parameters
- message: HMessage
Returns HMessage
- Defined in lib/protocol/hmessage.d.ts:6
new HMessage(packet, direction, index): HMessage
Parameters
- packet: HPacket
- direction: HDirection
- index: number
Returns HMessage
- Defined in lib/protocol/hmessage.d.ts:7

Accessors

blocked

get blocked(): boolean
Get the private parameter #isBlocked

Returns boolean
- Defined in lib/protocol/hmessage.d.ts:23
set blocked(val): void
Change the private parameter #isBlocked
Parameters
- val: boolean
  
  Boolean value to be set to private parameter #isBlocked
Returns void
- Defined in lib/protocol/hmessage.d.ts:18

Methods

equals

equals(message): boolean
Compare other hMessage to hMessage (compares packet, direction and index)
Parameters
- message: HMessage
  
  hMessage to compare with current hMessage
Returns boolean
- Defined in lib/protocol/hmessage.d.ts:49

getDestination

getDestination(): HDirection
Get the private parameter #direction

Returns HDirection
- Defined in lib/protocol/hmessage.d.ts:33

getIndex

getIndex(): number
Get the private parameter #index

Returns number
- Defined in lib/protocol/hmessage.d.ts:12

getPacket

getPacket(): HPacket
Get the private parameter #hPacket

Returns HPacket
- Defined in lib/protocol/hmessage.d.ts:28

isCorrupted

isCorrupted(): boolean
Returns whether private #hPacket is corrupted

Returns boolean
- Defined in lib/protocol/hmessage.d.ts:38

stringify

stringify(): string
Convert the message to a string

Returns string
- Defined in lib/protocol/hmessage.d.ts:43

Generated using TypeDoc