Class NetworkServer

Hierarchy

NetworkServer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NetworkServer(classRegistry: ClassRegistry<Serializable>, authenticatePlayer: AuthCallback): NetworkServer

- Defined in network-server/src/network-server.ts:261
Parameters
- classRegistry: ClassRegistry<Serializable>
- authenticatePlayer: AuthCallback
Returns NetworkServer

Properties

Private connections

connections: Map<PlayerId, NetworkPeer> = ...

Private handShakingConnections

handShakingConnections: Map<PlayerId, NetworkPeer> = ...

Readonly onConnection

onConnection: SyncEvent<{ networkPeer: NetworkPeer; playerId: PlayerId }> = ...

Readonly onDisconnect

onDisconnect: SyncEvent<PlayerId> = ...

Private registeredMessageHandlers

registeredMessageHandlers: [new (...args: any[]) => Serializable, (playerId: PlayerId, packet: Serializable) => void][] = ...

Private rtcServer

rtcServer: RTCServer

Methods

close

close(): Promise<void>

- Defined in network-server/src/network-server.ts:302
Returns Promise<void>

flushMessagesToNetwork

flushMessagesToNetwork(playerId?: PlayerId): void

- Defined in network-server/src/network-server.ts:355
Sends messages across the network

Parameters
- Optional playerId: PlayerId
  
  optional id of player to only flush their messages
Returns void

listen

listen(options: ListenOptions): Promise<AddressInfo>

- Defined in network-server/src/network-server.ts:299
Parameters
- options: ListenOptions
Returns Promise<AddressInfo>

registerMessageHandler

registerMessageHandler<T>(ctor: new (...args: any[]) => T, handler: (playerId: PlayerId, t: T) => void): void

- Defined in network-server/src/network-server.ts:326
Type parameters
- T: Serializable
Parameters
- ctor: new (...args: any[]) => T
  - - new (...args: any[]): T
    - Parameters
      - Rest ...args: any[]
      Returns T
- handler: (playerId: PlayerId, t: T) => void
  - - (playerId: PlayerId, t: T): void
    - Parameters
      - playerId: PlayerId
      - t: T
      Returns void
Returns void

registerMessageType

registerMessageType<T>(ctor: new (...args: any[]) => T, uniqueMessageTypeName: string): void

- Defined in network-server/src/network-server.ts:319
Type parameters
- T: Serializable
Parameters
- ctor: new (...args: any[]) => T
  - - new (...args: any[]): T
    - Parameters
      - Rest ...args: any[]
      Returns T
- uniqueMessageTypeName: string
Returns void

sendMessage

sendMessage(playerId: PlayerId, message: Serializable, onAck?: () => void): OutboundMessage

- Defined in network-server/src/network-server.ts:336
Parameters
- playerId: PlayerId
- message: Serializable
- Optional onAck: () => void
  - - (): void
    - Returns void
Returns OutboundMessage

Generated using TypeDoc