Class Server

The raknet server

Hierarchy

Emitter<RaknetEvents>
- Server

Index

Constructors

constructor

new Server(properties?: Partial<RaknetServerProperties>): Server
Parameters
- Optionalproperties: Partial<RaknetServerProperties>
Returns Server
Overrides Emitter<RaknetEvents>.constructor
- Defined in packages/raknet/src/server/raknet.ts:183

Properties

alive

alive: boolean = true

Weather the server is alive

`Readonly`connections

connections: Set<Connection> = ...

A collection of connections for the server.

`Readonly`guid

guid: bigint = ...

The server guid for the server instance.

`Protected`interval

interval: null | Timeout = null

The server tick interval

`Readonly`logger

logger: Logger = ...

The raknet server logger

`Readonly`properties

properties: RaknetServerProperties

The raknet properties for the server instance.

`Readonly`socket

socket: Socket = ...

The udp4 socket instance for the server.

Accessors

address

get address(): string
The address the raknet server is bound to.

Returns string
- Defined in packages/raknet/src/server/raknet.ts:67
set address(value: string): void
The address the raknet server is bound to.
Parameters
- value: string
Returns void
- Defined in packages/raknet/src/server/raknet.ts:74

maxConnections

get maxConnections(): number
The max connections of the server.

Returns number
- Defined in packages/raknet/src/server/raknet.ts:165
set maxConnections(value: number): void
The max connections of the server.
Parameters
- value: number
Returns void
- Defined in packages/raknet/src/server/raknet.ts:172

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

maxMtuSize

get maxMtuSize(): number
The maximum transmission unit size for the server.

Returns number
- Defined in packages/raknet/src/server/raknet.ts:95
set maxMtuSize(value: number): void
The maximum transmission unit size for the server.
Parameters
- value: number
Returns void
- Defined in packages/raknet/src/server/raknet.ts:102

message

get message(): string
The message of the day of the server.

Returns string
- Defined in packages/raknet/src/server/raknet.ts:151
set message(value: string): void
The message of the day of the server.
Parameters
- value: string
Returns void
- Defined in packages/raknet/src/server/raknet.ts:158

minMtuSize

get minMtuSize(): number
The minimum transmission unit size for the server.

Returns number
- Defined in packages/raknet/src/server/raknet.ts:109
set minMtuSize(value: number): void
The minimum transmission unit size for the server.
Parameters
- value: number
Returns void
- Defined in packages/raknet/src/server/raknet.ts:116

port

get port(): number
The port the raknet server is bound to.

Returns number
- Defined in packages/raknet/src/server/raknet.ts:81
set port(value: number): void
The port the raknet server is bound to.
Parameters
- value: number
Returns void
- Defined in packages/raknet/src/server/raknet.ts:88

protocol

get protocol(): number
The protocol version of the server.

Returns number
- Defined in packages/raknet/src/server/raknet.ts:123
set protocol(value: number): void
The protocol version of the server.
Parameters
- value: number
Returns void
- Defined in packages/raknet/src/server/raknet.ts:130

version

get version(): string
The version of the server.

Returns string
- Defined in packages/raknet/src/server/raknet.ts:137
set version(value: string): void
The version of the server.
Parameters
- value: string
Returns void
- Defined in packages/raknet/src/server/raknet.ts:144

Methods

after

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

before

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

emit

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

`Protected`handle

handle(buffer: Buffer, rinfo: RemoteInfo): void
Parameters
- buffer: Buffer
- rinfo: RemoteInfo
Returns void
- Defined in packages/raknet/src/server/raknet.ts:241

on

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

once

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

onceAfter

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

onceBefore

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

remove

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

removeAfter

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

removeAll

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

removeAllAfter

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

removeAllBefore

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

removeBefore

removeBefore<K extends keyof RaknetEvents>(
event: K,
listener: Listener<ForceArray<RaknetEvents[K]>, boolean>,
): this
Type Parameters
- K extends keyof RaknetEvents
Parameters
- event: K
- listener: Listener<ForceArray<RaknetEvents[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(buffer: Buffer, rinfo: RemoteInfo): void
Parameters
- buffer: Buffer
- rinfo: RemoteInfo
Returns void
- Defined in packages/raknet/src/server/raknet.ts:270

start

start(shouldTick?: boolean): void
Starts the server
Parameters
- shouldTick: boolean = true
Returns void
- Defined in packages/raknet/src/server/raknet.ts:200

stop

stop(): void
Stops the server

Returns void
- Defined in packages/raknet/src/server/raknet.ts:223

Class Server

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Server

Properties

alive

Readonlyconnections

Readonlyguid

Protectedinterval

Readonlylogger

Readonlyproperties

Readonlysocket

Accessors

address

Returns string

Parameters

Returns void

maxConnections

Returns number

Parameters

Returns void

maxListeners

Returns number

Parameters

Returns void

maxMtuSize

Returns number

Parameters

Returns void

message

Returns string

Parameters

Returns void

minMtuSize

Returns number

Parameters

Returns void

port

Returns number

Parameters

Returns void

protocol

Returns number

Parameters

Returns void

version

Returns string

Parameters

Returns void

Methods

after

Type Parameters

Parameters

Returns this

before

Type Parameters

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

Protectedhandle

Parameters

Returns void

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

`Readonly`connections

`Readonly`guid

`Protected`interval

`Readonly`logger

`Readonly`properties

`Readonly`socket

`Protected`handle