LineDiscipline
Defined in: src/drivers/tty/n_tty.ts:17
The N_TTY line discipline, i.e. drivers/tty/n_tty.c.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LineDiscipline(
tty):LineDiscipline
Defined in: src/drivers/tty/n_tty.ts:27
Parameters
Section titled “Parameters”Returns
Section titled “Returns”LineDiscipline
Properties
Section titled “Properties”buffer
Section titled “buffer”
protectedbuffer:number[] =[]
Defined in: src/drivers/tty/n_tty.ts:19
Input that is ready to be read, i.e. read_buf
protectedeof:boolean=false
Defined in: src/drivers/tty/n_tty.ts:25
Set by the EOF character, so the next read comes up empty instead of waiting
protectedline:number[] =[]
Defined in: src/drivers/tty/n_tty.ts:22
The line being typed, which isn’t readable until it is finished
protectedreadonlytty:TTY
Defined in: src/drivers/tty/n_tty.ts:27
Accessors
Section titled “Accessors”at_eof
Section titled “at_eof”Get Signature
Section titled “Get Signature”get at_eof():
boolean
Defined in: src/drivers/tty/n_tty.ts:133
Whether the terminal has been ended with the EOF character and has nothing left
Returns
Section titled “Returns”boolean
available
Section titled “available”Get Signature
Section titled “Get Signature”get available():
number
Defined in: src/drivers/tty/n_tty.ts:29
Returns
Section titled “Returns”number
canonical
Section titled “canonical”Get Signature
Section titled “Get Signature”get
protectedcanonical():boolean
Defined in: src/drivers/tty/n_tty.ts:34
Whether the terminal is handing over whole lines rather than single bytes
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”commit()
Section titled “commit()”
protectedcommit():void
Defined in: src/drivers/tty/n_tty.ts:114
Hand the line being typed over to be read, i.e. n_tty_receive_handle_newline
Returns
Section titled “Returns”void
echo()
Section titled “echo()”
protectedecho(…bytes):void
Defined in: src/drivers/tty/n_tty.ts:39
Echo bytes back to the terminal, if the terminal is set to echo
Parameters
Section titled “Parameters”…number[]
Returns
Section titled “Returns”void
flush()
Section titled “flush()”flush():
void
Defined in: src/drivers/tty/n_tty.ts:167
Throw away everything typed but not yet read, i.e. TCIFLUSH
Returns
Section titled “Returns”void
process_output()
Section titled “process_output()”process_output(
data):Uint8Array
Defined in: src/drivers/tty/n_tty.ts:141
Fix up bytes on their way to the terminal, i.e. do_output_char.
This is what turns a bare newline into the carriage return and newline a terminal actually needs.
Parameters
Section titled “Parameters”Uint8Array
Returns
Section titled “Returns”Uint8Array
push()
Section titled “push()”push(
text):void
Defined in: src/drivers/tty/n_tty.ts:174
Put text into the input queue as if it had been typed, i.e. TIOCSTI
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
read()
Section titled “read()”read(
buffer):number
Defined in: src/drivers/tty/n_tty.ts:123
Fill buffer with what is waiting and return how much that was.
Parameters
Section titled “Parameters”buffer
Section titled “buffer”Uint8Array
Returns
Section titled “Returns”number
receive()
Section titled “receive()”receive(
data):void
Defined in: src/drivers/tty/n_tty.ts:45
Take bytes that arrived from the terminal, i.e. n_tty_receive_buf.
Parameters
Section titled “Parameters”Uint8Array
Returns
Section titled “Returns”void