ZFTcp Class Reference

tcp request util More...

#include <ZFTcp.h>

Inheritance diagram for ZFTcp:

Public Types
enum
Public Types inherited from ZFObject
enum

Public Member Functions
virtual const ZFClass *	classData (void)
	get instance's class info
virtual zfbool	open (const zfstring &host, zfuint port, zftimet timeout=(-1))
	open a socket with specified host and port
virtual void	close ()
	close the socket, see open
virtual ZFTcpType	type ()
	type of this tcp object
virtual zfbool	valid ()
	true if open or accept successfully
virtual const zfstring &	host ()
	current opened port, passed from open
virtual zfuint	port ()
	current opened port, passed from open
virtual zfbool	remoteInfoT (zfstring &remoteAddr)
	get remote addr, always fail if current type is v_ZFTcpType::e_Invalid or v_ZFTcpType::e_Server
virtual zfstring	remoteInfo ()
	get remote addr, always fail if current type is v_ZFTcpType::e_Invalid or v_ZFTcpType::e_Server
virtual zfautoT< ZFTcp >	accept (zftimet timeout=(-1))
	start accept client connection
virtual zfbool	send (const zfstring &data)
	send packet
virtual zfbool	send (const void *data, zfindex size)
	send packet
virtual zfbool	send (const ZFInput &input)
	send packet
virtual zfindex	recv (zfstring &data, zfindex maxSize=(((zfindex) -1)), zftimet timeout=(-1))
	recv packet until timeout
virtual zfindex	recv (const ZFOutput &output, zfindex maxSize=(((zfindex) -1)), zftimet timeout=(-1))
	recv packet until timeout
virtual void	objectInfoImpl (zfstring &ret)
	see objectInfo
Public Member Functions inherited from ZFObject
const ZFClass *	classDynamic (void)
	dynamic class of this object, see ZFClassDynamicRegister
zfindex	objectRetainCount (void)
	return the object's retain count
void	objectInfoOfInstanceT (zfstring &ret)
	see objectInfoOfInstance
zfstring	objectInfoOfInstance (void)
	return a short string describe the object instance
void	objectInfoT (zfstring &ret)
	see objectInfo
zfstring	objectInfo (void)
	return object info
zfidentity	objectHash (void)
	get hash of this object
ZFCompareResult	objectCompare (ZFObject *anotherObj)
	compare with anotherObj
ZFCompareResult	objectCompareValue (ZFObject *anotherObj)
	explicitly compare object by logical value, see objectCompare
virtual zfauto	invoke (const zfstring &methodName)
	util method to perform ZFDI_invoke, do nothing if fail
virtual zfauto	invoke (const zfstring &methodName, ZFObject *param0, ZFObject *param1=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param2=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param3=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param4=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param5=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param6=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param7=((ZFObject *const &) _ZFP_ZFMP_DEF))
	util method to perform ZFDI_invoke, do nothing if fail
virtual zfbool	invokeT (zfauto &ret, zfstring *errorHint, const zfstring &methodName, ZFObject *param0=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param1=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param2=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param3=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param4=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param5=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param6=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param7=((ZFObject *const &) _ZFP_ZFMP_DEF))
	util method to perform ZFDI_invoke, do nothing if fail
virtual zfauto	invokeDetail (const zfstring &methodName, const ZFCoreArray< zfauto > &params, zfbool *success=zft_zfnull, zfstring *errorHint=zft_zfnull)
	util method to perform ZFDI_invoke, do nothing if fail
zfbool	objectTagExist (void)
	see objectTag, true if this object has tag, and tag can be checked by objectTagGetAllKeyValue
void	objectTag (const zfstring &key, ZFObject *tag)
	used to hold a object for app's use, auto retained
zfany	objectTag (const zfstring &key)
	see objectTag
void	objectTagGetAllKeyValue (ZFCoreArray< zfstring > &allKey, ZFCoreArray< zfauto > &allValue)
	get all key value
void	objectTagRemove (const zfstring &key)
	remove tag, same as set tag to null
zfauto	objectTagRemoveAndGet (const zfstring &key)
	remove tag, return removed tag or null if not exist
void	objectTagRemoveAll (void)
	remove all tag
