Console is helper class that lets the developer control the game from TCP connection. More...

#include <CCConsole.h>

Classes
struct	Command

Public Member Functions
	Console ()
	Constructor. More...

	Console ()
	Constructor. More...

virtual	~Console ()
	Destructor. More...

local	~Console ()
	Destructor. More...

bool	listenOnTCP (int port)
	starts listening to specifed TCP port More...

var	listenOnTCP ( var port)
	starts listening to specifed TCP port More...

local	listenOnTCP ( local port)
	starts listening to specifed TCP port More...

bool	listenOnFileDescriptor (int fd)
	starts listening to specifed file descriptor More...

var	listenOnFileDescriptor ( var fd)
	starts listening to specifed file descriptor More...

local	listenOnFileDescriptor ( local fd)
	starts listening to specifed file descriptor More...

void	stop ()
	stops the Console. More...

var	stop ()
	stops the Console. More...

local	stop ()
	stops the Console. More...

void	setUserCommands (Command *commands, int numberOfCommands)
	sets user tokens More...

var	setUserCommands ( var commands, var numberOfCommands)
	sets user tokens More...

local	setUserCommands ( local commands, local numberOfCommands)
	sets user tokens More...

void	log (const char *buf)
	log something in the console More...

Protected Member Functions
void	loop ()
ssize_t	readline (int fd)
var	readline ( var fd)
local	readline ( local fd)
bool	parseCommand (int fd)
var	parseCommand ( var fd)
local	parseCommand ( local fd)
void	sendPrompt (int fd)
var	sendPrompt ( var fd)
local	sendPrompt ( local fd)
void	addClient ()
void	commandHelp (int fd, const char *command)
var	commandHelp ( var fd, var command)
local	commandHelp ( local fd, local command)
void	commandExit (int fd, const char *command)
local	commandExit ( local fd, local command)
void	commandSceneGraph (int fd, const char *command)
var	commandSceneGraph ( var fd, var command)
local	commandSceneGraph ( local fd, local command)
void	commandFileUtilsDump (int fd, const char *command)
var	commandFileUtilsDump ( var fd, var command)
local	commandFileUtilsDump ( local fd, local command)
void	commandConfig (int fd, const char *command)
var	commandConfig ( var fd, var command)
local	commandConfig ( local fd, local command)
void	commandTextures (int fd, const char *command)
var	commandTextures ( var fd, var command)
local	commandTextures ( local fd, local command)

Protected Attributes
int	_listenfd
int	_maxfd
var	_maxfd
local	_maxfd
std::vector< int >	_fds
var	_fds
local	_fds
std::thread	_thread
var	_thread
local	_thread
fd_set	_read_set
var	_read_set
local	_read_set
bool	_running
var	_running
local	_running
bool	_endThread
var	_endThread
local	_endThread
char	_buffer [512]
var	_buffer ()
local	_buffer ()
struct Command	_commands [64]
var	_commands ()
local	_commands ()
int	_maxCommands
var	_maxCommands
local	_maxCommands
struct Command *	_userCommands
var	_userCommands
local	_userCommands
int	_maxUserCommands
var	_maxUserCommands
local	_maxUserCommands
bool	_sendDebugStrings
var	_sendDebugStrings
local	_sendDebugStrings
std::mutex	_DebugStringsMutex
var	_DebugStringsMutex
local	_DebugStringsMutex
std::vector< std::string >	_DebugStrings
var	_DebugStrings
local	_DebugStrings

Detailed Description

Console is helper class that lets the developer control the game from TCP connection.

Console will spawn a new thread that will listen to a specified TCP port. Console has a basic token parser. Each token is associated with an std::function<void(int)>. If the std::function<> needs to use the cocos2d API, it needs to call

``` scheduler->performFunctionInCocosThread( ... ); ```

Constructor & Destructor Documentation

Console ( )

Constructor.

var Console ( )

Constructor.

local Console ( )

Constructor.

virtual ~Console ( )

virtual

Destructor.

var ~Console ( )

virtual

Destructor.

local ~Console ( )

virtual

Destructor.

Member Function Documentation

void addClient ( )

protected

var addClient ( )

protected

local addClient ( )

protected

void commandConfig	(	int	fd,
		const char *	command
	)

protected

var commandConfig	(	var	fd,
		var	command
	)

protected

local commandConfig	(	local	fd,
		local	command
	)

protected

void commandExit	(	int	fd,
		const char *	command
	)

protected

var commandExit	(	var	fd,
		var	command
	)

protected

local commandExit	(	local	fd,
		local	command
	)

protected

void commandFileUtilsDump	(	int	fd,
		const char *	command
	)

protected

var commandFileUtilsDump	(	var	fd,
		var	command
	)

protected

local commandFileUtilsDump	(	local	fd,
		local	command
	)

protected

void commandHelp	(	int	fd,
		const char *	command
	)

protected

var commandHelp	(	var	fd,
		var	command
	)

protected

local commandHelp	(	local	fd,
		local	command
	)

protected

void commandSceneGraph	(	int	fd,
		const char *	command
	)

protected

var commandSceneGraph	(	var	fd,
		var	command
	)

protected

local commandSceneGraph	(	local	fd,
		local	command
	)

protected

void commandTextures	(	int	fd,
		const char *	command
	)

protected

var commandTextures	(	var	fd,
		var	command
	)

protected

local commandTextures	(	local	fd,
		local	command
	)

protected

bool listenOnFileDescriptor ( int fd)

starts listening to specifed file descriptor

var listenOnFileDescriptor ( var fd)

starts listening to specifed file descriptor

local listenOnFileDescriptor ( local fd)

starts listening to specifed file descriptor

bool listenOnTCP ( int port)

starts listening to specifed TCP port

var listenOnTCP ( var port)

starts listening to specifed TCP port

local listenOnTCP ( local port)

starts listening to specifed TCP port

void log ( const char * buf)

log something in the console

var log ( var buf)

log something in the console

local log ( local buf)

log something in the console

void loop ( )

protected

var loop ( )

protected

local loop ( )

protected

bool parseCommand ( int fd)

protected

var parseCommand ( var fd)

protected

local parseCommand ( local fd)

protected

ssize_t readline ( int fd)

protected

var readline ( var fd)

protected

local readline ( local fd)

protected

void sendPrompt ( int fd)

protected

var sendPrompt ( var fd)

protected

local sendPrompt ( local fd)

protected

void setUserCommands	(	Command *	commands,
		int	numberOfCommands
	)

sets user tokens

var setUserCommands	(	var	commands,
		var	numberOfCommands
	)

sets user tokens

local setUserCommands	(	local	commands,
		local	numberOfCommands
	)

sets user tokens

void stop ( )

stops the Console.

'stop' will be called at destruction time as well

var stop ( )

stops the Console.

'stop' will be called at destruction time as well

local stop ( )

stops the Console.

'stop' will be called at destruction time as well

Member Data Documentation

char _buffer[512]

protected

char _buffer[512]

protected

char _buffer[512]

protected

struct Command _commands[64]

protected

struct Command _commands[64]

protected

struct Command _commands[64]

protected

std::vector<std::string>
_DebugStrings

protected

var _DebugStrings

protected

local _DebugStrings

protected

std::mutex _DebugStringsMutex

protected

var _DebugStringsMutex

protected

local _DebugStringsMutex

protected

bool _endThread

protected

var _endThread

protected

local _endThread

protected

std::vector<int> _fds

protected

var _fds

protected

local _fds

protected

int _listenfd

protected

var _listenfd

protected

local _listenfd

protected

int _maxCommands

protected

var _maxCommands

protected

local _maxCommands

protected

int _maxfd

protected

var _maxfd

protected

local _maxfd

protected

int _maxUserCommands

protected

var _maxUserCommands

protected

local _maxUserCommands

protected

fd_set _read_set

protected

var _read_set

protected

local _read_set

protected

bool _running

protected

var _running

protected

local _running

protected

bool _sendDebugStrings

protected

var _sendDebugStrings

protected

local _sendDebugStrings

protected

std::thread _thread

protected

var _thread

protected

local _thread

protected

struct Command* _userCommands

protected

var _userCommands

protected

local _userCommands

protected

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

/Users/cocos2d/MyWork/cocos2d-x-develop/cocos/base/CCConsole.h

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation