SFXOutputStream

Base class which represents a stream for writing.

#include <SFXOutputStream.h.hpp>

class SFXOutputStream : public SFXStream;

SFMTYPEDEFCLASS(SFXOutputStream)

Inheritance diagram

Description

The following class that inherited from the SFXInputStream class : SFXAnsiStringStreamWriter class, SFXWideStringStreamWriter class, or SFXBinaryStreamWriter class is used properly according to the type of data.

Reference

SFXAnsiStringStreamWriter | SFXWideStringStreamWriter | SFXBinaryStreamWriter

Member

Constructor/Destructor
SFXOutputStream( `Void` ) Constructor of the SFXOutputStream class.
~SFXOutputStream( `Void` ) Destructor of the SFXOutputStream class.

Public Functions
`SFCError`	Flush( `Void` ) Flush the written data.
`SFCError`	Flush( `CallbackSPP` spp , `VoidPtr` reference ) Flush the written data.
`UInt32`	GetWritableSize( `Void` ) Get the size of writable data.
`SFCError`	Write( `SFXBufferConstRef` buffer ) Write data onto the output stream.
`SFCError`	Write( `VoidConstPtr` buffer , `UInt32` size ) Write data onto the output stream.
`Void`	Cancel( `Void` ) (inherits from SFXStream) Cancel to read from / write onto this stream.
`SFCError`	ResetTrigger( `Void` ) (inherits from SFXStream) Reset the trigger condition that the callback function will be booted up.
`SFCError`	SetTrigger( `UInt32` size ) (inherits from SFXStream) Set the trigger condition that the callback function will be booted up.
`SFCError`	SetTrigger( `SFXBufferConstRef` buffer ) (inherits from SFXStream) Set the trigger condition that the callback function will be booted up.
`SFCError`	SetTrigger( `VoidConstPtr` buffer , `UInt32` size ) (inherits from SFXStream) Set the trigger condition that the callback function will be booted up.
`Bool`	Triggers( `Void` ) (inherits from SFXStream) Check whether or not the callback function is booted up by the trigger condition.

Types
CallbackSPP (inherits from SFXStream) Type that represents the Callback function.

SFXOutputStream::SFXOutputStream

Constructor of the SFXOutputStream class.

[ protected, explicit ]
SFXOutputStream(Void);

SFXOutputStream::~SFXOutputStream

Destructor of the SFXOutputStream class.

[ public, pure-virtual ]
virtual ~SFXOutputStream(Void);

Description

This function is a pure virtual function.

SFXOutputStream::Flush

Flush the written data.

[ public, pure-virtual ]
SFCError Flush(Void);

[ public, pure-virtual ]
SFCError Flush(
    CallbackSPP spp     // callback function
    VoidPtr reference   // data passed to the callback function
);

Description

This function is a pure virtual function.

SFXOutputStream::GetWritableSize

Get the size of writable data.

[ public, pure-virtual, const ]
UInt32 GetWritableSize(Void);

Description

This function is a pure virtual function.

SFXOutputStream::Write

Write data onto the output stream.

[ public, pure-virtual ]
SFCError Write(
    SFXBufferConstRef buffer   // buffer to write data onto the output stream
);

[ public, pure-virtual ]
SFCError Write(
    VoidConstPtr buffer   // buffer to write data onto the output stream
    UInt32 size           // size of data to be written onto the output stream
);

Description

This function is a pure virtual function.