Interface for output streams used to create a sequence of bytes from Slice types. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::OutputStream:

[legend]

Collaboration diagram for Ice::OutputStream:

[legend]

Public Types
typedef size_t	size_type

Public Member Functions
void	clear ()
	Releases any data retained by encapsulations.
void	endEncapsulation ()
	Ends the current encapsulation.
void	endException ()
	Marks the end of an exception instance.
void	endSize (size_type position)
	Updates the size value at the given position to contain a size based on the stream's current position.
void	endSlice ()
	Marks the end of a value or exception slice.
void	endValue ()
	Marks the end of a class instance.
std::pair< const Byte , const Byte >	finished ()
	Indicates that marshaling is complete.
void	finished (std::vector< Byte > &v)
	Indicates that marshaling is complete.
void *	getClosure () const
	Obtains the closure data associated with this stream.
const EncodingVersion &	getEncoding () const
	Determines the current encoding version.
void	initialize (const CommunicatorPtr &communicator)
	Initializes the stream to use the communicator's default encoding version, class encoding format and string converters.
void	initialize (const CommunicatorPtr &communicator, const EncodingVersion &version)
	Initializes the stream to use the given encoding version and the communicator's default class encoding format and string converters.
	OutputStream ()
	Constructs an OutputStream using the latest encoding version, the default format for class encoding, and the process string converters.
	OutputStream (const CommunicatorPtr &communicator)
	Constructs a stream using the communicator's default encoding version.
	OutputStream (const CommunicatorPtr &communicator, const EncodingVersion &version)
	Constructs a stream using the given communicator and encoding version.
	OutputStream (const CommunicatorPtr &communicator, const EncodingVersion &version, const std::pair< const Byte , const Byte > &bytes)
	Constructs a stream using the given communicator and encoding version.
size_type	pos ()
	Obtains the current position of the stream.
void	resize (Container::size_type sz)
	Resizes the stream to a new size.
void	rewrite (Int v, size_type pos)
	Overwrite a 32-bit integer value at the given position in the stream.
void	rewriteSize (Int v, Container::iterator dest)
	Replaces a size value at the given destination in the stream.
void *	setClosure (void *p)
	Associates closure data with this stream.
void	setFormat (FormatType format)
	Sets the class encoding format.
void	startEncapsulation ()
	Writes the start of an encapsulation using the default encoding version and class encoding format.
void	startEncapsulation (const EncodingVersion &encoding, FormatType format)
	Writes the start of an encapsulation using the given encoding version and class encoding format.
void	startException (const SlicedDataPtr &data)
	Marks the start of an exception instance.
size_type	startSize ()
	Writes a placeholder value for the size and returns the starting position of the size value; after writing the data, call endSize to patch the placeholder with the actual size at the given position.
void	startSlice (const std::string &typeId, int compactId, bool last)
	Writes the start of a value or exception slice.
void	startValue (const SlicedDataPtr &data)
	Marks the start of a class instance.
void	swap (OutputStream &other)
	Swaps the contents of one stream with another.
void	write (bool v)
	Writes a boolean to the stream.
void	write (Byte v)
	Writes a byte to the stream.
void	write (const bool begin, const bool end)
	Writes a byte sequence to the stream.
void	write (const Byte start, const Byte end)
	Writes a byte sequence to the stream.
void	write (const char *vdata, bool convert=true)
	Writes a string to the stream.
void	write (const char *vdata, size_t vsize, bool convert=true)
	Writes a string to the stream.
void	write (const Double begin, const Double end)
	Writes a double sequence to the stream.
void	write (const Float begin, const Float end)
	Writes a float sequence to the stream.
template<typename T>
void	write (const IceInternal::Handle< T > &v)
	Writes a value instance to the stream.
template<typename T>
void	write (const IceInternal::ProxyHandle< T > &v)
	Writes a proxy to the stream.
void	write (const Int begin, const Int end)
	Writes an int sequence to the stream.
