SFXStream

Base class of stream.

#include <SFXStream.h.hpp>

class SFXStream;

SFMTYPEDEFCLASS(SFXStream)

Inheritance diagram

Description

SFXStream is the base class that represents the stream. For more details, see SFXInputStream and SFXOutputStream as the child of this class.

Reference

SFXInputStream | SFXOutputStream

Member

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

Public Functions
`Void`	Cancel( `Void` ) Cancel to read from / write onto this stream.
`SFCError`	ResetTrigger( `Void` ) Reset the trigger condition that the callback function will be booted up.
`SFCError`	SetTrigger( `UInt32` size ) Set the trigger condition that the callback function will be booted up.
`SFCError`	SetTrigger( `SFXBufferConstRef` buffer ) Set the trigger condition that the callback function will be booted up.
`SFCError`	SetTrigger( `VoidConstPtr` buffer , `UInt32` size ) Set the trigger condition that the callback function will be booted up.
`Bool`	Triggers( `Void` ) Check whether or not the callback function is booted up by the trigger condition.

Types
CallbackSPP Type that represents the callback function.

SFXStream::SFXStream

Constructor of the SFXStream class.

[ protected, explicit ]
SFXStream(Void);

SFXStream::~SFXStream

Destructor of the SFXStream class.

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

Description

This function is a pure virtual function.

SFXStream::Cancel

Cancel to read from / write onto this stream.

[ public, pure-virtual ]
Void Cancel(Void);

Description

This function is a pure virtual function.

Reference

SFXStorage::Cancel

SFXStream::ResetTrigger

Reset the trigger condition that the callback function will be booted up.

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

Description

This function is a pure virtual function.

Reference

SFXStream::SetTrigger | SFXStream::Triggers

SFXStream::SetTrigger

Set the trigger condition that the callback function will be booted up.

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

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

[ public, pure-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

This function is a pure virtual function.

Reference

SFXStream::ResetTrigger | SFXStream::Triggers

SFXStream::Triggers

Check whether or not the callback function is booted up by the trigger condition.

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

Description

This function is a pure virtual function.

Reference

SFXStream::SetTrigger | SFXStream::ResetTrigger

SFXStream::CallbackSPP

Type that represents the callback function.

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