Class Network

Hierarchy

Emitter<NetworkEvents>
- Network

Constructors

constructor

new Network(
    serenity: Serenity,
    properties?: Partial<NetworkProperties>,
    raknetProperties?: Partial<RaknetServerProperties>,
    handlers?: typeof NetworkHandler[],
): Network
Creates a new network handler for a raknet server
Parameters
- serenity: Serenity
  The serenity instance to handle incoming packets with
- Optionalproperties: Partial<NetworkProperties>
- OptionalraknetProperties: Partial<RaknetServerProperties>
- Optionalhandlers: typeof NetworkHandler[]
  The handlers to register to the network
Returns Network
Overrides Emitter<NetworkEvents>.constructor
- Defined in packages/core/src/network/network.ts:133

Properties

`Readonly`connections

connections: Map<Connection, ConnectionProperties> = ...

The current connections that are being handled by the network

`Readonly`handlers

handlers: Set<NetworkHandler> = ...

The registered handlers that are being used to handle incoming packets

`Readonly`logger

logger: Logger = ...

The logger that is being used to log network events

`Readonly`properties

properties: NetworkProperties

The properties that are being used for the network

`Readonly`raknet

raknet: Server

The raknet instance that is being used to handle incoming packets

`Readonly`serenity

serenity: Serenity

The serenity instance that is being used to handle incoming packets

Accessors

compressionMethod

get compressionMethod(): CompressionMethod
The current compression method that is being used for the network

Returns CompressionMethod
- Defined in packages/core/src/network/network.ts:89
set compressionMethod(method: CompressionMethod): void
The current compression method that is being used for the network
Parameters
- method: CompressionMethod
Returns void
- Defined in packages/core/src/network/network.ts:96

compressionThreshold

get compressionThreshold(): number
The current compression threshold that is being used for the network

Returns number
- Defined in packages/core/src/network/network.ts:103
set compressionThreshold(threshold: number): void
The current compression threshold that is being used for the network
Parameters
- threshold: number
Returns void
- Defined in packages/core/src/network/network.ts:110

maxListeners

get maxListeners(): number
Returns number
Inherited from Emitter.maxListeners
- Defined in packages/emitter/dist/index.d.ts:10
set maxListeners(value: number): void
Parameters
- value: number
Returns void
Inherited from Emitter.maxListeners
- Defined in packages/emitter/dist/index.d.ts:11

packetsPerFrame

get packetsPerFrame(): number
The current packets per frame that is being used for the network

Returns number
- Defined in packages/core/src/network/network.ts:117
set packetsPerFrame(packets: number): void
The current packets per frame that is being used for the network
Parameters
- packets: number
Returns void
- Defined in packages/core/src/network/network.ts:124

Methods

after

after<K extends keyof NetworkEvents>(
event: K,
listener: Listener<ForceArray<NetworkEvents[K]>>,
): this
Type Parameters
- K extends keyof NetworkEvents
Parameters
- event: K
- listener: Listener<ForceArray<NetworkEvents[K]>>
Returns this
Inherited from Emitter.after
- Defined in packages/emitter/dist/index.d.ts:19

before

before<K extends keyof NetworkEvents>(
event: K,
listener: Listener<ForceArray<NetworkEvents[K]>, boolean>,
): this
Type Parameters
- K extends keyof NetworkEvents
Parameters
- event: K
- listener: Listener<ForceArray<NetworkEvents[K]>, boolean>
Returns this
Inherited from Emitter.before
- Defined in packages/emitter/dist/index.d.ts:18

deflateZlib

deflateZlib(buffer: Buffer): Buffer
Deflates a buffer using the zlib compression algorithm
Parameters
- buffer: Buffer
  The buffer to deflate
Returns Buffer
The deflated buffer
- Defined in packages/core/src/network/network.ts:554

disconnectConnection

disconnectConnection(
    connection: Connection,
    message: string,
    reason: DisconnectReason,
): void
Parameters
- connection: Connection
- message: string
- reason: DisconnectReason
Returns void
- Defined in packages/core/src/network/network.ts:580

emit

emit<K extends keyof NetworkEvents>(
event: K,
...arguments_: ForceArray<NetworkEvents[K]>,
): boolean
Type Parameters
- K extends keyof NetworkEvents
Parameters
- event: K
- ...arguments_: ForceArray<NetworkEvents[K]>
Returns boolean
Inherited from Emitter.emit
- Defined in packages/emitter/dist/index.d.ts:12