void	write (const Long begin, const Long end)
	Writes a long sequence to the stream.
void	write (const ObjectPrx &v)
	Writes a proxy to the stream.
void	write (const ObjectPtr &v)
	Writes a value instance to the stream.
void	write (const Short begin, const Short end)
	Writes a short sequence to the stream.
void	write (const std::string &v, bool convert=true)
	Writes a string to the stream.
void	write (const std::string begin, const std::string end, bool convert=true)
	Writes a string sequence to the stream.
void	write (const std::vector< bool > &v)
	Writes a byte sequence to the stream.
template<typename T>
void	write (const std::vector< T > &v)
	Writes a sequence of data values to the stream.
void	write (const std::wstring &v)
	Writes a wide string to the stream.
void	write (const std::wstring begin, const std::wstring end)
	Writes a wide string sequence to the stream.
template<typename T>
void	write (const T &v)
	Writes a data value to the stream.
template<typename T>
void	write (const T begin, const T end)
	Writes a sequence of data values to the stream.
void	write (Double v)
	Writes a double to the stream.
void	write (Float v)
	Writes a float to the stream.
template<typename T>
void	write (Int tag, const IceUtil::Optional< T > &v)
	Writes an optional data value to the stream.
void	write (Int v)
	Writes an int to the stream.
void	write (Int v, Container::iterator dest)
	Overwrites a 32-bit integer value at the given destination in the stream.
void	write (Long v)
	Writes a long to the stream.
void	write (Short v)
	Writes a short to the stream.
void	writeBlob (const Byte *v, Container::size_type sz)
	Copies the specified blob of bytes to the stream without modification.
void	writeBlob (const std::vector< Byte > &v)
	Copies the specified blob of bytes to the stream without modification.
void	writeEmptyEncapsulation (const EncodingVersion &encoding)
	Writes an empty encapsulation using the given encoding version.
void	writeEncapsulation (const Byte *v, Int sz)
	Copies the marshaled form of an encapsulation to the buffer.
void	writeEnum (Int v, Int maxValue)
	Writes an enumerator to the stream.
void	writeException (const UserException &v)
	Writes an exception to the stream.
bool	writeOptional (Int tag, OptionalFormat format)
	Writes the tag and format of an optional value.
void	writePendingValues ()
	Encodes the state of class instances whose insertion was delayed during a previous call to write.
void	writeSize (Int v)
	Writes a size value.
	~OutputStream ()

Detailed Description

Interface for output streams used to create a sequence of bytes from Slice types.

Member Typedef Documentation

◆ size_type

typedef size_t Ice::OutputStream::size_type

Constructor & Destructor Documentation

◆ OutputStream() [1/4]

Ice::OutputStream::OutputStream ( )

Constructs an OutputStream using the latest encoding version, the default format for class encoding, and the process string converters.

You can supply a communicator later by calling initialize().

◆ OutputStream() [2/4]

Ice::OutputStream::OutputStream ( const CommunicatorPtr & communicator )

Constructs a stream using the communicator's default encoding version.

Parameters

communicator The communicator to use for marshaling tasks.

◆ OutputStream() [3/4]

Ice::OutputStream::OutputStream	(	const CommunicatorPtr &	communicator,
		const EncodingVersion &	version )

Constructs a stream using the given communicator and encoding version.

Parameters

communicator	The communicator to use for marshaling tasks.
version	The encoding version used to encode the data.

◆ OutputStream() [4/4]

Ice::OutputStream::OutputStream	(	const CommunicatorPtr &	communicator,
		const EncodingVersion &	version,
		const std::pair< const Byte , const Byte > &	bytes )

Constructs a stream using the given communicator and encoding version.

Parameters

communicator	The communicator to use for marshaling tasks.
version	The encoding version used to encode the data.
bytes	Application-supplied memory that the stream uses as its initial marshaling buffer. The stream will reallocate if the size of the marshaled data exceeds the application's buffer.

◆ ~OutputStream()

