server-console

Description

Interfaces Implemented

Notifiers

cell-change

Notifier that is triggered after the object's cell was changed.

object-delete

Notifier that is triggered just before Simics object is deleted.

queue-change

Notifier that is triggered after the object's clock was changed. New clock can be obtained with the SIM_object_clock function.

Attributes

device

Required attribute; read/write access; type: o|n
Serial device the console is connected to.

new_port_if_busy

Optional attribute; read/write access; type: b
Determines if a new TCP port may be used when restoring from a checkpoint and the saved port is already busy. The default value is true. It may be set to false for setups that rely on the same port being used all the time.

port

Optional attribute; read/write access; type: i
TCP port for telnet console server.

recorder

Required attribute; read/write access; type: o
Recorder device for recording and playback of serial input.

buffer_until_connection

Optional attribute; read/write access; type: b
If TRUE, the console will buffer any output until a client connects. If FALSE, such output will be discarded.

raw

Optional attribute; read/write access; type: b
If set to TRUE, will not interpret telnet escapes or otherwise change the bytes transmitted in either direction.

data_in

Optional attribute; read/write access; type: [i*]
Characters received by the telnet console but not yet delivered to the simulated serial port.

output_buffer

Optional attribute; read/write access; type: [i*]
Characters transmitted by the simulated serial port, but not yet written out by the console. If buffer_until_connection is TRUE, then this attribute contains everything written to the simulated serial port.

recording

Session attribute; read/write access; type: b
When TRUE, all characters written to the console will be recorded. The record can be read from the attribute recorded-string.

recorded_string

Session attribute; read/write access; type: s
The characters that have been recorded when the attribute recording is TRUE. Note that the recorded string will NOT be cleared when recording is reset.

output_file

Optional attribute; read/write access; type: s|n
If given a file name, output will be directed to this file. Redirection is stopped by setting the attribute to NIL.

disconnect

Pseudo attribute; write-only access; type: b
Disconnects the telnet session if set to TRUE.

remote_ip

Pseudo attribute; read-only access; type: i
The remote IPv4 address.

remote_port

Pseudo attribute; read-only access; type: i
The remote TCP port number.

input_delayed

Pseudo attribute; write-only access; type: [sf]
(string, seconds) This attribute appends characters to the input queue, after the specified simulated time have elapsed.

input

Pseudo attribute; write-only access; type: s|[db]
Keyboard input queue.

break_string

Pseudo attribute; write-only access; type: s
An output string causing Simics to trigger a Xterm_Break_String hap when the string is printed.

break_string_once

Pseudo attribute; write-only access; type: s
An output string causing Simics to trigger a Xterm_Break_String hap when the string is printed. The breakpoint is removed after the first occurrence.

string_breakpoint_list

Pseudo attribute; read-only access; type: [[isi]*]
List of all string breakpoints currently active. Each string breakpoint is a tuple of (id, string, trigger_once)

unbreak_string

Pseudo attribute; write-only access; type: s
Stop breaking on a specified string. Note that if a string is added several times, it also has to be removed the same number of times. I.e. if a hap callback is tied to a string and does not want to be called again, it should both remove the string and unregister the hap callback, since another hap callback may want to break on the same string again.

unbreak_id

Pseudo attribute; write-only access; type: i
Remove breakpoint based on breakpoint id.

break_string_id

Pseudo attribute; read-only access; type: Unknown
Return an id for a string that is set to break on. The id can be used as index for the Xterm_Break_String hap.

Provided By