inflateSnappy

inflateSnappy(_buffer: Buffer): Buffer
Inflates a snappy compressed buffer
Parameters
- _buffer: Buffer
Returns Buffer
The inflated buffer
- Defined in packages/core/src/network/network.ts:422

inflateZlib

inflateZlib(buffer: Buffer): Buffer
Inflates a zlib compressed buffer
Parameters
- buffer: Buffer
  The zlib compressed buffer to inflate
Returns Buffer
The inflated buffer
- Defined in packages/core/src/network/network.ts:413

on

on<K extends keyof NetworkEvents>(
event: K,
listener: Listener<ForceArray<NetworkEvents[K]>>,
): this
Type Parameters
- K extends keyof NetworkEvents
Parameters
- event: K
- listener: Listener<ForceArray<NetworkEvents[K]>>
Returns this
Inherited from Emitter.on
- Defined in packages/emitter/dist/index.d.ts:17

once

once<K extends keyof NetworkEvents>(
event: K,
listener: Listener<ForceArray<NetworkEvents[K]>>,
): this
Type Parameters
- K extends keyof NetworkEvents
Parameters
- event: K
- listener: Listener<ForceArray<NetworkEvents[K]>>
Returns this
Inherited from Emitter.once
- Defined in packages/emitter/dist/index.d.ts:20

onceAfter

onceAfter<K extends keyof NetworkEvents>(
event: K,
listener: Listener<ForceArray<NetworkEvents[K]>>,
): this
Type Parameters
- K extends keyof NetworkEvents
Parameters
- event: K
- listener: Listener<ForceArray<NetworkEvents[K]>>
Returns this
Inherited from Emitter.onceAfter
- Defined in packages/emitter/dist/index.d.ts:22

onceBefore

onceBefore<K extends keyof NetworkEvents>(
event: K,
listener: Listener<ForceArray<NetworkEvents[K]>, boolean>,
): this
Type Parameters
- K extends keyof NetworkEvents
Parameters
- event: K
- listener: Listener<ForceArray<NetworkEvents[K]>, boolean>
Returns this
Inherited from Emitter.onceBefore
- Defined in packages/emitter/dist/index.d.ts:21

onConnect

onConnect(connection: Connection): void
Handles all incoming connections from the raknet server
Parameters
- connection: Connection
  The connection that is being established
Returns void
- Defined in packages/core/src/network/network.ts:196

onDisconnect

onDisconnect(connection: Connection): void
Handles all disconnections from the raknet server
Parameters
- connection: Connection
  The connection that is being disconnected
Returns void
- Defined in packages/core/src/network/network.ts:216

onEncapsulated

onEncapsulated(connection: Connection, ...data: Buffer[]): void
Handles all incoming packet traffic from the raknet server
Parameters
- connection: Connection
  The raknet connection the data is coming from
- ...data: Buffer[]
  The data buffers that are being sent from the connection
Returns void
- Defined in packages/core/src/network/network.ts:252

registerHandler

registerHandler(handler: typeof NetworkHandler): void
Registers a new handler to the network
Parameters
- handler: typeof NetworkHandler
  The handler to register to the network
Returns void
- Defined in packages/core/src/network/network.ts:172

remove

remove<K extends keyof NetworkEvents>(
event: K,
listener: Listener<ForceArray<NetworkEvents[K]>>,
): this
Type Parameters
- K extends keyof NetworkEvents
Parameters
- event: K
- listener: Listener<ForceArray<NetworkEvents[K]>>
Returns this
Inherited from Emitter.remove
- Defined in packages/emitter/dist/index.d.ts:23

removeAfter

removeAfter<K extends keyof NetworkEvents>(
event: K,
listener: Listener<ForceArray<NetworkEvents[K]>>,
): this
Type Parameters
- K extends keyof NetworkEvents
Parameters
- event: K
- listener: Listener<ForceArray<NetworkEvents[K]>>
Returns this
Inherited from Emitter.removeAfter
- Defined in packages/emitter/dist/index.d.ts:25

removeAll

removeAll<K extends keyof NetworkEvents>(event?: K): this
Type Parameters
- K extends keyof NetworkEvents
Parameters
- Optionalevent: K
Returns this
Inherited from Emitter.removeAll
- Defined in packages/emitter/dist/index.d.ts:26

removeAllAfter

removeAllAfter<K extends keyof NetworkEvents>(event?: K): this
Type Parameters
- K extends keyof NetworkEvents
Parameters
- Optionalevent: K
Returns this
Inherited from Emitter.removeAllAfter
- Defined in packages/emitter/dist/index.d.ts:28

removeAllBefore

removeAllBefore<K extends keyof NetworkEvents>(event?: K): this
Type Parameters
- K extends keyof NetworkEvents
Parameters
- Optionalevent: K
Returns this
Inherited from Emitter.removeAllBefore
- Defined in packages/emitter/dist/index.d.ts:27

removeBefore

removeBefore<K extends keyof NetworkEvents>(
event: K,
listener: Listener<ForceArray<NetworkEvents[K]>, boolean>,
): this
Type Parameters
- K extends keyof NetworkEvents
Parameters
- event: K
- listener: Listener<ForceArray<NetworkEvents[K]>, boolean>
Returns this
Inherited from Emitter.removeBefore
- Defined in packages/emitter/dist/index.d.ts:24

removePath

removePath(path: string): this
Parameters
- path: string
Returns this
Inherited from Emitter.removePath
- Defined in packages/emitter/dist/index.d.ts:29

send

send(
    connection: Connection,
    priority?: Priority,
    ...packets: DataPacket[],
): void
Send a batch of packets to a connection with a specified priority
Parameters
- connection: Connection
  The connection to send the packets to
- priority: Priority = Priority.Normal
  The priority of the packets being sent
- ...packets: DataPacket[]
  The packets to send to the connection
Returns void
- Defined in packages/core/src/network/network.ts:432

sendImmediate

sendImmediate(connection: Connection, ...packets: DataPacket[]): void
Sends a batch of packets to a connection with immediate priority
Parameters
- connection: Connection
  The connection to send the packets to immediately
- ...packets: DataPacket[]
  The packets to send to the connection
Returns void
- Defined in packages/core/src/network/network.ts:542

sendNormal

sendNormal(connection: Connection, ...packets: DataPacket[]): void
Sends a batch of packets to a connection with normal priority
Parameters
- connection: Connection
  The connection to send the packets to with normal priority
- ...packets: DataPacket[]
  The packets to send to the connection
Returns void
- Defined in packages/core/src/network/network.ts:530

setCompression

setCompression(connection: Connection, enabled: boolean): void
Parameters
- connection: Connection
- enabled: boolean
Returns void
- Defined in packages/core/src/network/network.ts:558

setEncryption

setEncryption(connection: Connection, enabled: boolean): void
Parameters
- connection: Connection
- enabled: boolean
Returns void
- Defined in packages/core/src/network/network.ts:569

unregisterHandler

unregisterHandler(handler: typeof NetworkHandler): void
Unregisters a handler from the network
Parameters
- handler: typeof NetworkHandler
  The handler to unregister from the network
Returns void
- Defined in packages/core/src/network/network.ts:180

Class Network

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Network

Properties

Readonlyconnections

Readonlyhandlers

Readonlylogger

Readonlyproperties

Readonlyraknet

Readonlyserenity

Accessors

compressionMethod

Returns CompressionMethod

Parameters

Returns void

compressionThreshold

Returns number

Parameters

Returns void

maxListeners

Returns number

Parameters

Returns void

packetsPerFrame

Returns number

Parameters

Returns void

Methods

after

Type Parameters

Parameters

Returns this

before

Type Parameters

Parameters

Returns this

deflateZlib

Parameters

Returns Buffer

disconnectConnection

Parameters

Returns void

emit

Type Parameters

Parameters

Returns boolean

inflateSnappy

Parameters

Returns Buffer

inflateZlib

Parameters

Returns Buffer

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

onceAfter

Type Parameters

Parameters

Returns this

onceBefore

Type Parameters

Parameters

Returns this

onConnect

Parameters

Returns void

onDisconnect

`Readonly`connections

`Readonly`handlers

`Readonly`logger

`Readonly`properties

`Readonly`raknet

`Readonly`serenity