Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
ConsoleLine Class Reference

ConsoleLine is the console line handler for the TerminalLine object. More...

Inheritance diagram for ConsoleLine:
TerminalLine

Public Member Functions

string getOutput ()
 Returns the output from the console line. More...
 
void idledOut ()
 When the terminal line idles out this event is generated. More...
 
- Public Member Functions inherited from TerminalLine
string getName ()
 Returns the name of this terminal line. More...
 
Device getOwnerDevice ()
 Returns the owner device of this terminal line. More...
 
string getMode ()
 Returns the mode this terminal line is in. More...
 
string getPrompt ()
 Returns the prompt of this terminal line. More...
 
CommandHistory getUserHistory ()
 Returns the user history of this terminal line. More...
 
CommandHistory getConfigHistory ()
 Returns the config history of this terminal line. More...
 
CommandHistory getCurrentHistory ()
 Returns the current history of this terminal line. More...
 
int getHistorySize ()
 Returns the history size. More...
 
string getCommandInput ()
 Returns the command input. More...
 
int getTelnetClientCount ()
 Returns the number of telnet clients. More...
 
TelnetClientProcess getTelnetClientAt (int)
 Returns the telnet client at the specified index. More...
 
void enterCommand (string)
 Enters a command to the terminal line. More...
 
void terminalUpdated (string)
 IPC event. More...
 
void moreDisplayed ()
 Event happens when a –More– display is generated. More...
 
void enterChar (byte, SpecialChar)
 Enters the specified ascii or special character into the terminal. More...
 
void outputWritten (string, bool, int)
 This event is emitted when output is written to the terminal line. More...
 
void cursorPositionChanged (int)
 This event is emitted when the cursor position has moved to the specified position from the end of the terminal. More...
 
void directiveSent (DirectiveCommand, int)
 This event is emitted when a directive command is sent. More...
 
void commandStarted (string, string, string, string)
 This event is emitted when a command has started. More...
 
void commandEnded (string, CommandStatus)
 This event is emitted when a command has ended. More...
 
void commandAutoCompleted (string, string)
 This event is emitted when a command has been auto completed. More...
 
void modeChanged (string, string, string)
 This event is emitted when the mode has changed. More...
 
void promptChanged (string)
 This event is emitted when the prompt has changed. More...
 
void commandSelectedFromHistory (string)
 This event is emitted when a command from the history has been selected. More...
 
void setSettings (int, string, Parity, string, FlowControl)
 Sets the connection settings to this terminal. More...
 
int getSpeed () const
 
byte getDataBits () const
 
Parity getParity () const
 
string getStopBits () const
 
FlowControl getFlowControl () const
 
void println (string)
 This function gets the flow control. More...
 
void flush (int)
 This function remove the first number of lines in the buffer. More...
 

Detailed Description

ConsoleLine is the console line handler for the TerminalLine object.

Member Function Documentation

◆ getOutput()

string ConsoleLine::getOutput ( )

Returns the output from the console line.

Parameters
string,theoutput from the console line.

◆ idledOut()

void ConsoleLine::idledOut ( )

When the terminal line idles out this event is generated.

IPC event.


The documentation for this class was generated from the following file: