ethereumjs-client › "net/protocol/boundprotocol" › BoundProtocol

Class: BoundProtocol

Binds a protocol implementation to the specified peer

memberof module:net/protocol

Hierarchy

• EventEmitter

  ↳ BoundProtocol

Index

Constructors

• constructor

Properties

• config
• name
• defaultMaxListeners
• errorMonitor

Accessors

• status

Methods

• addListener
• addMethods
• emit
• eventNames
• getMaxListeners
• handle
• handshake
• listenerCount
• listeners
• off
• on
• once
• prependListener
• prependOnceListener
• rawListeners
• removeAllListeners
• removeListener
• request
• send
• setMaxListeners
• listenerCount

Constructors

constructor

+ new BoundProtocol(options: BoundProtocolOptions): BoundProtocol

Overrides void

Defined in lib/net/protocol/boundprotocol.ts:30

Create bound protocol

Parameters:

Name	Type
options	BoundProtocolOptions

Returns: BoundProtocol

Properties

config

• config: Config

Defined in lib/net/protocol/boundprotocol.ts:22

---

name

• name: string

Defined in lib/net/protocol/boundprotocol.ts:23

---

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

status

• get status(): any

Defined in lib/net/protocol/boundprotocol.ts:61

Returns: any

• set status(status: any): void

Defined in lib/net/protocol/boundprotocol.ts:65

Parameters:

Name	Type
status	any

Returns: void

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

---

addMethods

▸ addMethods(): void

Defined in lib/net/protocol/boundprotocol.ts:161

Add a methods to the bound protocol for each protocol message that has a corresponding response message

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

---

Private handle

▸ handle(incoming: any): void

Defined in lib/net/protocol/boundprotocol.ts:79

Handle incoming message

emits message

Parameters:

Name	Type
incoming	any

Returns: void

---

handshake

▸ handshake(sender: Sender): Promise‹void›

Defined in lib/net/protocol/boundprotocol.ts:69

Parameters:

Name	Type
sender	Sender

Returns: Promise‹void›

---

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

---

request

▸ request(name: string, args: any[]): Promise‹any›

Defined in lib/net/protocol/boundprotocol.ts:135

Returns a promise that resolves with the message payload when a response to the specified message is received

Parameters:

Name	Type	Description
name	string	message to wait for
args	any[]	message arguments

Returns: Promise‹any›

---

send

▸ send(name: string, args?: any): any

Defined in lib/net/protocol/boundprotocol.ts:116

Send message with name and the specified args

Parameters:

Name	Type	Description
name	string	message name
args?	any	message arguments

Returns: any

---

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

---

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