Ice::OutputStream::~OutputStream ( )

inline

Member Function Documentation

◆ clear()

void Ice::OutputStream::clear ( )

Releases any data retained by encapsulations.

◆ endEncapsulation()

void Ice::OutputStream::endEncapsulation ( )

inline

Ends the current encapsulation.

◆ endException()

void Ice::OutputStream::endException ( )

inline

Marks the end of an exception instance.

◆ endSize()

void Ice::OutputStream::endSize ( size_type position )

inline

Updates the size value at the given position to contain a size based on the stream's current position.

Parameters

position The starting position of the size value as returned by startSize.

◆ endSlice()

void Ice::OutputStream::endSlice ( )

inline

Marks the end of a value or exception slice.

◆ endValue()

void Ice::OutputStream::endValue ( )

inline

Marks the end of a class instance.

◆ finished() [1/2]

std::pair< const Byte *, const Byte * > Ice::OutputStream::finished ( )

Indicates that marshaling is complete.

This function must only be called once.

Returns: A pair of pointers into the internal marshaling buffer. These pointers are valid for the lifetime of the stream.

◆ finished() [2/2]

void Ice::OutputStream::finished ( std::vector< Byte > & v )

Indicates that marshaling is complete.

This function must only be called once.

Parameters

v	Filled with a copy of the encoded data.

◆ getClosure()

void * Ice::OutputStream::getClosure ( ) const

Obtains the closure data associated with this stream.

Returns: The data as a void pointer.

◆ getEncoding()

const EncodingVersion & Ice::OutputStream::getEncoding ( ) const

inline

Determines the current encoding version.

Returns: The encoding version.

◆ initialize() [1/2]

void Ice::OutputStream::initialize ( const CommunicatorPtr & communicator )

Initializes the stream to use the communicator's default encoding version, class encoding format and string converters.

Use this method if you originally constructed the stream without a communicator.

Parameters

communicator The communicator to use for marshaling tasks.

◆ initialize() [2/2]

void Ice::OutputStream::initialize	(	const CommunicatorPtr &	communicator,
		const EncodingVersion &	version )

Initializes the stream to use the given encoding version and the communicator's default class encoding format and string converters.

Use this method if you originally constructed the stream without a communicator.

Parameters

communicator	The communicator to use for marshaling tasks.
version	The encoding version used to encode the data.

◆ pos()

size_type Ice::OutputStream::pos ( )

inline

Obtains the current position of the stream.

Returns: The current position.

◆ resize()

void Ice::OutputStream::resize ( Container::size_type sz )

inline

Resizes the stream to a new size.

Parameters

sz	The new size.

◆ rewrite()

void Ice::OutputStream::rewrite	(	Int	v,
		size_type	pos )

inline

Overwrite a 32-bit integer value at the given position in the stream.

This function does not change the stream's current position.

Parameters

v	The value to be written.
pos	The buffer position for the value.

◆ rewriteSize()

void Ice::OutputStream::rewriteSize	(	Int	v,
		Container::iterator	dest )

inline

Replaces a size value at the given destination in the stream.

This function does not change the stream's current position.

Parameters

v	A non-negative integer representing the size.
dest	The buffer destination for the size.

◆ setClosure()

void * Ice::OutputStream::setClosure ( void * p )

Associates closure data with this stream.

Parameters

p	The data as a void pointer.

Returns: The previous closure data, or nil.

◆ setFormat()

void Ice::OutputStream::setFormat ( FormatType format )

Sets the class encoding format.

Parameters

format The encoding format.

◆ startEncapsulation() [1/2]

void Ice::OutputStream::startEncapsulation ( )

Writes the start of an encapsulation using the default encoding version and class encoding format.

◆ startEncapsulation() [2/2]

void Ice::OutputStream::startEncapsulation	(	const EncodingVersion &	encoding,
		FormatType	format )

inline

Writes the start of an encapsulation using the given encoding version and class encoding format.

Parameters

