SFXStream

Base class of stream.

#include <SFXStream.h.hpp>

class SFXStream;

<link linkend="sec.macro.core.typedef.SFMTYPEDEFCLASS">SFMTYPEDEFCLASS</link>(SFXStream)

Inheritance diagram

Collaboration diagram

Reference

SFXInputStream | SFXOutputStream

Member

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

Public Functions
`Void`	Cancel( `Void` ) Call the Cancel function for Storage class. And also unregister the callback functions that are registered.
`SFCError`	ResetTrigger( `Void` ) Reset the trigger when the callback function will be called.
`SFCError`	SetTrigger( `UInt32` size ) SetTrigger( `VoidConstPtr` buffer , `UInt32` size ) SetTrigger( `SFXBufferConstRef` buffer ) Set the trigger when the callback function will be called.
`Bool`	Triggers( `Void` ) Check whether the callback function is called by trigger or not.

Types
CallbackSPP Constant that represents Callback function.

SFXStream::SFXStream

Constructor of SFXStream class.

[ protected, explicit ]
SFXStream(Void);

SFXStream::~SFXStream

Destructor of the SFXStream class.

[ public, virtual ]
virtual ~SFXStream(Void);

SFXStream::Cancel

Call the Cancel function for Storage class. And also unregister the callback functions that are registered.

[ public, virtual ]
Void Cancel(Void);

Description

The Cancel function is a pure virtual function.

Reference

SFXStorage::Cancel

SFXStream::ResetTrigger

Reset the trigger when the callback function will be called.

[ public, virtual ]
SFCError ResetTrigger(Void);

Description

The ResetTrigger function is a pure virtual function.

Reference

SFXStream::SetTrigger | SFXStream::Triggers

SFXStream::SetTrigger

Set the trigger when the callback function will be called.

[ public, virtual ]
SFCError SetTrigger(
    UInt32 size   // data size to be read or written through stream
);

[ public, virtual ]
SFCError SetTrigger(
    SFXBufferConstRef buffer   // SFXBuffer object to be read or written through stream
);

[ public, virtual ]
SFCError SetTrigger(
    VoidConstPtr buffer   // data to be read or written through stream
    UInt32 size           // data size to be read or written through stream
);

Description

The SetTrigger function is a pure virtual function.

Reference

SFXStream::ResetTrigger | SFXStream::Triggers

SFXStream::Triggers

Check whether the callback function is called by trigger or not.

[ public, virtual, const ]
Bool Triggers(Void);

Description

The Triggers function is a pure virtual function.

Reference

SFXStream::SetTrigger | SFXStream::ResetTrigger

SFXStream::CallbackSPP

Constant that represents Callback function.

typedef Void(* SFXStream::CallbackSPP)(SFCError error, VoidPtr reference)