Home Reference Source Test
public class | source

SignalMessage

Extends:

Message → SignalMessage

Static Method Summary

Static Public Methods
public static

Constructor Summary

Public Constructor
public

constructor(senderId: PeerId, recipientId: PeerId, nonce: number, ttl: number, flags: SignalMessage.Flags | number, payload: Uint8Array, senderPubKey: PublicKey, signature: Signature)

Member Summary

Public Members
public get

flags: SignalMessage.Flags | number

public get

nonce: number

public get

payload: Uint8Array

public get
public get
public get
public get

serializedSize: number

public get
public get

ttl: number

Method Summary

Public Methods
public

hasPayload(): boolean

public

isTtlExceeded(): boolean

public

isUnroutable(): boolean

public
public

toString(): string

public

verifySignature(): boolean

Inherited Summary

From class Message
public static

peekLength(buf: SerialBuffer): number

public static

peekType(buf: SerialBuffer): Message.Type

public static
public get

serializedSize: number

public get

type: Message.Type

public
public

toString(): string

protected

Static Public Methods

public static unserialize(buf: SerialBuffer): SignalMessage source

Override:

Message#unserialize

Params:

NameTypeAttributeDescription
buf SerialBuffer

Return:

SignalMessage

Public Constructors

public constructor(senderId: PeerId, recipientId: PeerId, nonce: number, ttl: number, flags: SignalMessage.Flags | number, payload: Uint8Array, senderPubKey: PublicKey, signature: Signature) source

Create a new Message instance. This is usually not called directly but by subclasses.

Override:

Message#constructor

Params:

NameTypeAttributeDescription
senderId PeerId
recipientId PeerId
nonce number
ttl number
flags SignalMessage.Flags | number
payload Uint8Array
  • optional
senderPubKey PublicKey
  • optional
signature Signature
  • optional

Public Members

public get flags: SignalMessage.Flags | number source

public get nonce: number source

public get payload: Uint8Array source

public get recipientId: PeerId source

public get senderId: PeerId source

public get senderPubKey: PublicKey source

public get serializedSize: number source

Override:

Message#serializedSize

public get signature: Signature source

public get ttl: number source

Public Methods

public hasPayload(): boolean source

Return:

boolean

public isTtlExceeded(): boolean source

Return:

boolean

public isUnroutable(): boolean source

Return:

boolean

public serialize(buf: SerialBuffer): SerialBuffer source

Override:

Message#serialize

Params:

NameTypeAttributeDescription
buf SerialBuffer
  • optional

Return:

SerialBuffer

public toString(): string source

Override:

Message#toString

Return:

string

public verifySignature(): boolean source

Return:

boolean