_net_server_server_.server.md

ethereumjs-client › "net/server/server" › Server

Class: Server

Base class for transport specific server implementations.

memberof module:net/server

Hierarchy

• EventEmitter

  ↳ Server

  ↳ RlpxServer

  ↳ Libp2pServer

Index

Constructors

• constructor

Properties

• bootnodes
• config
• key
• started
• defaultMaxListeners
• errorMonitor

Accessors

• name
• running

Methods

• addListener
• addProtocols
• ban
• emit
• eventNames
• getMaxListeners
• listenerCount
• listeners
• off
• on
• once
• prependListener
• prependOnceListener
• rawListeners
• removeAllListeners
• removeListener
• setMaxListeners
• start
• stop
• listenerCount

Constructors

constructor

+ new Server(options: ServerOptions): Server

Overrides void

Defined in lib/net/server/server.ts:33

Create new server

Parameters:

Name	Type
options	ServerOptions

Returns: Server

Properties

bootnodes

• bootnodes: Bootnode[] = []

Defined in lib/net/server/server.ts:28

---

config

• config: Config

Defined in lib/net/server/server.ts:26

---

key

• key: Buffer | undefined

Defined in lib/net/server/server.ts:27

---

started

• started: boolean

Defined in lib/net/server/server.ts:33

---

Static defaultMaxListeners

▪ defaultMaxListeners: number

Inherited from Sender.defaultMaxListeners

Defined in node_modules/@types/node/events.d.ts:45

---

Static errorMonitor

▪ errorMonitor: keyof symbol

Inherited from Sender.errorMonitor

Defined in node_modules/@types/node/events.d.ts:55

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

name

• get name(): string

Defined in lib/net/server/server.ts:51

Returns: string

---

running

• get running(): boolean

Defined in lib/net/server/server.ts:58

Check if server is running

Returns: boolean

Methods

addListener

▸ addListener(event: string | symbol, listener: function): this

Inherited from Sender.addListener

Defined in node_modules/@types/node/events.d.ts:62

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

addProtocols

▸ addProtocols(protocols: Protocol[]): boolean

Defined in lib/net/server/server.ts:92

Specify which protocols the server must support

Parameters:

Name	Type	Description
protocols	Protocol[]	protocol classes

Returns: boolean

True if protocol added successfully

---

Protected ban

▸ ban(_peerId: string, _maxAge: number): void

Defined in lib/net/server/server.ts:108

Ban peer for a specified time

Parameters:

Name	Type
_peerId	string
_maxAge	number

Returns: void

---

emit

▸ emit(event: string | symbol, ...args: any[]): boolean

Inherited from Sender.emit

Defined in node_modules/@types/node/events.d.ts:72

Parameters:

Name	Type
event	string | symbol
...args	any[]

Returns: boolean

---

eventNames

▸ eventNames(): Array‹string | symbol›

Inherited from Sender.eventNames

Defined in node_modules/@types/node/events.d.ts:77

Returns: Array‹string | symbol›

---

getMaxListeners

▸ getMaxListeners(): number

Inherited from Sender.getMaxListeners

Defined in node_modules/@types/node/events.d.ts:69

Returns: number

---

listenerCount

▸ listenerCount(event: string | symbol): number

Inherited from Sender.listenerCount

Defined in node_modules/@types/node/events.d.ts:73

Parameters:

Name	Type
event	string | symbol

Returns: number

---

listeners

▸ listeners(event: string | symbol): Function[]

Inherited from Sender.listeners

Defined in node_modules/@types/node/events.d.ts:70

Parameters:

Name	Type
event	string | symbol

Returns: Function[]

---

off

▸ off(event: string | symbol, listener: function): this

Inherited from Sender.off

Defined in node_modules/@types/node/events.d.ts:66

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

on

▸ on(event: string | symbol, listener: function): this

Inherited from Sender.on

Defined in node_modules/@types/node/events.d.ts:63

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

once

▸ once(event: string | symbol, listener: function): this

Inherited from Sender.once

Defined in node_modules/@types/node/events.d.ts:64

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

prependListener

▸ prependListener(event: string | symbol, listener: function): this

Inherited from Sender.prependListener

Defined in node_modules/@types/node/events.d.ts:75

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

prependOnceListener

▸ prependOnceListener(event: string | symbol, listener: function): this

Inherited from Sender.prependOnceListener

Defined in node_modules/@types/node/events.d.ts:76

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

rawListeners

▸ rawListeners(event: string | symbol): Function[]

Inherited from Sender.rawListeners

Defined in node_modules/@types/node/events.d.ts:71

Parameters:

Name	Type
event	string | symbol

Returns: Function[]

---

removeAllListeners

▸ removeAllListeners(event?: string | symbol): this

Inherited from Sender.removeAllListeners

Defined in node_modules/@types/node/events.d.ts:67

Parameters:

Name	Type
event?	string | symbol

Returns: this

---

removeListener

▸ removeListener(event: string | symbol, listener: function): this

Inherited from Sender.removeListener

Defined in node_modules/@types/node/events.d.ts:65

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

setMaxListeners

▸ setMaxListeners(n: number): this

Inherited from Sender.setMaxListeners

Defined in node_modules/@types/node/events.d.ts:68

Parameters:

Name	Type
n	number

Returns: this

---

start

▸ start(): Promise‹boolean›

Defined in lib/net/server/server.ts:66

Start server. Returns a promise that resolves once server has been started.

Returns: Promise‹boolean›

Resolves with true if server successfully started

---

stop

▸ stop(): Promise‹boolean›

Defined in lib/net/server/server.ts:81

Stop server. Returns a promise that resolves once server has been stopped.

Returns: Promise‹boolean›

---

Static listenerCount

▸ listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from Sender.listenerCount

Defined in node_modules/@types/node/events.d.ts:44

deprecated since v4.0.0

Parameters:

Name	Type
emitter	EventEmitter
event	string | symbol

Returns: number