HydraExpress™ C++ API Reference Guide

Product Documentation:
   HydraExpress C++
Documentation Home
List of all members | Public Member Functions
rwsf::ServletOutputStream Class Reference

Output stream for writing a response. More...

#include <rwsf/servlet/ServletOutputStream.h>

Public Member Functions

virtual ~ServletOutputStream ()
 
std::string getBuffer () const
 
ServletOutputStream & print (bool b)
 
ServletOutputStream & print (char c)
 
ServletOutputStream & print (unsigned char uc)
 
ServletOutputStream & print (short s)
 
ServletOutputStream & print (unsigned short s)
 
ServletOutputStream & print (int s)
 
ServletOutputStream & print (unsigned int s)
 
ServletOutputStream & print (long s)
 
ServletOutputStream & print (unsigned long s)
 
ServletOutputStream & print (long long s)
 
ServletOutputStream & print (unsigned long long s)
 
ServletOutputStream & print (float s)
 
ServletOutputStream & print (double s)
 
ServletOutputStream & print (const char *s)
 
ServletOutputStream & print (const unsigned char *s)
 
ServletOutputStream & print (const std::string &str)
 
ServletOutputStream & println ()
 
ServletOutputStream & println (bool b)
 
ServletOutputStream & println (char c)
 
ServletOutputStream & println (unsigned char uc)
 
ServletOutputStream & println (short s)
 
ServletOutputStream & println (unsigned short s)
 
ServletOutputStream & println (int s)
 
ServletOutputStream & println (unsigned int s)
 
ServletOutputStream & println (long s)
 
ServletOutputStream & println (unsigned long s)
 
ServletOutputStream & println (long long s)
 
ServletOutputStream & println (unsigned long long s)
 
ServletOutputStream & println (float s)
 
ServletOutputStream & println (double s)
 
ServletOutputStream & println (const char *s)
 
ServletOutputStream & println (const unsigned char *s)
 
ServletOutputStream & println (const std::string &str)
 
void reset ()
 
void reset (const std::string &newContents)
 

Detailed Description

rwsf::ServletOutputStream provides a simple mechanism for writing a response. The class has a set of print() and println() functions that duplicate the corresponding methods in the Java ServletOutputStream class. A print() method writes the argument to the output stream. A println() method writes the argument and a newline to the output stream.

Note
The print(bool) and println(bool) functions follow Java conventions and produce true and false rather than 1 and 0.

To construct an instance of this class, call either rwsf::ServletResponse::getOutputStream() or rwsf::ServletResponse::getWriter().

Constructor & Destructor Documentation

virtual rwsf::ServletOutputStream::~ServletOutputStream ( )
virtual

Destructor.

Member Function Documentation

std::string rwsf::ServletOutputStream::getBuffer ( ) const

Returns the contents of the output buffer as a string.

ServletOutputStream& rwsf::ServletOutputStream::print ( bool  b)

Appends a bool value to the payload. This function appends the string true or the string false rather than 1 or 0.

ServletOutputStream& rwsf::ServletOutputStream::print ( char  c)

Appends a char value to the payload.

ServletOutputStream& rwsf::ServletOutputStream::print ( unsigned char  uc)

Appends an unsigned char to the payload.

ServletOutputStream& rwsf::ServletOutputStream::print ( short  s)

Appends a short value to the payload.

ServletOutputStream& rwsf::ServletOutputStream::print ( unsigned short  s)

Appends an unsigned short value to the payload.

ServletOutputStream& rwsf::ServletOutputStream::print ( int  s)

Appends an int value to the payload.

ServletOutputStream& rwsf::ServletOutputStream::print ( unsigned int  s)

Appends an unsigned int to the payload.

ServletOutputStream& rwsf::ServletOutputStream::print ( long  s)

Appends a long value to the payload.

ServletOutputStream& rwsf::ServletOutputStream::print ( unsigned long  s)

Appends an unsigned long value to the payload.

ServletOutputStream& rwsf::ServletOutputStream::print ( long long  s)

Appends a long long value to the payload.

ServletOutputStream& rwsf::ServletOutputStream::print ( unsigned long long  s)

Appends an unsigned long long value to the payload.

ServletOutputStream& rwsf::ServletOutputStream::print ( float  s)

Appends a float value to the payload.

ServletOutputStream& rwsf::ServletOutputStream::print ( double  s)

Appends a double value to the payload.

ServletOutputStream& rwsf::ServletOutputStream::print ( const char *  s)

Appends a NULL terminated string value to the payload.

ServletOutputStream& rwsf::ServletOutputStream::print ( const unsigned char *  s)

Appends a NULL terminated string value to the payload.

ServletOutputStream& rwsf::ServletOutputStream::print ( const std::string &  str)

Appends an std::string value to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( )

Appends a newline value to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( bool  b)

Appends a bool value followed by a newline to the payload. This function appends the string true or the string false rather than 1 or 0.

ServletOutputStream& rwsf::ServletOutputStream::println ( char  c)

Appends a char value followed by a newline to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( unsigned char  uc)

Appends an unsigned char value followed by a newline to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( short  s)

Appends a short value followed by a newline to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( unsigned short  s)

Appends an unsigned short value followed by a newline to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( int  s)

Appends an int value followed by a newline to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( unsigned int  s)

Appends an unsigned int value followed by a newline to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( long  s)

Appends a long value followed by a newline to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( unsigned long  s)

Appends an unsigned long value followed by a newline to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( long long  s)

Appends a long long value followed by a newline to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( unsigned long long  s)

Appends an unsigned long long value followed by a newline to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( float  s)

Appends a float value followed by a newline to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( double  s)

Appends a double value followed by a newline to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( const char *  s)

Appends a NULL terminated string value followed by a newline to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( const unsigned char *  s)

Appends a NULL terminated string value followed by a newline to the payload.

ServletOutputStream& rwsf::ServletOutputStream::println ( const std::string &  str)

Appends an std::string value followed by a newline to the payload.

void rwsf::ServletOutputStream::reset ( )

Clears any internal buffer.

void rwsf::ServletOutputStream::reset ( const std::string &  newContents)

Clears any internal buffer, then sets the contents of the internal buffer to newContents.

Copyright © 2019 Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is registered trademark of Rogue Wave Software, Inc. in the United States and other countries, and HydraExpress is a trademark of Rogue Wave Software. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.