encoding	The encoding version to use for the encapsulation.
format	The class format to use for the encapsulation.

◆ startException()

void Ice::OutputStream::startException ( const SlicedDataPtr & data )

inline

Marks the start of an exception instance.

Parameters

data	Contains the marshaled form of unknown slices from this instance. If not nil, these slices will be marshaled with the instance.

◆ startSize()

size_type Ice::OutputStream::startSize ( )

inline

Writes a placeholder value for the size and returns the starting position of the size value; after writing the data, call endSize to patch the placeholder with the actual size at the given position.

Returns: The starting position of the size value.

◆ startSlice()

void Ice::OutputStream::startSlice	(	const std::string &	typeId,
		int	compactId,
		bool	last )

inline

Writes the start of a value or exception slice.

Parameters

typeId	The Slice type ID for this slice.
compactId	The compact ID corresponding to the type, or -1 if no compact ID is used.
last	True if this is the last slice, false otherwise.

◆ startValue()

void Ice::OutputStream::startValue ( const SlicedDataPtr & data )

inline

Marks the start of a class instance.

Parameters

data	Contains the marshaled form of unknown slices from this instance. If not nil, these slices will be marshaled with the instance.

◆ swap()

void Ice::OutputStream::swap ( OutputStream & other )

Swaps the contents of one stream with another.

Parameters

other The other stream.

◆ write() [1/30]

void Ice::OutputStream::write ( bool v )

inline

Writes a boolean to the stream.

Parameters

v	The boolean to write.

◆ write() [2/30]

void Ice::OutputStream::write ( Byte v )

inline

Writes a byte to the stream.

Parameters

v	The byte to write.

◆ write() [3/30]

void Ice::OutputStream::write	(	const bool *	begin,
		const bool *	end )

Writes a byte sequence to the stream.

Parameters

begin	The beginning of the sequence.
end	The end of the sequence.

◆ write() [4/30]

void Ice::OutputStream::write	(	const Byte *	start,
		const Byte *	end )

Writes a byte sequence to the stream.

Parameters

start	The beginning of the sequence.
end	The end of the sequence.

◆ write() [5/30]

void Ice::OutputStream::write	(	const char *	vdata,
		bool	convert = true )

inline

Writes a string to the stream.

Parameters

vdata	The null-terminated string to write.
convert	Determines whether the string is processed by the narrow string converter, if one has been configured. The default behavior is to convert the strings.

◆ write() [6/30]

void Ice::OutputStream::write	(	const char *	vdata,
		size_t	vsize,
		bool	convert = true )

inline

Writes a string to the stream.

Parameters

vdata	The string to write.
vsize	The size of the string.
convert	Determines whether the string is processed by the narrow string converter, if one has been configured. The default behavior is to convert the strings.

◆ write() [7/30]

void Ice::OutputStream::write	(	const Double *	begin,
		const Double *	end )

Writes a double sequence to the stream.

Parameters

begin	The beginning of the sequence.
end	The end of the sequence.

◆ write() [8/30]

void Ice::OutputStream::write	(	const Float *	begin,
		const Float *	end )

Writes a float sequence to the stream.

Parameters

begin	The beginning of the sequence.
end	The end of the sequence.

◆ write() [9/30]

template<typename T>

void Ice::OutputStream::write ( const IceInternal::Handle< T > & v )

inline

Writes a value instance to the stream.

Parameters

v	The value to be written.

◆ write() [10/30]

template<typename T>

void Ice::OutputStream::write ( const IceInternal::ProxyHandle< T > & v )

inline

Writes a proxy to the stream.

Parameters

v	The proxy to be written.

◆ write() [11/30]

void Ice::OutputStream::write	(	const Int *	begin,
		const Int *	end )

Writes an int sequence to the stream.

Parameters

begin	The beginning of the sequence.
end	The end of the sequence.

◆ write() [12/30]

void Ice::OutputStream::write	(	const Long *	begin,
		const Long *	end )

