API reference / @jsprismarine/client / RakNetTransport

Class: RakNetTransport

Defined in: client/src/net/RakNetTransport.ts:24

The network transport: RakNet over UDP.

A thin wrapper, and meant to stay that way. Everything hard about carrying bytes - ordering, acknowledgment, fragmentation, retransmission - is ClientSocket's and the session's, so what is left here is counting what went past and translating two event names.

Extends

• EventEmitter

Implements

• ITransport

Constructors

Constructor

new RakNetTransport(logger, options): RakNetTransport

Defined in: client/src/net/RakNetTransport.ts:35

Parameters

logger

Logger

options

RakNetTransportOptions

Returns

RakNetTransport

Overrides

EventEmitter.constructor

Methods

close()

close(reason?): void

Defined in: client/src/net/RakNetTransport.ts:85

Parameters

reason?

string = 'client disconnect'

Returns

void

Implementation of

ITransport.close

---

connect()

connect(): Promise<void>

Defined in: client/src/net/RakNetTransport.ts:61

Returns

Promise<void>

Implementation of

ITransport.connect

---

getStats()

getStats(): TransportStats

Defined in: client/src/net/RakNetTransport.ts:90

Counters the bot harness reports on; cheap enough to read every tick.

Returns

TransportStats

Implementation of

ITransport.getStats

---

off()

off<E>(event, listener): this

Defined in: client/src/net/RakNetTransport.ts:106

Alias for emitter.removeListener().

Type Parameters

E

E extends keyof TransportEvents

Parameters

event

E

listener

TransportEvents[E]

Returns

this

Since

v10.0.0

Implementation of

ITransport.off

Overrides

EventEmitter.off

---

on()

on<E>(event, listener): this

Defined in: client/src/net/RakNetTransport.ts:102

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.on('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Type Parameters

E

E extends keyof TransportEvents

Parameters

event

E

listener

TransportEvents[E]

The callback function

Returns

this

Since

v0.1.101

Implementation of

ITransport.on

Overrides

EventEmitter.on

---

send()

send(payload, priority?): void

Defined in: client/src/net/RakNetTransport.ts:65

Sends one framed batch.

Parameters

payload

Buffer

priority?

SendPriority = SendPriority.NORMAL

Returns

void

Implementation of

ITransport.send