openMSX
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
openmsx::CliConnection Class Referenceabstract

#include <CliConnection.hh>

Inheritance diagram for openmsx::CliConnection:
Inheritance graph
[legend]
Collaboration diagram for openmsx::CliConnection:
Collaboration graph
[legend]

Public Member Functions

virtual ~CliConnection ()
 
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)
 
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 Member Functions inherited from openmsx::Runnable
virtual ~Runnable ()
 
virtual void run ()=0
 

Protected Attributes

xmlParserCtxt * parser_context
 
Thread thread
 

Detailed Description

Definition at line 18 of file CliConnection.hh.

Constructor & Destructor Documentation

openmsx::CliConnection::~CliConnection ( )
virtual
openmsx::CliConnection::CliConnection ( CommandController commandController,
EventDistributor eventDistributor 
)
protected

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

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

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 58 of file CliConnection.hh.

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

Thread openmsx::CliConnection::thread
protected

Definition at line 59 of file CliConnection.hh.


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