DuplexStream: Duplex Stream

In ElianHugh/emitters: NodeJS-inspired events and io streams.

Description

Duplex Stream

Duplex Stream

Super classes

emitters::EventEmitter -> emitters::ReadableStream -> DuplexStream

Methods

Public methods

• DuplexStream$new()

• DuplexStream$destroy()

• DuplexStream$print()

• DuplexStream$write()

• DuplexStream$cork()

• DuplexStream$uncork()

• DuplexStream$end()

Inherited methods

• emitters::EventEmitter$add_listener()

• emitters::EventEmitter$emit()

• emitters::EventEmitter$event_names()

• emitters::EventEmitter$get_max_listeners()

• emitters::EventEmitter$listener_count()

• emitters::EventEmitter$off()

• emitters::EventEmitter$on()

• emitters::EventEmitter$once()

• emitters::EventEmitter$prepend_listener()

• emitters::EventEmitter$prepend_once_listener()

• emitters::EventEmitter$raw_listeners()

• emitters::EventEmitter$remove_all_listeners()

• emitters::EventEmitter$remove_listener()

• emitters::EventEmitter$set_max_listeners()

• emitters::ReadableStream$pause()

• emitters::ReadableStream$pipe()

• emitters::ReadableStream$push()

• emitters::ReadableStream$read()

• emitters::ReadableStream$resume()

• emitters::ReadableStream$tee()

• emitters::ReadableStream$unpipe()

• emitters::ReadableStream$unshift()

---

Method new()

Create a new DuplexStream object

Usage

DuplexStream$new(
  source_object,
  readable_highwater_mark = 16384,
  writeable_highwater_mark = readable_highwater_mark,
  readable_queue_strategy = object.size,
  writeable_queue_strategy = readable_queue_strategy,
  encoding = "unknown"
)

Arguments

source_object

a file path, connection, processx connection, or socket connection

readable_highwater_mark

maximum buffer size

writeable_highwater_mark

maximum buffer size

encoding

encoding used when reading from the connection

Returns

A new DuplexStream object. TODOC

---

Method destroy()

Usage

DuplexStream$destroy(why = NULL)

---

Method print()

Usage

DuplexStream$print()

---

Method write()

Usage

DuplexStream$write(text, encoding = private$.writeable_encoding)

---

Method cork()

Usage

DuplexStream$cork()

---

Method uncork()

Usage

DuplexStream$uncork()

---

Method end()

Usage

DuplexStream$end()

ElianHugh/emitters documentation built on Feb. 6, 2022, 4:55 a.m.