void	observerAdd (zfidentity eventId, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	see observerNotify
void	observerAddForOnce (zfidentity eventId, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	see observerNotify
void	observerRemove (zfidentity eventId, const ZFListener &callback)
	see observerNotify
void	observerRemoveAll (zfidentity eventId)
	see observerNotify
void	observerRemoveAll (void)
	see observerNotify
zfbool	observerHasAdd (void)
	true if any observer has been added
zfbool	observerHasAdd (zfidentity eventId)
	true if any observer with eventId has been added
void	observerNotify (zfidentity eventId, ZFObject *param0=zft_zfnull, ZFObject *param1=zft_zfnull)
	notify the observer with eventId
void	observerNotifyWithSender (ZFObject *customSender, zfidentity eventId, ZFObject *param0=zft_zfnull, ZFObject *param1=zft_zfnull)
	see observerNotify
void	observerNotifyReversely (zfidentity eventId, ZFObject *param0=zft_zfnull, ZFObject *param1=zft_zfnull)
	see observerNotify
void	observerNotifyReverselyWithSender (ZFObject *customSender, zfidentity eventId, ZFObject *param0=zft_zfnull, ZFObject *param1=zft_zfnull)
	see observerNotify
ZFObserver &	observerHolder (void)
	access the internal observer holder
void	on (const zfstring &eventName, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	util to observerAdd
void	on (zfidentity eventId, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	util to observerAdd
void	onInit (const ZFListener &impl)
	util for script to achieve chained call
void	onDealloc (const ZFListener &impl)
	util for script to achieve chained call
zfbool	objectInstanceStateCheck (ZFObjectInstanceState state)
	object instance's state
zfbool	objectInitRunning (void)
	util method to check whether ZFObjectInstanceStateOnInit or ZFObjectInstanceStateOnInitFinish running
zfbool	objectDeallocRunning (void)
	util method to check whether ZFObjectInstanceStateOnDeallocPrepare or ZFObjectInstanceStateOnDealloc running
virtual zfbool	objectIsInternal (void)
	whether this object is internal object or its class is ZFClass::classIsInternal
virtual zfbool	objectIsInternalPrivate (void)
	whether this object is internal private object or its class is ZFClass::classIsInternalPrivate

Static Public Member Functions
static const ZFClass *	ClassData (void)
	get class info
Static Public Member Functions inherited from ZFObject
static const ZFClass *	ClassData (void)
	get class info
static zfidentity	E_ObjectBeforeAlloc (void)
	see ZFObject::observerNotify
static zfidentity	E_ObjectAfterAlloc (void)
	see ZFObject::observerNotify
static zfidentity	E_ObjectBeforeDealloc (void)
	see ZFObject::observerNotify
static zfidentity	E_ObjectPropertyValueOnUpdate (void)
	see ZFObject::observerNotify
static zfidentity	E_ObjectPropertyValueOnReset (void)
	see ZFObject::observerNotify

Protected Types
typedef ZFObject	zfsuper
	class ref to super
typedef ZFTcp	zfself
	class ref to self
Protected Types inherited from ZFObject
typedef _ZFP_Obj_Base	zfsuper
	class ref to super
typedef ZFObject	zfself
	class ref to self

Protected Member Functions
virtual void	objectOnInit (void)
	override this to init your object
virtual void	objectOnDealloc (void)
	override this to destroy your object
virtual void	objectOnDeallocPrepare (void)
	called before objectOnDealloc, safe to call virtual functions here
Protected Member Functions inherited from ZFObject
virtual void	objectInfoImplAppend (zfstring &ret)
	see objectInfo
virtual zfidentity	objectHashImpl (void)
	see objectHash
virtual ZFCompareResult	objectCompareImpl (ZFObject *anotherObj)
	see objectCompare
virtual ZFCompareResult	objectCompareValueImpl (ZFObject *anotherObj)
	see objectCompareValue
virtual void	observerOnAdd (zfidentity eventId)
	called when add first observer
virtual void	observerOnRemove (zfidentity eventId)
	called when remove last observer
virtual void	observerOnEvent (const ZFArgs &zfargs)
	notified when observerNotify
virtual void	objectOnInitFinish (void)
	called after objectOnInit, safe to call virtual functions here
virtual void	objectOnRetain (void)
	called to retain object
virtual void	objectOnRelease (void)
	called to release object
virtual void	objectPropertyValueOnUpdate (const ZFProperty *property, const void *oldValue)
	see E_ObjectPropertyValueOnUpdate
virtual void	objectPropertyValueOnReset (const ZFProperty *property)
	see E_ObjectPropertyValueOnReset

Detailed Description

tcp request util

Member Function Documentation

classData()

virtual const ZFClass * ZFTcp::classData ( void )

inlinevirtual

get instance's class info

Reimplemented from ZFObject.

open()

virtual zfbool ZFTcp::open ( const zfstring & host, zfuint port, zftimet timeout = (-1) )

virtual

open a socket with specified host and port

• if host is null or empty, start local server that listen on the port, use accept to start accept client connection, and use send or recv on the tcp object returned by accept
• if host is not null or empty, try to connect to remote host, use send or recv to communicate with remote host

close()

virtual void ZFTcp::close ( )

virtual

close the socket, see open

close would be called automatically when owner tcp object deallocated

accept()

virtual zfautoT< ZFTcp > ZFTcp::accept ( zftimet timeout = (-1) )

virtual

start accept client connection

return a new tcp object that can send and recv to communicate with client, or null if error or no client connection

timeout:

• <0 : block current thread until anything received
• 0 : do not block current thread, return 0 if nothing to receive
• >0 : block current thread, until anything received, or reach timeout

send() [1/3]

virtual zfbool ZFTcp::send ( const zfstring & data )

virtual

send packet

note:

• this method would block current thread until done, call in new thread if necessary

send() [2/3]

virtual zfbool ZFTcp::send ( const void * data, zfindex size )

virtual

send packet

note:

• this method would block current thread until done, call in new thread if necessary

send() [3/3]

virtual zfbool ZFTcp::send ( const ZFInput & input )

virtual

send packet

note:

• this method would block current thread until done, call in new thread if necessary

recv() [1/2]

virtual zfindex ZFTcp::recv ( zfstring & data, zfindex maxSize = (((zfindex) -1)), zftimet timeout = (-1) )

virtual

recv packet until timeout

return length of received bytes, you may call close to stop recv

timeout:

• <0 : block current thread until anything received
• 0 : do not block current thread, return 0 if nothing to receive
• >0 : block current thread, until anything received, or reach timeout

received data would be appended to buffer, return zfindexMax if error

recv() [2/2]

virtual zfindex ZFTcp::recv ( const ZFOutput & output, zfindex maxSize = (((zfindex) -1)), zftimet timeout = (-1) )

virtual

recv packet until timeout

return length of received bytes, you may call close to stop recv

timeout:

• <0 : block current thread until anything received
• 0 : do not block current thread, return 0 if nothing to receive
• >0 : block current thread, until anything received, or reach timeout

received data would be appended to buffer, return zfindexMax if error

objectInfoImpl()

virtual void ZFTcp::objectInfoImpl ( zfstring & ret )

virtual

see objectInfo

Reimplemented from ZFObject.

objectOnInit()

virtual void ZFTcp::objectOnInit ( void )

protectedvirtual

override this to init your object

subclass must call superclass's objectOnInit before any other code if override
you may also declare objectOnInit with params like this:

zfclass Parent : ... {
    ...
protected:
    virtual void objectOnInit(void) {...};
};
zfclass Child : Parent {
protected:
    // override all parent's objectOnInit is also required,
    // because of function hiding of C++
    zfoverride
    virtual void objectOnInit(void) {
        zfsuper::objectOnInit();
    }
    // custom init entry
    virtual void objectOnInit(Params...) {
        // your extra init steps
        ...
    }
};

Warning

objectOnInit and objectOnDealloc is called as a virtual function, take good care of other virtual function call, use zfself::func() instead of this->func() if necessary, or use objectOnInitFinish/objectOnDeallocPrepare, or declare your own constructor with ZFOBJECT_DECLARE_WITH_CUSTOM_CTOR

Note

(ZFTAG_LIMITATION) due to limitations of C++, if your parent type declared objectOnInit with different params, and your child type want to override part of those objectOnInit, then your child type must also override all objectOnInit that parent declared, otherwise, some may be hidden

for objects that designed not to be allocated by user, you should use ZFOBJECT_PRIVATE_ALLOC, typically usage:

zfclass MyObject : zfextend ZFObject {
    ZFOBJECT_DECLARE(MyObject, ZFObject)
    ZFOBJECT_PRIVATE_ALLOC("should be created by MyObject::instanceForXxx only")
 
public:
    static zfauto instanceForXxx(xxx) {
        // can only be allocated by reflection
        return zfself::ClassData()->newInstance();
    }
};
static void func(void) {
    // MyObject *obj = zfobjAlloc(MyObject); // would compile error
    zfauto obj = MyObject::instanceForXxx(xxx); // OK
}

Reimplemented from ZFObject.

objectOnDealloc()

virtual void ZFTcp::objectOnDealloc ( void )

protectedvirtual

override this to destroy your object

subclass must call superclass's objectOnDealloc after any other code if override
see objectOnInit for more info

Reimplemented from ZFObject.

objectOnDeallocPrepare()

virtual void ZFTcp::objectOnDeallocPrepare ( void )

protectedvirtual

called before objectOnDealloc, safe to call virtual functions here

usually used to cleanup resources attached to this object other than self's internal resources

Note

it's ensured safe to retain the object while deallocating, but it's not ensured objectOnDeallocPrepare would only called once for each instance

Reimplemented from ZFObject.

---

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

• ZFTcp.h