Visit Platform at http://www.platform.com

Main Page   Class Hierarchy   Compound List   Compound Members  

OutputStream Class Reference

A stream object which will be used by a Message object for writing, i.e. for serializing. More...

List of all members.


Public Methods

virtual void write (short x) throw (SoamException)
 write a short to the output stream.

virtual void write (unsigned short x) throw (SoamException)
 write an unsigned short to the output stream.

virtual void write (int x) throw (SoamException)
 write an int to the output stream.

virtual void write (unsigned int x) throw (SoamException)
 write an unsigned int to the output stream.

virtual void write (long x) throw (SoamException)
 write a long to the output stream.

virtual void write (unsigned long x) throw (SoamException)
 write an unsigned long to the output stream.

virtual void write (long long x) throw (SoamException)
 write a long long (64-bit long vlaue) to the output stream. NOTE : For Microsoft Visual C++ compilers earlier than version 7.0 the "__int64" type must be used explicitly.

virtual void write (unsigned long long x) throw (SoamException)
 write an unsigned long long (64-bit unsigned long vlaue) to the output stream. NOTE : For Microsoft Visual C++ compilers earlier than version 7.0 the "unsigned __int64" type must be used explicitly.

virtual void write (float x) throw (SoamException)
 write a float to the output stream.

virtual void write (double x) throw (SoamException)
 write a double to the output stream.

virtual void write (bool x) throw (SoamException)
 write a bool to the output stream.

virtual void write (char x) throw (SoamException)
 write a char to the output stream.

virtual void write (const char *x) throw (SoamException)
 write a string to the output stream.

virtual void write (const std::string &x) throw (SoamException)
 write a string to the output stream.

virtual void writeBytes (const void *x, unsigned long length) throw (SoamException)
 write a blob to the output stream.

virtual void writeByteArray (const char *x, unsigned int offset, unsigned int length) throw (SoamException)
 write a byte array to the output stream.


Friends

class ServiceContainer
class Message

Detailed Description

A stream object which will be used by a Message object for writing, i.e. for serializing.

Output Streams involve the fundamental operations to write the following basic types of data into stream:

NOTE:
1. It is always best to access a pointer to this type of object through the appropriate smart pointer type instead of using a raw pointer.
2. If any of the methods of this class are called after the main(...) method exits, the client or service process may behave in an undefined manner (for example, hang or terminate abnormally).

See also:
OutputStreamPtr , Message


Member Function Documentation

virtual void write short    x throw (SoamException) [virtual]
 

write a short to the output stream.

Parameters:
x  [IN] - the short to be written.
Exceptions:
SoamException 

virtual void write unsigned short    x throw (SoamException) [virtual]
 

write an unsigned short to the output stream.

Parameters:
x  [IN] - the unsigned short to be written.
Exceptions:
SoamException 

virtual void write int    x throw (SoamException) [virtual]
 

write an int to the output stream.

Parameters:
x  [IN] - the integer to be written.
Exceptions:
SoamException 

virtual void write unsigned int    x throw (SoamException) [virtual]
 

write an unsigned int to the output stream.

Parameters:
x  [IN] - the unsigned integer to be written.
Exceptions:
SoamException 

virtual void write long    x throw (SoamException) [virtual]
 

write a long to the output stream.

Parameters:
x  [IN] - the long to be written.
Exceptions:
SoamException 

virtual void write unsigned long    x throw (SoamException) [virtual]
 

write an unsigned long to the output stream.

Parameters:
x  [IN] - the unsigned long to be written.
Exceptions:
SoamException 

virtual void write long long    x throw (SoamException) [virtual]
 

write a long long (64-bit long vlaue) to the output stream. NOTE : For Microsoft Visual C++ compilers earlier than version 7.0 the "__int64" type must be used explicitly.

Parameters:
x  [IN] - the long long to be written.
Exceptions:
SoamException 

virtual void write unsigned long long    x throw (SoamException) [virtual]
 

write an unsigned long long (64-bit unsigned long vlaue) to the output stream. NOTE : For Microsoft Visual C++ compilers earlier than version 7.0 the "unsigned __int64" type must be used explicitly.

Parameters:
x  [IN] - the unsigned long long to be written.
Exceptions:
SoamException 

virtual void write float    x throw (SoamException) [virtual]
 

write a float to the output stream.

Parameters:
x  [IN] - the float to be written.
Exceptions:
SoamException 

virtual void write double    x throw (SoamException) [virtual]
 

write a double to the output stream.

Parameters:
x  [IN] - the double to be written.
Exceptions:
SoamException 

virtual void write bool    x throw (SoamException) [virtual]
 

write a bool to the output stream.

Parameters:
x  [IN] - the bool to be written.
Exceptions:
SoamException 

virtual void write char    x throw (SoamException) [virtual]
 

write a char to the output stream.

Parameters:
x  [IN] - the char to be written.
Exceptions:
SoamException 

virtual void write const char *    x throw (SoamException) [virtual]
 

write a string to the output stream.

Parameters:
x  [IN] - the string to be written.
Exceptions:
SoamException 

virtual void write const std::string &    x throw (SoamException) [virtual]
 

write a string to the output stream.

Parameters:
x  [IN] - the string to be written.
Exceptions:
SoamException 

virtual void writeBytes const void *    x,
unsigned long    length
throw (SoamException) [virtual]
 

write a blob to the output stream.

Parameters:
x  [IN] - the blob to be written.
length  [IN] - the length of the blob.
Exceptions:
SoamException 

virtual void writeByteArray const char *    x,
unsigned int    offset,
unsigned int    length
throw (SoamException) [virtual]
 

write a byte array to the output stream.

Parameters:
x  [IN] - the byte array to be written.
offset  [IN] - the position in the byte array from which to start writing..
length  [IN] - the number of bytes to write.
Exceptions:
SoamException 


     
Date Modified: 28 Apr 2011
Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Platform Computing. Accelerating Intelligence(TM).
Copyright © 2001-2009 Platform Computing Corporation. All rights reserved.