ZFFramework
 
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ZFOutput Class Reference

general output callback More...

#include <ZFIOCallback_output.h>

Inheritance diagram for ZFOutput:
ZFIOCallback ZFCallback

Public Member Functions

zfindex execute (const void *src, zfindex count=((zfindex) -1)) const
 see ZFOutput
 
zfindex operator() (const void *src, zfindex count=((zfindex) -1)) const
 see ZFOutput
 
const ZFOutput & output (const void *src, zfindex count=((zfindex) -1), zfindex *result=zft_zfnull) const
 see ZFOutput
 
- Public Member Functions inherited from ZFIOCallback
zfbool ioSeek (zfindex byteSize, ZFSeekPos pos=ZFSeekPosBegin) const
 similar to FILE's ZFFileSeek
 
zfindex ioTell (void) const
 similar to FILE's ZFFileTell, return current's index or zfindexMax() if the callback doesn't support seek
 
zfindex ioSize (void) const
 calculate the callback's size or return zfindexMax() if not supported
 
void ioOwner (ZFObject *ioOwner)
 util to set ZFCallbackTagKeyword_ioOwner
 
zfany ioOwner (void) const
 util to get ZFCallbackTagKeyword_ioOwner
 
- Public Member Functions inherited from ZFCallback
template<typename T_ReturnType>
T_ReturnType executeExact () const
 see ZFCallback, you must assign the exact return type and param types for safe
 
template<typename T_ReturnType, typename Type0>
T_ReturnType executeExact (Type0 param0) const
 see ZFCallback, you must assign the exact return type and param types for safe
 
template<typename T_ReturnType, typename Type0, typename Type1>
T_ReturnType executeExact (Type0 param0, Type1 param1) const
 see ZFCallback, you must assign the exact return type and param types for safe
 
template<typename T_ReturnType, typename Type0, typename Type1, typename Type2>
T_ReturnType executeExact (Type0 param0, Type1 param1, Type2 param2) const
 see ZFCallback, you must assign the exact return type and param types for safe
 
template<typename T_ReturnType, typename Type0, typename Type1, typename Type2, typename Type3>
T_ReturnType executeExact (Type0 param0, Type1 param1, Type2 param2, Type3 param3) const
 see ZFCallback, you must assign the exact return type and param types for safe
 
template<typename T_ReturnType, typename Type0, typename Type1, typename Type2, typename Type3, typename Type4>
T_ReturnType executeExact (Type0 param0, Type1 param1, Type2 param2, Type3 param3, Type4 param4) const
 see ZFCallback, you must assign the exact return type and param types for safe
 
template<typename T_ReturnType, typename Type0, typename Type1, typename Type2, typename Type3, typename Type4, typename Type5>
T_ReturnType executeExact (Type0 param0, Type1 param1, Type2 param2, Type3 param3, Type4 param4, Type5 param5) const
 see ZFCallback, you must assign the exact return type and param types for safe
 
template<typename T_ReturnType, typename Type0, typename Type1, typename Type2, typename Type3, typename Type4, typename Type5, typename Type6>
T_ReturnType executeExact (Type0 param0, Type1 param1, Type2 param2, Type3 param3, Type4 param4, Type5 param5, Type6 param6) const
 see ZFCallback, you must assign the exact return type and param types for safe
 
template<typename T_ReturnType, typename Type0, typename Type1, typename Type2, typename Type3, typename Type4, typename Type5, typename Type6, typename Type7>
T_ReturnType executeExact (Type0 param0, Type1 param1, Type2 param2, Type3 param3, Type4 param4, Type5 param5, Type6 param6, Type7 param7) const
 see ZFCallback, you must assign the exact return type and param types for safe
 
zfindex objectRetainCount (void) const
 get current retain count
 
void objectInfoT (zfstring &ret) const
 see objectInfo
 
zfstring objectInfo (void) const
 return object info
 
ZFCompareResult objectCompare (const ZFCallback &ref) const
 compare with another callback
 
