openmsx::CliConnection Class Reference

#include <CliConnection.hh>

Inheritance diagram for openmsx::CliConnection:

Collaboration diagram for openmsx::CliConnection:

Classes
struct	ParseState

Public Member Functions
virtual	~CliConnection ()
void	setUpdateEnable (CliComm::UpdateType type, bool value)
bool	getUpdateEnable (CliComm::UpdateType type) const
Public Member Functions inherited from openmsx::CliListener
virtual	~CliListener ()
virtual void	log (CliComm::LogLevel level, string_ref message)=0
virtual void	update (CliComm::UpdateType type, string_ref machine, string_ref name, string_ref value)=0

Protected Member Functions
	CliConnection (CommandController &commandController, EventDistributor &eventDistributor)
virtual void	output (string_ref message)=0
void	start ()
	Starts the helper thread.
void	end ()
	End this connection by sending the closing tag and then closing the stream.
virtual void	close ()=0
	Close the connection.
void	startOutput ()
	Send opening XML tag, should be called exactly once by a subclass shortly after opening a connection.
Protected Member Functions inherited from openmsx::CliListener
	CliListener ()
Protected Member Functions inherited from openmsx::Runnable
virtual void	run ()=0
virtual	~Runnable ()

Protected Attributes
xmlParserCtxt *	parser_context
Thread	thread

Additional Inherited Members
Private Member Functions inherited from openmsx::EventListener
virtual	~EventListener ()
virtual int	signalEvent (const std::shared_ptr< const Event > &event)=0
	This method gets called when an event you are subscribed to occurs.
	EventListener ()

Detailed Description

Definition at line 18 of file CliConnection.hh.

Constructor & Destructor Documentation

openmsx::CliConnection::~CliConnection ( )

virtual

Definition at line 93 of file CliConnection.cc.

References openmsx::OPENMSX_CLICOMMAND_EVENT, parser_context, and openmsx::EventDistributor::unregisterEventListener().

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

protected

Definition at line 68 of file CliConnection.cc.

References openmsx::CliComm::NUM_UPDATES, openmsx::OPENMSX_CLICOMMAND_EVENT, parser_context, and openmsx::EventDistributor::registerEventListener().

Member Function Documentation

virtual void openmsx::CliConnection::close ( )

protectedpure virtual

Close the connection.

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

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

Referenced by openmsx::SocketConnection::~SocketConnection().

bool openmsx::CliConnection::getUpdateEnable

(

CliComm::UpdateType

type

)

const

Definition at line 104 of file CliConnection.cc.

virtual void openmsx::CliConnection::output ( string_ref  message )

protectedpure virtual

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

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

Definition at line 99 of file CliConnection.cc.

Referenced by openmsx::UpdateCmd::execute().

void openmsx::CliConnection::start ( )

protected

Starts the helper thread.

Subclasses should call this method at the end of their constructor. Subclasses should themself send the opening tag (startOutput()).

Definition at line 141 of file CliConnection.cc.

Referenced by openmsx::SocketConnection::SocketConnection().

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

Member Data Documentation

xmlParserCtxt* openmsx::CliConnection::parser_context

protected

Definition at line 57 of file CliConnection.hh.

Referenced by CliConnection(), and ~CliConnection().

Thread openmsx::CliConnection::thread

protected

Definition at line 58 of file CliConnection.hh.

---

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

• CliConnection.hh
• CliConnection.cc