Writes a long sequence to the stream.

Parameters

begin	The beginning of the sequence.
end	The end of the sequence.

◆ write() [13/30]

void Ice::OutputStream::write ( const ObjectPrx & v )

Writes a proxy to the stream.

Parameters

v	The proxy to be written.

◆ write() [14/30]

void Ice::OutputStream::write ( const ObjectPtr & v )

inline

Writes a value instance to the stream.

Parameters

v	The value to be written.

◆ write() [15/30]

void Ice::OutputStream::write	(	const Short *	begin,
		const Short *	end )

Writes a short sequence to the stream.

Parameters

begin	The beginning of the sequence.
end	The end of the sequence.

◆ write() [16/30]

void Ice::OutputStream::write	(	const std::string &	v,
		bool	convert = true )

inline

Writes a string to the stream.

Parameters

v	The string to write.
convert	Determines whether the string is processed by the narrow string converter, if one has been configured. The default behavior is to convert the strings.

◆ write() [17/30]

void Ice::OutputStream::write	(	const std::string *	begin,
		const std::string *	end,
		bool	convert = true )

Writes a string sequence to the stream.

Parameters

begin	The beginning of the sequence.
end	The end of the sequence.
convert	Determines whether the string is processed by the narrow string converter, if one has been configured. The default behavior is to convert the strings.

◆ write() [18/30]

void Ice::OutputStream::write ( const std::vector< bool > & v )

Writes a byte sequence to the stream.

Parameters

v	The sequence to be written.

◆ write() [19/30]

template<typename T>

void Ice::OutputStream::write ( const std::vector< T > & v )

inline

Writes a sequence of data values to the stream.

Parameters

v	The sequence to be written.

◆ write() [20/30]

void Ice::OutputStream::write ( const std::wstring & v )

Writes a wide string to the stream.

Parameters

v	The wide string to write.

◆ write() [21/30]

void Ice::OutputStream::write	(	const std::wstring *	begin,
		const std::wstring *	end )

Writes a wide string sequence to the stream.

Parameters

begin	The beginning of the sequence.
end	The end of the sequence.

◆ write() [22/30]

template<typename T>

void Ice::OutputStream::write ( const T & v )

inline

Writes a data value to the stream.

Parameters

v	The data value to be written.

◆ write() [23/30]

template<typename T>

void Ice::OutputStream::write	(	const T *	begin,
		const T *	end )

inline

Writes a sequence of data values to the stream.

Parameters

begin	The beginning of the sequence.
end	The end of the sequence.

◆ write() [24/30]

void Ice::OutputStream::write ( Double v )

Writes a double to the stream.

Parameters

v	The double to write.

◆ write() [25/30]

void Ice::OutputStream::write ( Float v )

Writes a float to the stream.

Parameters

v	The float to write.

◆ write() [26/30]

template<typename T>

void Ice::OutputStream::write	(	Int	tag,
		const IceUtil::Optional< T > &	v )

inline

Writes an optional data value to the stream.

Parameters

tag	The tag ID.
v	The data value to be written (if any).

◆ write() [27/30]

void Ice::OutputStream::write ( Int v )

inline

Writes an int to the stream.

Parameters

v	The int to write.

◆ write() [28/30]

void Ice::OutputStream::write	(	Int	v,
		Container::iterator	dest )

inline

Overwrites a 32-bit integer value at the given destination in the stream.

This function does not change the stream's current position.

Parameters

v	The integer value to be written.
dest	The buffer destination for the integer value.

◆ write() [29/30]

void Ice::OutputStream::write ( Long v )

Writes a long to the stream.

Parameters

v	The long to write.

◆ write() [30/30]

void Ice::OutputStream::write ( Short v )

Writes a short to the stream.

Parameters

v	The short to write.

◆ writeBlob() [1/2]

void Ice::OutputStream::writeBlob	(	const Byte *	v,
		Container::size_type	sz )

inline

Copies the specified blob of bytes to the stream without modification.

Parameters

v	The start of the buffer to be copied.
sz	The number of bytes to be copied.

◆ writeBlob() [2/2]

void Ice::OutputStream::writeBlob ( const std::vector< Byte > & v )

Copies the specified blob of bytes to the stream without modification.

Parameters

v	The bytes to be copied.

◆ writeEmptyEncapsulation()

void Ice::OutputStream::writeEmptyEncapsulation ( const EncodingVersion & encoding )

inline

Writes an empty encapsulation using the given encoding version.

Parameters

encoding The encoding version to use for the encapsulation.

◆ writeEncapsulation()

void Ice::OutputStream::writeEncapsulation	(	const Byte *	v,
		Int	sz )

inline

Copies the marshaled form of an encapsulation to the buffer.

Parameters

v	The start of the buffer.
sz	The number of bytes to copy.

◆ writeEnum()

void Ice::OutputStream::writeEnum	(	Int	v,
		Int	maxValue )

Writes an enumerator to the stream.

Parameters

v	The enumerator to be written.
maxValue	The maximum value of all enumerators in this enumeration.

◆ writeException()

void Ice::OutputStream::writeException ( const UserException & v )

Writes an exception to the stream.

Parameters

v	The exception to be written.

◆ writeOptional()

bool Ice::OutputStream::writeOptional	(	Int	tag,
		OptionalFormat	format )

inline

Writes the tag and format of an optional value.

Parameters

tag	The optional tag ID.
format	The optional format.

Returns: True if the current encoding version supports optional values, false otherwise. If true, the data associated with the optional value must be written next.

◆ writePendingValues()

void Ice::OutputStream::writePendingValues ( )

Encodes the state of class instances whose insertion was delayed during a previous call to write.

This member function must only be called once. For backward compatibility with encoding version 1.0, this function must only be called when non-optional data members or parameters use class types.

◆ writeSize()

void Ice::OutputStream::writeSize ( Int v )

inline

Writes a size value.

Parameters

v	A non-negative integer.

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

Ice/OutputStream.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ size_type

Constructor & Destructor Documentation

◆ OutputStream() [1/4]

◆ OutputStream() [2/4]

◆ OutputStream() [3/4]

◆ OutputStream() [4/4]

◆ ~OutputStream()

Member Function Documentation

◆ clear()

◆ endEncapsulation()

◆ endException()

◆ endSize()

◆ endSlice()

◆ endValue()

◆ finished() [1/2]

◆ finished() [2/2]

◆ getClosure()

◆ getEncoding()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ pos()

◆ resize()

◆ rewrite()

◆ rewriteSize()

◆ setClosure()

◆ setFormat()

◆ startEncapsulation() [1/2]

◆ startEncapsulation() [2/2]

◆ startException()

◆ startSize()

◆ startSlice()

◆ startValue()

◆ swap()

◆ write() [1/30]

◆ write() [2/30]

◆ write() [3/30]

◆ write() [4/30]

◆ write() [5/30]

◆ write() [6/30]

◆ write() [7/30]

◆ write() [8/30]

◆ write() [9/30]

◆ write() [10/30]

◆ write() [11/30]

◆ write() [12/30]

◆ write() [13/30]

◆ write() [14/30]

◆ write() [15/30]

◆ write() [16/30]

◆ write() [17/30]

◆ write() [18/30]

◆ write() [19/30]

◆ write() [20/30]

◆ write() [21/30]

◆ write() [22/30]

◆ write() [23/30]

◆ write() [24/30]

◆ write() [25/30]

◆ write() [26/30]

◆ write() [27/30]

◆ write() [28/30]

◆ write() [29/30]

◆ write() [30/30]

◆ writeBlob() [1/2]

◆ writeBlob() [2/2]

◆ writeEmptyEncapsulation()

◆ writeEncapsulation()

◆ writeEnum()

◆ writeException()

◆ writeOptional()

◆ writePendingValues()

◆ writeSize()