cocos2d-x  3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
SIOClient Class Reference

A single connection to a socket.io endpoint. More...

#include <SocketIO.h>

Inheritance diagram for SIOClient:
Ref

Public Member Functions

 SIOClient (const std::string &host, int port, const std::string &path, SIOClientImpl *impl, SocketIO::SIODelegate &delegate)
 SIOClient ( var host, var port, var path, var impl, var delegate)
 SIOClient ( local host, local port, local path, local impl, local delegate)
virtual ~SIOClient (void)
var ~SIOClient ()
local ~SIOClient ()
SocketIO::SIODelegategetDelegate ()
 Returns the delegate for the client. More...
 
var getDelegate ()
 Returns the delegate for the client. More...
 
local getDelegate ()
 Returns the delegate for the client. More...
 
void disconnect ()
 Disconnect from the endpoint, onClose will be called on the delegate when complete. More...
 
void send (std::string s)
 Send a message to the socket.io server. More...
 
var send ( var s)
 Send a message to the socket.io server. More...
 
local send ( local s)
 Send a message to the socket.io server. More...
 
void emit (std::string eventname, std::string args)
 The delegate class to process socket.io events. More...
 
var emit ( var eventname, var args)
 The delegate class to process socket.io events. More...
 
local emit ( local eventname, local args)
 The delegate class to process socket.io events. More...
 
void on (const std::string &eventName, SIOEvent e)
 Used to register a socket.io event callback Event argument should be passed using CC_CALLBACK2(&Base::function, this) More...
 
void setTag (const char *tag)
const char * getTag ()
var getTag ()
local getTag ()
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()

Friends

class SIOClientImpl

Additional Inherited Members

- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 

Detailed Description

A single connection to a socket.io endpoint.

Constructor & Destructor Documentation

SIOClient ( const std::string &  host,
int  port,
const std::string &  path,
SIOClientImpl impl,
SocketIO::SIODelegate delegate 
)
var SIOClient ( var  host,
var  port,
var  path,
var  impl,
var  delegate 
)
local SIOClient ( local  host,
local  port,
local  path,
local  impl,
local  delegate 
)
virtual ~SIOClient ( void  )
virtual
var ~SIOClient (   )
virtual
local ~SIOClient (   )
virtual

Member Function Documentation

void disconnect ( )

Disconnect from the endpoint, onClose will be called on the delegate when complete.

var disconnect ( )

Disconnect from the endpoint, onClose will be called on the delegate when complete.

local disconnect ( )

Disconnect from the endpoint, onClose will be called on the delegate when complete.

void emit ( std::string  eventname,
std::string  args 
)

The delegate class to process socket.io events.

var emit ( var  eventname,
var  args 
)

The delegate class to process socket.io events.

local emit ( local  eventname,
local  args 
)

The delegate class to process socket.io events.

SocketIO::SIODelegate* getDelegate ( )
inline

Returns the delegate for the client.

var getDelegate ( )
inline

Returns the delegate for the client.

local getDelegate ( )
inline

Returns the delegate for the client.

const char* getTag ( )
inline
var getTag ( )
inline
local getTag ( )
inline
void on ( const std::string &  eventName,
SIOEvent  e 
)

Used to register a socket.io event callback Event argument should be passed using CC_CALLBACK2(&Base::function, this)

var on ( var  eventName,
var  e 
)

Used to register a socket.io event callback Event argument should be passed using CC_CALLBACK2(&Base::function, this)

local on ( local  eventName,
local  e 
)

Used to register a socket.io event callback Event argument should be passed using CC_CALLBACK2(&Base::function, this)

void send ( std::string  s)

Send a message to the socket.io server.

var send ( var  s)

Send a message to the socket.io server.

local send ( local  s)

Send a message to the socket.io server.

void setTag ( const char *  tag)
inline
var setTag ( var  tag)
inline
local setTag ( local  tag)
inline

Friends And Related Function Documentation

friend class SIOClientImpl
friend
var SIOClientImpl
friend
local SIOClientImpl
friend

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