silent informational response object More...

#include <BESSilentInfo.h>

Inheritance diagram for BESSilentInfo:

Public Member Functions
virtual void	add_break (unsigned long num_breaks)
	add a line break to the information More...

virtual void	add_data (const string &s)
	add data to the inforamtional object More...

virtual void	add_data_from_file (const string &key, const string &name)
	ignore data from a file to the informational object. More...

virtual void	add_exception (BESError &e, const string &admin)
	ignore exception data to this informational object. If buffering is not set then the information is output directly to the output stream. More...

virtual void	add_space (unsigned long num_spaces)
	add a space to the informational response More...

virtual void	add_tag (const string &tag_name, const string &tag_data, map< string, string > *attrs=0)
	add tagged information to the inforamtional response More...

virtual void	begin_response (const string &response_name, BESDataHandlerInterface &dhi)
	begin the informational response More...

virtual void	begin_tag (const string &tag_name, map< string, string > *attrs=0)
	begin a tagged part of the information, information to follow More...

	BESSilentInfo ()
	constructs an informational object that doesn't write any output to the stream

virtual void	dump (ostream &strm) const
	dumps information about this object More...

virtual void	end_response ()

virtual void	end_tag (const string &tag_name)
	end a tagged part of the informational response More...

virtual bool	is_buffered ()
	return whether the information is to be buffered or not. More...

virtual void	print (ostream &strm)
	printg this informational object More...

virtual void	transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
	transmit this informational object More...

Protected Attributes
bool	_buffered

string	_response_name

bool	_response_started

ostream *	_strm

bool	_strm_owned

stack< string >	_tags

Detailed Description

This class ignores any data added to an informational object and ignores the print command. Basically, it is silent!

See also: BESResponseObject

Definition at line 49 of file BESSilentInfo.h.

Member Function Documentation

void BESSilentInfo::add_break ( unsigned long num_breaks )

virtual

because this is a silent response, nothing is added

Parameters

num_breaks number of breaks to be added

Implements BESInfo.

Definition at line 127 of file BESSilentInfo.cc.

void BESSilentInfo::add_data ( const string & s )

virtual

because this is a silent response, nothing is added

Parameters

s	information to be ignored

Reimplemented from BESInfo.

Definition at line 105 of file BESSilentInfo.cc.

void BESSilentInfo::add_data_from_file	(	const string &	key,
		const string &	name
	)

virtual

Parameters

key	Key from the initialization file specifying the file to be
name	naem information to add to error messages loaded.

Reimplemented from BESInfo.

Definition at line 138 of file BESSilentInfo.cc.

void BESSilentInfo::add_exception	(	BESError &	e,
		const string &	admin
	)

virtual

Parameters

e	the exception to be added to this informational object
admin	The contact information for the person responsible for this error

See also: BESError

Reimplemented from BESInfo.

Definition at line 151 of file BESSilentInfo.cc.

void BESSilentInfo::add_space ( unsigned long num_spaces )

virtual

because this is a silent response, nothing is added

Parameters

num_spaces number of spaces to add

Implements BESInfo.

Definition at line 116 of file BESSilentInfo.cc.

void BESSilentInfo::add_tag	(	const string &	tag_name,
		const string &	tag_data,
		map< string, string > *	attrs = `0`
	)

virtual

Parameters

tag_name	name of the tag to add to the infroamtional response
tag_data	information describing the tag
attrs	map of attributes to add to the tag

Implements BESInfo.

Definition at line 68 of file BESSilentInfo.cc.

void BESSilentInfo::begin_response	(	const string &	response_name,
		BESDataHandlerInterface &	dhi
	)

virtual

Because this is silent, there is nothing to do

Parameters

response_name	name of the response represented by the information
dhi	information about the request and response

Reimplemented from BESInfo.

Definition at line 55 of file BESSilentInfo.cc.

References BESInfo::begin_response().

void BESSilentInfo::begin_tag	(	const string &	tag_name,
		map< string, string > *	attrs = `0`
	)

virtual

Parameters

tag_name	name of the tag to begin
attrs	map of attributes to begin the tag with

Reimplemented from BESInfo.

Definition at line 80 of file BESSilentInfo.cc.

void BESSilentInfo::dump ( ostream & strm ) const

virtual

Displays the pointer value of this instance

Parameters

strm	C++ i/o stream to dump the information to

Reimplemented from BESInfo.

Definition at line 186 of file BESSilentInfo.cc.

References BESInfo::dump().

void BESSilentInfo::end_tag ( const string & tag_name )

virtual

If the named tag is not the current tag then an error is thrown.

Parameters

tag_name name of the tag to end

Reimplemented from BESInfo.

Definition at line 93 of file BESSilentInfo.cc.

virtual bool BESInfo::is_buffered ( )

inlinevirtualinherited

Returns: true if information is buffered, false if not

Definition at line 123 of file BESInfo.h.

References BESInfo::dump().

void BESSilentInfo::print ( ostream & strm )

virtual

Nothing is to be printed as this is a silent object

Parameters

strm	stream to send output to if not ignored.

Reimplemented from BESInfo.

Definition at line 175 of file BESSilentInfo.cc.

void BESSilentInfo::transmit	(	BESTransmitter *	transmitter,
		BESDataHandlerInterface &	dhi
	)

virtual

Nothing is to be transmotted as this is silent

Parameters

transmitter	The type of transmitter to use to transmit the info
dhi	information to help with the transmission

Implements BESInfo.

Definition at line 163 of file BESSilentInfo.cc.

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

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation