openmsx::CliConnection Class Reference

#include <CliConnection.hh>

Inheritance diagram for openmsx::CliConnection:

Collaboration diagram for openmsx::CliConnection:

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 ()=default

Protected Member Functions
	CliConnection (CommandController &commandController, EventDistributor &eventDistributor)
	~CliConnection () override
virtual void	output (std::string_view 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 ()=default

Protected Attributes
AdhocCliCommParser	parser
Poller	poller

Detailed Description

Definition at line 19 of file CliConnection.hh.

Constructor & Destructor Documentation

CliConnection()

openmsx::CliConnection::CliConnection ( CommandController &  commandController, EventDistributor &  eventDistributor  )

protected

Definition at line 67 of file CliConnection.cc.

References ranges::fill(), openmsx::OPENMSX_CLICOMMAND_EVENT, and openmsx::EventDistributor::registerEventListener().

Referenced by getUpdateEnable(), and openmsx::StdioConnection::output().

~CliConnection()

openmsx::CliConnection::~CliConnection ( )

overrideprotected

Definition at line 78 of file CliConnection.cc.

References openmsx::CliComm::getLevelStrings(), getUpdateEnable(), openmsx::CliComm::getUpdateStrings(), openmsx::OPENMSX_CLICOMMAND_EVENT, output(), strAppend(), strCat(), openmsx::EventDistributor::unregisterEventListener(), and openmsx::XMLElement::XMLEscape().

Referenced by getUpdateEnable().

Member Function Documentation

close()

virtual void openmsx::CliConnection::close ( )

protectedpure virtual

Close the connection.

After this method is called, calls to output() should be ignored.

Referenced by end(), and getUpdateEnable().

end()

void openmsx::CliConnection::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 118 of file CliConnection.cc.

References openmsx::Poller::abort(), close(), openmsx::EventDistributor::distributeEvent(), output(), poller, strCat(), and openmsx::XMLElement::XMLEscape().

Referenced by getUpdateEnable(), openmsx::StdioConnection::output(), openmsx::SocketConnection::~SocketConnection(), and openmsx::StdioConnection::~StdioConnection().

getUpdateEnable()

bool openmsx::CliConnection::getUpdateEnable ( CliComm::UpdateType  type ) const

inline

Definition at line 25 of file CliConnection.hh.

References CliConnection(), close(), end(), output(), start(), startOutput(), and ~CliConnection().

Referenced by ~CliConnection().

output()

virtual void openmsx::CliConnection::output ( std::string_view  message )

protectedpure virtual

Implemented in openmsx::SocketConnection, and openmsx::StdioConnection.

Referenced by end(), getUpdateEnable(), startOutput(), and ~CliConnection().

setUpdateEnable()

void openmsx::CliConnection::setUpdateEnable ( CliComm::UpdateType  type, bool  value  )

inline

Definition at line 22 of file CliConnection.hh.

Referenced by openmsx::GlobalCommandController::source().

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 113 of file CliConnection.cc.

Referenced by getUpdateEnable().

startOutput()

void openmsx::CliConnection::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 108 of file CliConnection.cc.

References output().

Referenced by getUpdateEnable(), openmsx::StdioConnection::output(), openmsx::StdioConnection::StdioConnection(), and openmsx::SocketConnection::~SocketConnection().

Member Data Documentation

parser

AdhocCliCommParser openmsx::CliConnection::parser

protected

Definition at line 61 of file CliConnection.hh.

Referenced by openmsx::StdioConnection::output(), and openmsx::SocketConnection::~SocketConnection().

poller

Poller openmsx::CliConnection::poller

protected

Definition at line 62 of file CliConnection.hh.

Referenced by end(), openmsx::SocketConnection::output(), openmsx::SocketConnection::~SocketConnection(), and openmsx::StdioConnection::~StdioConnection().

---

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

• CliConnection.hh
• CliConnection.cc