Interface Connection

Hierarchy

Connection

Index

Methods

activeSourceCids applicationProto availableDcids close destinationId dgramMaxWritableLen dgramPurgeOutgoing dgramRecv dgramRecvFrontLen dgramRecvPeek dgramRecvQueueByteSize dgramRecvQueueLen dgramRecvVec dgramSend dgramSendQueueByteSize dgramSendQueueLen dgramSendVec isClosed isDgramRecvQueueFull isDgramSendQueueFull isDraining isEstablished isInEarlyData isPathValidated isReadable isResumed isTimedOut localError maxActiveSourceCids maxSendUdpPayloadSize migrate migrateSource newSourceCid onTimeout pathEventNext pathStats pathsIter peerCertChain peerError peerStreamsLeftBidi peerStreamsLeftUni probePath readable recv retireDestinationCid retiredScidNext send sendAckEliciting sendOnPath sendQuantum sendQuantumOnPath serverName session setKeylog setSession sourceCidsLeft sourceId stats streamCapacity streamFinished streamPriority streamReadable streamRecv streamSend streamShutdown streamWritable timeout traceId writable

Methods

activeSourceCids

activeSourceCids(): number
Returns number
- Defined in src/native/types.ts:110

applicationProto

applicationProto(): Uint8Array
Returns Uint8Array
- Defined in src/native/types.ts:120

availableDcids

availableDcids(): number
Returns number
- Defined in src/native/types.ts:116

close

close(app, err, reason): null | void
Parameters
- app: boolean
- err: number
- reason: Uint8Array
Returns null | void
- Defined in src/native/types.ts:118

destinationId

destinationId(): Uint8Array
Returns Uint8Array
- Defined in src/native/types.ts:125

dgramMaxWritableLen

dgramMaxWritableLen(): null | number
Returns null | number
- Defined in src/native/types.ts:99

dgramPurgeOutgoing

dgramPurgeOutgoing(f): void
Parameters
- f: ((arg0) => boolean)
  - - (arg0): boolean
    - Parameters
      
      arg0: Uint8Array
      
      Returns boolean
Returns void
- Defined in src/native/types.ts:98

dgramRecv

dgramRecv(data): null | number
Parameters
- data: Uint8Array
Returns null | number
- Defined in src/native/types.ts:86

dgramRecvFrontLen

dgramRecvFrontLen(): null | number
Returns null | number
- Defined in src/native/types.ts:89

dgramRecvPeek

dgramRecvPeek(data, len): null | number
Parameters
- data: Uint8Array
- len: number
Returns null | number
- Defined in src/native/types.ts:88

dgramRecvQueueByteSize

dgramRecvQueueByteSize(): number
Returns number
- Defined in src/native/types.ts:91

dgramRecvQueueLen

dgramRecvQueueLen(): number
Returns number
- Defined in src/native/types.ts:90

dgramRecvVec

dgramRecvVec(): null | Uint8Array
Returns null | Uint8Array
- Defined in src/native/types.ts:87

dgramSend

dgramSend(data): null | void
Parameters
- data: Uint8Array
Returns null | void
- Defined in src/native/types.ts:96

dgramSendQueueByteSize

dgramSendQueueByteSize(): number
Returns number
- Defined in src/native/types.ts:93

dgramSendQueueLen

dgramSendQueueLen(): number
Returns number
- Defined in src/native/types.ts:92

dgramSendVec

dgramSendVec(data): null | void
Parameters
- data: Uint8Array
Returns null | void
- Defined in src/native/types.ts:97

isClosed

isClosed(): boolean
Returns boolean
- Defined in src/native/types.ts:132

isDgramRecvQueueFull

isDgramRecvQueueFull(): boolean
Returns boolean
- Defined in src/native/types.ts:95

isDgramSendQueueFull

isDgramSendQueueFull(): boolean
Returns boolean
- Defined in src/native/types.ts:94

isDraining

isDraining(): boolean
Returns boolean
- Defined in src/native/types.ts:131

isEstablished

isEstablished(): boolean
Returns boolean
- Defined in src/native/types.ts:126

isInEarlyData

isInEarlyData(): boolean
Returns boolean
- Defined in src/native/types.ts:128

isPathValidated

isPathValidated(from, to): boolean
Parameters
- from: native.Host
- to: native.Host
Returns boolean
- Defined in src/native/types.ts:130

isReadable

isReadable(): boolean
Returns boolean
- Defined in src/native/types.ts:129

isResumed

isResumed(): boolean
Returns boolean
- Defined in src/native/types.ts:127

isTimedOut

isTimedOut(): boolean
Returns boolean
- Defined in src/native/types.ts:133

localError

localError(): null | ConnectionError
Returns null | ConnectionError
- Defined in src/native/types.ts:135

maxActiveSourceCids

maxActiveSourceCids(): number
Returns number
- Defined in src/native/types.ts:111

maxSendUdpPayloadSize

maxSendUdpPayloadSize(): number
Returns number
- Defined in src/native/types.ts:85

migrate

migrate(localHost, peerHost): number
Parameters
- localHost: native.Host
- peerHost: native.Host
Returns number
- Defined in src/native/types.ts:104

migrateSource

