#include <CliConnection.hh>
Public Member Functions | |
| void | setUpdateEnable (CliComm::UpdateType type, bool value) |
| bool | getUpdateEnable (CliComm::UpdateType type) const |
| void | start () |
| Starts the helper thread. More... | |
 Public Member Functions inherited from openmsx::CliListener | |
| virtual | ~CliListener () |
Protected Member Functions | |
| CliConnection (CommandController &commandController, EventDistributor &eventDistributor) | |
| ~CliConnection () | |
| virtual void | output (string_ref message)=0 |
| void | end () |
| End this connection by sending the closing tag and then closing the stream. More... | |
| virtual void | close ()=0 |
| Close the connection. More... | |
| void | startOutput () |
| Send opening XML tag, should be called exactly once by a subclass shortly after opening a connection. More... | |
| Protected Member Functions inherited from openmsx::CliListener | |
| CliListener () | |
Protected Attributes | |
| AdhocCliCommParser | parser |
| Poller | poller |
Detailed Description
Definition at line 19 of file CliConnection.hh.
Constructor & Destructor Documentation
◆ CliConnection()
|
protected |
Definition at line 68 of file CliConnection.cc.
References openmsx::OPENMSX_CLICOMMAND_EVENT, and openmsx::EventDistributor::registerEventListener().
Referenced by getUpdateEnable().
◆ ~CliConnection()
|
protected |
Definition at line 81 of file CliConnection.cc.
References string_ref::empty(), openmsx::CliComm::getLevelStrings(), getUpdateEnable(), openmsx::CliComm::getUpdateStrings(), openmsx::OPENMSX_CLICOMMAND_EVENT, output(), string_ref::str(), openmsx::EventDistributor::unregisterEventListener(), and openmsx::XMLElement::XMLEscape().
Referenced by getUpdateEnable().
Member Function Documentation
◆ close()
|
protectedpure virtual |
Close the connection.
After this method is called, calls to output() should be ignored.
Referenced by getUpdateEnable().
◆ end()
|
protected |
End this connection by sending the closing tag and then closing the stream.
Subclasses should call this method at the start of their destructor.
Definition at line 123 of file CliConnection.cc.
Referenced by getUpdateEnable(), openmsx::StdioConnection::output(), and openmsx::SocketConnection::~SocketConnection().
◆ getUpdateEnable()
|
inline |
Definition at line 25 of file CliConnection.hh.
References CliConnection(), close(), end(), output(), start(), startOutput(), and ~CliConnection().
Referenced by ~CliConnection().
◆ output()
|
protectedpure virtual |
Implemented in openmsx::SocketConnection, and openmsx::StdioConnection.
Referenced by getUpdateEnable(), and ~CliConnection().
◆ setUpdateEnable()
|
inline |
Definition at line 22 of file CliConnection.hh.
Referenced by openmsx::GlobalCommandController::tabCompletion().
◆ start()
| void openmsx::CliConnection::start | ( | ) |
Starts the helper thread.
Called when this CliConnection is added to GlobalCliComm (and after it's allowed to respond to external commands). Subclasses should themself send the opening tag (startOutput()).
Definition at line 118 of file CliConnection.cc.
Referenced by getUpdateEnable().
◆ startOutput()
|
protected |
Send opening XML tag, should be called exactly once by a subclass shortly after opening a connection.
Cannot be implemented in the base class because some subclasses (want to send data before this tag).
Definition at line 113 of file CliConnection.cc.
Referenced by getUpdateEnable(), openmsx::StdioConnection::output(), and openmsx::SocketConnection::~SocketConnection().
Member Data Documentation
◆ parser
|
protected |
Definition at line 61 of file CliConnection.hh.
Referenced by openmsx::StdioConnection::output(), and openmsx::SocketConnection::~SocketConnection().
◆ poller
|
protected |
Definition at line 62 of file CliConnection.hh.
Referenced by openmsx::SocketConnection::output(), and openmsx::SocketConnection::~SocketConnection().
The documentation for this class was generated from the following files:
