StreamProtocolParser::Protocol Class Reference

#include <StreamProtocol.h>

Collaboration diagram for StreamProtocolParser::Protocol:

Public Member Functions
bool	getNumberVariable (const char *varname, unsigned long &value, unsigned long max=0xFFFFFFFF)
bool	getEnumVariable (const char *varname, unsigned short &value, const char **enumstrings)
bool	getStringVariable (const char *varname, StreamBuffer &value, bool *defined=NULL)
bool	getCommands (const char *handlername, StreamBuffer &code, Client *)
bool	compileNumber (unsigned long &number, const char *&source, unsigned long max=0xFFFFFFFF)
bool	compileString (StreamBuffer &buffer, const char *&source, FormatType formatType=NoFormat, Client *=NULL, int quoted=false)
bool	checkUnused ()
	~Protocol ()
void	report ()
Data Fields
const StreamBuffer	filename
Private Member Functions
	Protocol (const char *filename)
	Protocol (const Protocol &p, StreamBuffer &name, int line)
StreamBuffer *	createVariable (const char *name, int line)
bool	compileFormat (StreamBuffer &, const char *&source, FormatType, Client *)
bool	compileCommands (StreamBuffer &, const char *&source, Client *)
bool	replaceVariable (StreamBuffer &, const char *varname)
const Variable *	getVariable (const char *name)
Private Attributes
Protocol *	next
Variable *	variables
const StreamBuffer	protocolname
StreamBuffer *	commands
int	line
const char *	parameter [10]
Friends
class	StreamProtocolParser

---

Detailed Description

Definition at line 40 of file StreamProtocol.h.

---

Constructor & Destructor Documentation

StreamProtocolParser::Protocol::Protocol

(

const char *

filename

)

[private]

StreamProtocolParser::Protocol::Protocol	(	const Protocol &	p,
		StreamBuffer &	name,
		int	line
	)			[private]

StreamProtocolParser::Protocol::~Protocol

(

)

---

Member Function Documentation

bool StreamProtocolParser::Protocol::checkUnused

(

)

bool StreamProtocolParser::Protocol::compileCommands	(	StreamBuffer &	,
		const char *&	source,
		Client *
	)			[private]

bool StreamProtocolParser::Protocol::compileFormat	(	StreamBuffer &	,
		const char *&	source,
		FormatType	,
		Client *
	)			[private]

bool StreamProtocolParser::Protocol::compileNumber	(	unsigned long &	number,
		const char *&	source,
		unsigned long	max = 0xFFFFFFFF
	)

bool StreamProtocolParser::Protocol::compileString	(	StreamBuffer &	buffer,
		const char *&	source,
		FormatType	formatType = NoFormat,
		Client *	= NULL,
		int	quoted = false
	)

StreamBuffer* StreamProtocolParser::Protocol::createVariable	(	const char *	name,
		int	line
	)			[private]

bool StreamProtocolParser::Protocol::getCommands	(	const char *	handlername,
		StreamBuffer &	code,
		Client *
	)

bool StreamProtocolParser::Protocol::getEnumVariable	(	const char *	varname,
		unsigned short &	value,
		const char **	enumstrings
	)

bool StreamProtocolParser::Protocol::getNumberVariable	(	const char *	varname,
		unsigned long &	value,
		unsigned long	max = 0xFFFFFFFF
	)

bool StreamProtocolParser::Protocol::getStringVariable	(	const char *	varname,
		StreamBuffer &	value,
		bool *	defined = NULL
	)

const Variable* StreamProtocolParser::Protocol::getVariable

(

const char *

name

)

[private]

bool StreamProtocolParser::Protocol::replaceVariable	(	StreamBuffer &	,
		const char *	varname
	)			[private]

void StreamProtocolParser::Protocol::report

(

)

---

Friends And Related Function Documentation

friend class StreamProtocolParser [friend]

Definition at line 42 of file StreamProtocol.h.

---

Field Documentation

StreamBuffer* StreamProtocolParser::Protocol::commands [private]

Definition at line 50 of file StreamProtocol.h.

const StreamBuffer StreamProtocolParser::Protocol::filename

Definition at line 65 of file StreamProtocol.h.

int StreamProtocolParser::Protocol::line [private]

Definition at line 51 of file StreamProtocol.h.

Protocol* StreamProtocolParser::Protocol::next [private]

Definition at line 47 of file StreamProtocol.h.

const char* StreamProtocolParser::Protocol::parameter[10] [private]

Definition at line 52 of file StreamProtocol.h.

const StreamBuffer StreamProtocolParser::Protocol::protocolname [private]

Definition at line 49 of file StreamProtocol.h.

Variable* StreamProtocolParser::Protocol::variables [private]

Definition at line 48 of file StreamProtocol.h.

---

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

• epics/apps/crucible/stream/src/StreamProtocol.h (r4864/r2310)