DebugIOCon Class Reference

#include <internal_io.h>

Inherits DebugIOInterface.

Public Member Functions
	DebugIOCon (void)
virtual	~DebugIOCon ()
virtual int	Read (char *buf, int maxchar)
	Retrieves up to the given number of characters from a command input source.
virtual void	Write (StringType type, const char *src, const char *str)
	Write out some characters differentiated by the log string type.
virtual void	EmergencyFlush (void)
	Emergency shutdown function.
virtual void	Execute (class Debug &dbg, const char *cmd, bool structuredCmd, unsigned argn, const char *const *argv)
	I/O class specific command.
virtual void	Delete (void)
	Destroys the current I/O class instance.
Public Member Functions inherited from DebugIOInterface
	DebugIOInterface (void)

Static Public Member Functions
static DebugIOInterface *	Create (void)

Additional Inherited Members
Public Types inherited from DebugIOInterface
enum	StringType {   Assert = 0 , Check , Log , Crash ,   Exception , CmdReply , StructuredCmdReply , Other ,   MAX }
	List of possible log string types. More...
Protected Member Functions inherited from DebugIOInterface
virtual	~DebugIOInterface ()
	I/O class destructor.

Detailed Description

Definition at line 36 of file internal_io.h.

Constructor & Destructor Documentation

DebugIOCon()

DebugIOCon::DebugIOCon ( void )

explicit

Definition at line 33 of file debug_io_con.cpp.

~DebugIOCon()

DebugIOCon::~DebugIOCon ( )

virtual

Definition at line 64 of file debug_io_con.cpp.

Member Function Documentation

Create()

DebugIOInterface * DebugIOCon::Create ( void )

static

Definition at line 221 of file debug_io_con.cpp.

Delete()

void DebugIOCon::Delete ( void )

virtual

Destroys the current I/O class instance.

Use this function instead of just delete'ing the instance.

Implements DebugIOInterface.

Definition at line 226 of file debug_io_con.cpp.

EmergencyFlush()

virtual void DebugIOCon::EmergencyFlush ( void )

inlinevirtual

Emergency shutdown function.

This function gets called during an exception and should perform the absolute bare minimum (e.g. just flushing and closing the output file).

Implements DebugIOInterface.

Definition at line 66 of file internal_io.h.

Execute()

void DebugIOCon::Execute ( class Debug & dbg, const char * cmd, bool structuredCmd, unsigned argn, const char *const * argv )

virtual

I/O class specific command.

All io <class> commands are passed into this function, with the exception of remove which results in simply calling the class destructor.

Parameters

dbg	debug instance
cmd	command issued
structuredCmd	true if structured command reply, false if not
argn	number of additional arguments passed in
argv	argument list

Implements DebugIOInterface.

Definition at line 192 of file debug_io_con.cpp.

Read()

int DebugIOCon::Read ( char * buf, int maxchar )

virtual

Retrieves up to the given number of characters from a command input source.

This source can be e.g. keyboard or a network pipe. This function must not block.

Parameters

buf	buffer to place read characters in
maxchar	maximum number of characters to return

Returns

numbers of characters written to buffer

Note

There is no terminating NUL char written to the buffer

@todo_opt if somebody wants this can be improved by adding support for cursor keys, history, etc

Implements DebugIOInterface.

Definition at line 71 of file debug_io_con.cpp.

Write()

void DebugIOCon::Write ( StringType type, const char * src, const char * str )

virtual

Write out some characters differentiated by the log string type.

Parameters

type	possible string type
src	string source, may be NULL, content depends on type: type src Assert file(line) Check file(line) Log log group Crash file(line) Exception NULL CmdReply group.command StructuredCmdReply group.command Other NULL
str	string to output, NUL delimited, if NULL then simply flush output (if applicable)

Implements DebugIOInterface.

Definition at line 183 of file debug_io_con.cpp.

---

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

• Code/Libraries/Source/debug/internal_io.h
• Code/Libraries/Source/debug/debug_io_con.cpp