migrateSource(localHost): number
Parameters
- localHost: native.Host
Returns number
- Defined in src/native/types.ts:103

newSourceCid

newSourceCid(scid, resetToken, retireIfNeeded): number
Parameters
- scid: Uint8Array
- resetToken: bigint
- retireIfNeeded: boolean
Returns number
- Defined in src/native/types.ts:105

onTimeout

onTimeout(): void
Returns void
- Defined in src/native/types.ts:101

pathEventNext

pathEventNext(): PathEvent
Returns PathEvent
- Defined in src/native/types.ts:114

pathStats

pathStats(): PathStats[]
Returns PathStats[]
- Defined in src/native/types.ts:137

pathsIter

pathsIter(from): HostIter
Parameters
- from: native.Host
Returns HostIter
- Defined in src/native/types.ts:117

peerCertChain

peerCertChain(): null | Uint8Array[]
Returns null | Uint8Array[]
- Defined in src/native/types.ts:122

peerError

peerError(): null | ConnectionError
Returns null | ConnectionError
- Defined in src/native/types.ts:134

peerStreamsLeftBidi

peerStreamsLeftBidi(): number
Returns number
- Defined in src/native/types.ts:81

peerStreamsLeftUni

peerStreamsLeftUni(): number
Returns number
- Defined in src/native/types.ts:82

probePath

probePath(localHost, peerHost): number
Parameters
- localHost: native.Host
- peerHost: native.Host
Returns number
- Defined in src/native/types.ts:102

readable

readable(): StreamIter
Returns StreamIter
- Defined in src/native/types.ts:83

recv

recv(data, recvInfo): number
Parameters
- data: Uint8Array
- recvInfo: RecvInfo
Returns number
- Defined in src/native/types.ts:60

retireDestinationCid

retireDestinationCid(dcidSeq): void
Parameters
- dcidSeq: number
Returns void
- Defined in src/native/types.ts:113

retiredScidNext

retiredScidNext(): null | Uint8Array
Returns null | Uint8Array
- Defined in src/native/types.ts:115

send

send(data): null | [number, SendInfo]
Parameters
- data: Uint8Array
Returns null | [number, SendInfo]
- Defined in src/native/types.ts:61

sendAckEliciting

sendAckEliciting(): void
Returns void
- Defined in src/native/types.ts:138

sendOnPath

sendOnPath(data, from?, to?): null | [number, SendInfo]
Parameters
- data: Uint8Array
- Optional from: null | native.Host
- Optional to: null | native.Host
Returns null | [number, SendInfo]
- Defined in src/native/types.ts:62

sendQuantum

sendQuantum(): number
Returns number
- Defined in src/native/types.ts:67

sendQuantumOnPath

sendQuantumOnPath(localHost, peerHost): number
Parameters
- localHost: native.Host
- peerHost: native.Host
Returns number
- Defined in src/native/types.ts:68

serverName

serverName(): null | string
Returns null | string
- Defined in src/native/types.ts:121

session

session(): null | Uint8Array
Returns null | Uint8Array
- Defined in src/native/types.ts:123

setKeylog

setKeylog(path): void
Parameters
- path: string
Returns void
- Defined in src/native/types.ts:58

setSession

setSession(session): void
Parameters
- session: Uint8Array
Returns void
- Defined in src/native/types.ts:59

sourceCidsLeft

sourceCidsLeft(): number
Returns number
- Defined in src/native/types.ts:112

sourceId

sourceId(): Uint8Array
Returns Uint8Array
- Defined in src/native/types.ts:124

stats

stats(): Stats
Returns Stats
- Defined in src/native/types.ts:136

streamCapacity

streamCapacity(streamId): number
Parameters
- streamId: number
Returns number
- Defined in src/native/types.ts:77

streamFinished

streamFinished(streamId): boolean
Parameters
- streamId: number
Returns boolean
- Defined in src/native/types.ts:80

streamPriority

streamPriority(streamId, urgency, incremental): void
Parameters
- streamId: number
- urgency: number
- incremental: boolean
Returns void
- Defined in src/native/types.ts:71

streamReadable

streamReadable(streamId): boolean
Parameters
- streamId: number
Returns boolean
- Defined in src/native/types.ts:78

streamRecv

streamRecv(streamId, data): null | [number, boolean]
Parameters
- streamId: number
- data: Uint8Array
Returns null | [number, boolean]
- Defined in src/native/types.ts:69

streamSend

streamSend(streamId, data, fin): null | number
Parameters
- streamId: number
- data: Uint8Array
- fin: boolean
Returns null | number
- Defined in src/native/types.ts:70

streamShutdown

streamShutdown(streamId, direction, err): null | void
Parameters
- streamId: number
- direction: Shutdown
- err: number
Returns null | void
- Defined in src/native/types.ts:72

streamWritable

streamWritable(streamId, len): boolean
Parameters
- streamId: number
- len: number
Returns boolean
- Defined in src/native/types.ts:79

timeout

timeout(): null | number
Returns null | number
- Defined in src/native/types.ts:100

traceId

traceId(): string
Returns string
- Defined in src/native/types.ts:119

writable

writable(): StreamIter
Returns StreamIter
- Defined in src/native/types.ts:84

Generated using TypeDoc