ZFCompareResult objectCompareByInstance (const ZFCallback &ref) const
 compare callback by instance only (same callback contents not necessarily to be same instance)
 
void callbackClear (void)
 explicitly clear reference of this callback
 
void callbackId (const zfstring &callbackId)
 an unique id for the callback, used for cache logic
 
const zfstring & callbackId (void) const
 see callbackId
 
zfidentity callbackHash (void) const
 hash of the callback
 
void callbackTag (const zfstring &key, ZFObject *tag)
 retain and store a autoreleased object attached to this callback, or set null to remove
 
zfany callbackTag (const zfstring &key) const
 see callbackTag
 
void callbackTagGetAllKeyValue (ZFCoreArray< zfstring > &allKey, ZFCoreArray< zfauto > &allValue) const
 see callbackTag
 
void callbackTagRemove (const zfstring &key)
 remove tag, same as set tag to null
 
zfauto callbackTagRemoveAndGet (const zfstring &key)
 remove tag, return removed tag or null if not exist
 
void callbackTagRemoveAll (void)
 see callbackTag
 
zfbool valid (void) const
 return true if callback is valid
 
ZFCallbackType callbackType (void) const
 get the type of callback
 
zfany callbackOwnerObject (void) const
 get the owner object, valid only if type is class member method
 
const ZFMethod * callbackMethod (void) const
 get the method or null if not declared by ZFMethod
 
ZFFuncAddrType callbackRawFunction (void) const
 get static function, valid only if type is ZFCallbackTypeRawFunction
 
void * callbackLambdaImpl (void) const
 impl for lambda type
 
ZFFuncAddrType callbackLambdaInvoker (void) const
 impl for lambda type
 
void callbackOwnerObjectRetain (void) const
 retain owner object and auto release it after callback's retain count reduced to 0
 
void callbackOwnerObjectRelease (void) const
 manually release the owner, see callbackOwnerObjectRetain
 
void callbackInfoCopy (const ZFCallback &src)
 util method to copy callback info from another callback
 
void callbackSerializeType (const zfstring &customType)
 see ZFTypeId_ZFCallback
 
const zfstring & callbackSerializeType (void) const
 see ZFTypeId_ZFCallback
 
void callbackSerializeData (const ZFSerializableData &customData)
 see ZFTypeId_ZFCallback
 
ZFSerializableData callbackSerializeData (void) const
 see ZFTypeId_ZFCallback
 
void callbackSerializeDisable (zfbool disable)
 see ZFTypeId_ZFCallback
 
zfbool callbackSerializeDisable (void) const
 see ZFTypeId_ZFCallback
 
ZFPathInfo pathInfo (void) const
 used for impl to store path related info, see ZFPathInfo
 
void pathInfo (const ZFPathInfo &pathInfo)
 see pathInfo
 

Detailed Description

general output callback

proto type:

zfindex output(
ZF_IN const void *src
, ZF_IN_OPT zfindex count = zfindexMax()
);
ZF_IN
#define ZF_IN
dummy macro that shows the param used as required input
Definition ZFCoreTypeDef_ClassType.h:180
ZF_IN_OPT
#define ZF_IN_OPT
dummy macro that shows the param used as optional input
Definition ZFCoreTypeDef_ClassType.h:184
zfindex
_ZFT_t_zfindex zfindex
similar to size_t, used for index and size only
Definition ZFCoreTypeDef_CoreType.h:154
zfindexMax
#define zfindexMax()
(zfindex)-1, indicate a max index value, see zfindex
Definition ZFCoreTypeDef_CoreType.h:159
ZFOutput::output
const ZFOutput & output(const void *src, zfindex count=((zfindex) -1), zfindex *result=zft_zfnull) const
see ZFOutput
Definition ZFIOCallback_output.h:64

params:

  • (const void *) output buffer
  • (zfindex) byte size to write, or zfindexMax() to calculate by src (at this case, src must be NULL-terminated zfchar string)

return:

  • byte size written to output, return a value less than count indicates error state

ADVANCED:
for implementations, see ZFCallbackTagKeyword_ioOwner if need support seek

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