CCHttpRequest Class Reference

defines the object which users must packed for CCHttpClient::send(HttpRequest*) method. More...

#include <HttpRequest.h>

Inheritance diagram for CCHttpRequest:

Classes
class	_prxy

Public Types
enum	HttpRequestType {   kHttpGet, kHttpPost, kHttpPut, kHttpDelete,   kHttpUnkown }

Public Member Functions
	CCHttpRequest ()
	// More...
virtual	~CCHttpRequest ()
	Destructor. More...
CCObject *	autorelease (void)
	Override autorelease method to avoid developers to call it. More...
void	setRequestType (HttpRequestType type)
	Required field for HttpRequest object before being sent. More...
HttpRequestType	getRequestType ()
	Get back the kHttpGet/Post/... More...
void	setUrl (const char *url)
	Required field for HttpRequest object before being sent. More...
const char *	getUrl ()
	Get back the setted url. More...
void	setRequestData (const char *buffer, unsigned int len)
	Option field. More...
char *	getRequestData ()
	Get the request data pointer back. More...
int	getRequestDataSize ()
	Get the size of request data back. More...
void	setTag (const char *tag)
	Option field. More...
const char *	getTag ()
	Get the string tag back to identify the request. More...
void	setUserData (void *pUserData)
	Option field. More...
void *	getUserData ()
	Get the pre-setted custom data pointer back. More...
CC_DEPRECATED_ATTRIBUTE void	setResponseCallback (CCObject *pTarget, SEL_CallFuncND pSelector)
	Required field. More...
void	setResponseCallback (CCObject *pTarget, SEL_HttpResponse pSelector)
CCObject *	getTarget ()
	Get the target of callback selector funtion, mainly used by CCHttpClient. More...
_prxy	getSelector ()
	Get the selector function pointer, mainly used by CCHttpClient. More...
void	setHeaders (std::vector< std::string > pHeaders)
	Set any custom headers. More...
std::vector< std::string >	getHeaders ()
	Get custom headers. More...
Public Member Functions inherited from CCObject
	CCObject (void)
virtual	~CCObject (void)
void	release (void)
void	retain (void)
CCObject *	autorelease (void)
CCObject *	copy (void)
bool	isSingleReference (void) const
unsigned int	retainCount (void) const
virtual bool	isEqual (const CCObject *pObject)
virtual void	acceptVisitor (CCDataVisitor &visitor)
virtual void	update (float dt)
Public Member Functions inherited from CCCopying
virtual CCObject *	copyWithZone (CCZone *pZone)

Protected Attributes
HttpRequestType	_requestType
std::string	_url
	kHttpRequestGet, kHttpRequestPost or other enums More...
std::vector< char >	_requestData
	target url that this request is sent to More...
std::string	_tag
	used for POST More...
CCObject *	_pTarget
	user defined tag, to identify different requests in response callback More...
SEL_HttpResponse	_pSelector
	callback target of pSelector function More...
void *	_pUserData
	callback function, e.g. MyLayer::onHttpResponse(CCHttpClient *sender, CCHttpResponse * response) More...
std::vector< std::string >	_headers
	You can add your customed data here. More...
Protected Attributes inherited from CCObject
unsigned int	m_uReference
unsigned int	m_uAutoReleaseCount

Additional Inherited Members
Public Attributes inherited from CCObject
unsigned int	m_uID
int	m_nLuaID

Detailed Description

defines the object which users must packed for CCHttpClient::send(HttpRequest*) method.

Please refer to samples/TestCpp/Classes/ExtensionTest/NetworkTest/HttpClientTest.cpp as a sample

Since

v2.0.2

Member Enumeration Documentation

enum HttpRequestType

Enumerator
kHttpGet
kHttpPost
kHttpPut
kHttpDelete
kHttpUnkown

Constructor & Destructor Documentation

CCHttpRequest ( )

inline

//

virtual ~CCHttpRequest ( )

inlinevirtual

Destructor.

Member Function Documentation

CCObject* autorelease ( void  )

inline

Override autorelease method to avoid developers to call it.

std::vector<std::string> getHeaders ( )

inline

Get custom headers.

char* getRequestData ( )

inline

Get the request data pointer back.

int getRequestDataSize ( )

inline

Get the size of request data back.

HttpRequestType getRequestType ( )

inline

Get back the kHttpGet/Post/...

enum value

_prxy getSelector ( )

inline

Get the selector function pointer, mainly used by CCHttpClient.

const char* getTag ( void  )

inline

Get the string tag back to identify the request.

The best practice is to use it in your MyClass::onMyHttpRequestCompleted(sender, HttpResponse*) callback

CCObject* getTarget ( void  )

inline

Get the target of callback selector funtion, mainly used by CCHttpClient.

const char* getUrl ( )

inline

Get back the setted url.

void* getUserData ( )

inline

Get the pre-setted custom data pointer back.

Don't forget to delete it. HttpClient/HttpResponse/HttpRequest will do nothing with this pointer

void setHeaders ( std::vector< std::string >  pHeaders )

inline

Set any custom headers.

void setRequestData ( const char *  buffer, unsigned int  len  )

inline

Option field.

You can set your post data here

void setRequestType ( HttpRequestType  type )

inline

Required field for HttpRequest object before being sent.

kHttpGet & kHttpPost is currently supported

CC_DEPRECATED_ATTRIBUTE void setResponseCallback ( CCObject *  pTarget, SEL_CallFuncND  pSelector  )

inline

Required field.

You should set the callback selector function at ack the http request completed

void setResponseCallback ( CCObject *  pTarget, SEL_HttpResponse  pSelector  )

inline

void setTag ( const char *  tag )

inline

Option field.

You can set a string tag to identify your request, this tag can be found in HttpResponse->getHttpRequest->getTag()

void setUrl ( const char *  url )

inline

Required field for HttpRequest object before being sent.

void setUserData ( void *  pUserData )

inline

Option field.

You can attach a customed data in each request, and get it back in response callback. But you need to new/delete the data pointer manully

Member Data Documentation

std::vector<std::string> _headers

protected

You can add your customed data here.

SEL_HttpResponse _pSelector

protected

callback target of pSelector function

CCObject* _pTarget

protected

user defined tag, to identify different requests in response callback

void* _pUserData

protected

callback function, e.g. MyLayer::onHttpResponse(CCHttpClient *sender, CCHttpResponse * response)

std::vector<char> _requestData

protected

target url that this request is sent to

HttpRequestType _requestType

protected

std::string _tag

protected

used for POST

std::string _url

protected

kHttpRequestGet, kHttpRequestPost or other enums

---

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

• /Users/guanghui/cocos2d-x/extensions/network/HttpRequest.h