_net_protocol_libp2psender_.libp2psender.md

ethereumjs-client › "net/protocol/libp2psender" › Libp2pSender

Class: Libp2pSender

Libp2p protocol sender

emits message

emits status

memberof module:net/protocol

Hierarchy

↳ Sender

↳ Libp2pSender

Index

Constructors

• constructor

Accessors

• status

Methods

• addListener
• emit
• error
• eventNames
• getMaxListeners
• init
• listenerCount
• listeners
• off
• on
• once
• prependListener
• prependOnceListener
• rawListeners
• removeAllListeners
• removeListener
• sendMessage
• sendStatus
• setMaxListeners

Constructors

constructor

+ new Libp2pSender(connection: any): Libp2pSender

Overrides Sender.constructor

Defined in lib/net/protocol/libp2psender.ts:19

Creates a new Libp2p protocol sender

Parameters:

Name	Type	Description
connection	any	connection to libp2p peer

Returns: Libp2pSender

Accessors

status

• get status(): any

Inherited from Sender.status

Defined in lib/net/protocol/sender.ts:19

Returns: any

• set status(status: any): void

Inherited from Sender.status

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

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

---

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

---

error

▸ error(error: Error): void

Defined in lib/net/protocol/libp2psender.ts:83

Handle pull stream errors

Parameters:

Name	Type	Description
error	Error	error

Returns: void

---

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

---

init

▸ init(): void

Defined in lib/net/protocol/libp2psender.ts:32

Returns: 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

---

sendMessage

▸ sendMessage(code: number, data: any): void

Overrides Sender.sendMessage

Defined in lib/net/protocol/libp2psender.ts:75

Send a message to peer

Parameters:

Name	Type	Description
code	number	message code
data	any	message payload

Returns: void

---

sendStatus

▸ sendStatus(status: any): void

Overrides Sender.sendStatus

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

Send a status to peer

Parameters:

Name	Type	Description
status	any

Returns: void

---

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