#include <SocketIOTest.h>

类 SocketIOTest 继承关系图:

SocketIOTest 的协作图:

Public 成员函数
	CREATE_FUNC (SocketIOTest)

	SocketIOTest ()

virtual	~SocketIOTest ()

virtual void	onClose (cocos2d::network::SIOClient *client) override
	Used for network level socket close (not for disconnect from the socket.io server) 更多...

virtual void	onError (cocos2d::network::SIOClient *client, const std::string &data) override
	Used for network level socket error (not for disconnect from the socket.io server) 更多...

void	closedSocketAction (cocos2d::network::SIOClient *client)
	Common function to call on both socket.io disconnect and websocket close 更多...

void	onMenuSIOClientClicked (cocos2d::Ref *sender)

void	onMenuTestMessageClicked (cocos2d::Ref *sender)

void	onMenuTestEventClicked (cocos2d::Ref *sender)

void	onMenuTestClientDisconnectClicked (cocos2d::Ref *sender)

void	onMenuSIOEndpointClicked (cocos2d::Ref *sender)

void	onMenuTestMessageEndpointClicked (cocos2d::Ref *sender)

void	onMenuTestEventEndpointClicked (cocos2d::Ref *sender)

void	onMenuTestEndpointDisconnectClicked (cocos2d::Ref *sender)

void	testevent (cocos2d::network::SIOClient *client, const std::string &data)
	Socket.io event handler for custom event "testevent" 更多...

void	echotest (cocos2d::network::SIOClient *client, const std::string &data)
	Socket.io event handler for custom event "echoevent" 更多...

void	connect (cocos2d::network::SIOClient *client, const std::string &data)
	Socket.io event handler for event "connect" 更多...

void	disconnect (cocos2d::network::SIOClient *client, const std::string &data)
	Socket.io event handler for event "disconnect" 更多...

void	message (cocos2d::network::SIOClient *client, const std::string &data)
	Socket.io event handler for event "message" 更多...

void	json (cocos2d::network::SIOClient *client, const std::string &data)
	Socket.io event handler for event "json" This is only used in v 0.9.x, in 1.x this is handled as a "message" event 更多...

virtual std::string	title () const override

Public 成员函数继承自 TestCase
	TestCase ()

	~TestCase ()

virtual std::string	subtitle () const

virtual Type	getTestType () const

virtual float	getDuration () const

virtual std::string	getExpectedOutput () const

virtual std::string	getActualOutput () const

virtual void	restartTestCallback (cocos2d::Ref *sender)

virtual void	nextTestCallback (cocos2d::Ref *sender)

virtual void	priorTestCallback (cocos2d::Ref *sender)

virtual void	onBackCallback (cocos2d::Ref *sender)

void	setTestSuite (TestSuite *testSuite)

TestSuite *	getTestSuite () const

float	getRunTime () const

void	setTestCaseName (const std::string &name)

std::string	getTestCaseName () const

const cocos2d::Label *	getSubtitleLable () const

const cocos2d::MenuItemImage *	getRestartTestItem () const

virtual void	onEnter () override

Protected 属性
cocos2d::network::SIOClient *	_sioClient

cocos2d::network::SIOClient *	_sioEndpoint

cocos2d::Label *	_sioClientStatus

Protected 属性继承自 TestCase
cocos2d::MenuItemImage *	_priorTestItem

cocos2d::MenuItemImage *	_restartTestItem

cocos2d::MenuItemImage *	_nextTestItem

cocos2d::Label *	_titleLabel

cocos2d::Label *	_subtitleLabel

额外继承的成员函数
Public 类型继承自 TestCase
enum class	Type { ROBUSTNESS , UNIT , GRAPHICAL_STATIC , MANUAL }

Public 属性继承自 TestCase
CC_CONSTRUCTOR_ACCESS	__pad0__: virtual bool init() override

详细描述

在文件 SocketIOTest.h 第 38 行定义.

构造及析构函数说明

◆ SocketIOTest()

SocketIOTest::SocketIOTest ( )

在文件 SocketIOTest.cpp 第 40 行定义.

    : _sioClient(nullptr)
    , _sioEndpoint(nullptr)
    , _sioClientStatus(nullptr)
{//set the clients to nullptr until we are ready to connect
 
    Size winSize = Director::getInstance()->getWinSize();
 
    const int MARGIN = 40;
    const int SPACE = 35;
 
    auto menuRequest = Menu::create();
    menuRequest->setPosition(Vec2::ZERO);
    addChild(menuRequest);
 
    // Test to create basic client in the default namespace
    auto labelSIOClient = Label::createWithTTF("Open SocketIO Client", "fonts/arial.ttf", 22);
    auto itemSIOClient = MenuItemLabel::create(labelSIOClient, CC_CALLBACK_1(SocketIOTest::onMenuSIOClientClicked, this));
    itemSIOClient->setPosition(Vec2(VisibleRect::left().x + labelSIOClient->getContentSize().width / 2 + 5, winSize.height - MARGIN - SPACE));
    menuRequest->addChild(itemSIOClient);
 
    // Test to create a client at the endpoint '/testpoint'
    auto labelSIOEndpoint = Label::createWithTTF("Open SocketIO Endpoint", "fonts/arial.ttf", 22);
    auto itemSIOEndpoint = MenuItemLabel::create(labelSIOEndpoint, CC_CALLBACK_1(SocketIOTest::onMenuSIOEndpointClicked, this));
    itemSIOEndpoint->setPosition(Vec2(VisibleRect::right().x - labelSIOEndpoint->getContentSize().width / 2 - 5, winSize.height - MARGIN - SPACE));
    menuRequest->addChild(itemSIOEndpoint);
 
    // Test sending message to default namespace
    auto labelTestMessage = Label::createWithTTF("Send Test Message", "fonts/arial.ttf", 22);
    auto itemTestMessage = MenuItemLabel::create(labelTestMessage, CC_CALLBACK_1(SocketIOTest::onMenuTestMessageClicked, this));
    itemTestMessage->setPosition(Vec2(VisibleRect::left().x + labelTestMessage->getContentSize().width / 2 + 5, winSize.height - MARGIN - 2 * SPACE));
    menuRequest->addChild(itemTestMessage);
 
    // Test sending message to the endpoint '/testpoint'
    auto labelTestMessageEndpoint = Label::createWithTTF("Test Endpoint Message", "fonts/arial.ttf", 22);
    auto itemTestMessageEndpoint = MenuItemLabel::create(labelTestMessageEndpoint, CC_CALLBACK_1(SocketIOTest::onMenuTestMessageEndpointClicked, this));
    itemTestMessageEndpoint->setPosition(Vec2(VisibleRect::right().x - labelTestMessageEndpoint->getContentSize().width / 2 - 5, winSize.height - MARGIN - 2 * SPACE));
    menuRequest->addChild(itemTestMessageEndpoint);
 
    // Test sending event 'echotest' to default namespace
    auto labelTestEvent = Label::createWithTTF("Send Test Event", "fonts/arial.ttf", 22);
    auto itemTestEvent = MenuItemLabel::create(labelTestEvent, CC_CALLBACK_1(SocketIOTest::onMenuTestEventClicked, this));
    itemTestEvent->setPosition(Vec2(VisibleRect::left().x + labelTestEvent->getContentSize().width / 2 + 5, winSize.height - MARGIN - 3 * SPACE));
    menuRequest->addChild(itemTestEvent);
 
    // Test sending event 'echotest' to the endpoint '/testpoint'
    auto labelTestEventEndpoint = Label::createWithTTF("Test Endpoint Event", "fonts/arial.ttf", 22);
    auto itemTestEventEndpoint = MenuItemLabel::create(labelTestEventEndpoint, CC_CALLBACK_1(SocketIOTest::onMenuTestEventEndpointClicked, this));
    itemTestEventEndpoint->setPosition(Vec2(VisibleRect::right().x - labelTestEventEndpoint->getContentSize().width / 2 - 5, winSize.height - MARGIN - 3 * SPACE));
    menuRequest->addChild(itemTestEventEndpoint);
 
    // Test disconnecting basic client
    auto labelTestClientDisconnect = Label::createWithTTF("Disconnect Socket", "fonts/arial.ttf", 22);
    auto itemClientDisconnect = MenuItemLabel::create(labelTestClientDisconnect, CC_CALLBACK_1(SocketIOTest::onMenuTestClientDisconnectClicked, this));
    itemClientDisconnect->setPosition(Vec2(VisibleRect::left().x + labelTestClientDisconnect->getContentSize().width / 2 + 5, winSize.height - MARGIN - 4 * SPACE));
    menuRequest->addChild(itemClientDisconnect);
 
    // Test disconnecting the endpoint '/testpoint'
    auto labelTestEndpointDisconnect = Label::createWithTTF("Disconnect Endpoint", "fonts/arial.ttf", 22);
    auto itemTestEndpointDisconnect = MenuItemLabel::create(labelTestEndpointDisconnect, CC_CALLBACK_1(SocketIOTest::onMenuTestEndpointDisconnectClicked, this));
    itemTestEndpointDisconnect->setPosition(Vec2(VisibleRect::right().x - labelTestEndpointDisconnect->getContentSize().width / 2 - 5, winSize.height - MARGIN - 4 * SPACE));
    menuRequest->addChild(itemTestEndpointDisconnect);
 
    // Shared Status Label
    _sioClientStatus = Label::createWithTTF("Not connected...", "fonts/arial.ttf", 14, Size(320, 100), TextHAlignment::LEFT);
    _sioClientStatus->setAnchorPoint(Vec2(0, 0));
    _sioClientStatus->setPosition(Vec2(VisibleRect::left().x, VisibleRect::rightBottom().y));
    this->addChild(_sioClientStatus);
}

引用了 _sioClientStatus, VisibleRect::left(), onMenuSIOClientClicked(), onMenuSIOEndpointClicked(), onMenuTestClientDisconnectClicked(), onMenuTestEndpointDisconnectClicked(), onMenuTestEventClicked(), onMenuTestEventEndpointClicked(), onMenuTestMessageClicked(), onMenuTestMessageEndpointClicked(), VisibleRect::right() , 以及 VisibleRect::rightBottom().

函数调用图:

◆ ~SocketIOTest()

SocketIOTest::~SocketIOTest ( )

virtual

在文件 SocketIOTest.cpp 第 111 行定义.

112{

113}

成员函数说明

◆ closedSocketAction()

void SocketIOTest::closedSocketAction ( cocos2d::network::SIOClient * client )

Common function to call on both socket.io disconnect and websocket close

在文件 SocketIOTest.cpp 第 182 行定义.

{
    //set the local pointer to nullptr or connect to another client
    //the client object will be released on its own after this method completes
    if (client == _sioClient) {
 
        _sioClient = nullptr;
    }
    else if (client == _sioEndpoint) {
 
        _sioEndpoint = nullptr;
    }
}

引用了 _sioClient , 以及 _sioEndpoint.

被这些函数引用 disconnect() , 以及 onClose().

这是这个函数的调用关系图:

◆ connect()

void SocketIOTest::connect	(	cocos2d::network::SIOClient *	client,
		const std::string &	data
	)

Socket.io event handler for event "connect"

在文件 SocketIOTest.cpp 第 160 行定义.

{
    CCLOGINFO("SocketIOTest::connect called");
 
    std::stringstream s;
    s << client->getTag() << " connected!";
    _sioClientStatus->setString(s.str().c_str());
 
}

引用了 _sioClientStatus.

被这些函数引用 onMenuSIOClientClicked() , 以及 onMenuSIOEndpointClicked().

这是这个函数的调用关系图:

◆ CREATE_FUNC()

SocketIOTest::CREATE_FUNC ( SocketIOTest )

◆ disconnect()

void SocketIOTest::disconnect	(	cocos2d::network::SIOClient *	client,
		const std::string &	data
	)

Socket.io event handler for event "disconnect"

在文件 SocketIOTest.cpp 第 170 行定义.

{
    CCLOGINFO("SocketIOTest::disconnect called");
 
    std::stringstream s;
    s << client->getTag() << " disconnected by server!";
    _sioClientStatus->setString(s.str().c_str());
 
    this->closedSocketAction(client);
 
}

引用了 _sioClientStatus , 以及 closedSocketAction().

被这些函数引用 onMenuSIOClientClicked() , 以及 onMenuSIOEndpointClicked().

函数调用图:

这是这个函数的调用关系图:

◆ echotest()

void SocketIOTest::echotest	(	cocos2d::network::SIOClient *	client,
		const std::string &	data
	)

Socket.io event handler for custom event "echoevent"

在文件 SocketIOTest.cpp 第 127 行定义.

                                                                    {
 
    CCLOGINFO("SocketIOTest::echotest called with data: %s", data.c_str());
 
    std::stringstream s;
    s << client->getTag() << " received event echotest with data: " << data.c_str();
 
    _sioClientStatus->setString(s.str().c_str());
 
}

引用了 _sioClientStatus.

被这些函数引用 onMenuSIOClientClicked() , 以及 onMenuSIOEndpointClicked().

这是这个函数的调用关系图:

◆ json()

void SocketIOTest::json	(	cocos2d::network::SIOClient *	client,
		const std::string &	data
	)

Socket.io event handler for event "json" This is only used in v 0.9.x, in 1.x this is handled as a "message" event

在文件 SocketIOTest.cpp 第 150 行定义.

{
    CCLOGINFO("SocketIOTest::json received: %s", data.c_str());
 
    std::stringstream s;
    s << client->getTag() << " received json message with content: " << data.c_str();
    _sioClientStatus->setString(s.str().c_str());
 
}

引用了 _sioClientStatus.

被这些函数引用 onMenuSIOClientClicked() , 以及 onMenuSIOEndpointClicked().

这是这个函数的调用关系图:

◆ message()

void SocketIOTest::message	(	cocos2d::network::SIOClient *	client,
		const std::string &	data
	)

Socket.io event handler for event "message"

在文件 SocketIOTest.cpp 第 140 行定义.

{
    CCLOGINFO("SocketIOTest::message received: %s", data.c_str());
 
    std::stringstream s;
    s << client->getTag() << " received message with content: " << data.c_str();
    _sioClientStatus->setString(s.str().c_str());
 
}

引用了 _sioClientStatus.

被这些函数引用 onMenuSIOClientClicked() , 以及 onMenuSIOEndpointClicked().

这是这个函数的调用关系图:

◆ onClose()

void SocketIOTest::onClose ( cocos2d::network::SIOClient * client )

overridevirtual

Used for network level socket close (not for disconnect from the socket.io server)

在文件 SocketIOTest.cpp 第 297 行定义.

{
    CCLOGINFO("SocketIOTest::onClose called");
 
    std::stringstream s;
    s << client->getTag() << " closed!";
    _sioClientStatus->setString(s.str().c_str());
 
    this->closedSocketAction(client);
 
}

引用了 _sioClientStatus , 以及 closedSocketAction().

函数调用图:

◆ onError()

void SocketIOTest::onError	(	cocos2d::network::SIOClient *	client,
		const std::string &	data
	)

overridevirtual

Used for network level socket error (not for disconnect from the socket.io server)

在文件 SocketIOTest.cpp 第 309 行定义.

{
    CCLOGERROR("SocketIOTest::onError received: %s", data.c_str());
 
    std::stringstream s;
    s << client->getTag() << " received error with content: " << data.c_str();
    _sioClientStatus->setString(s.str().c_str());
}

引用了 _sioClientStatus.

◆ onMenuSIOClientClicked()

void SocketIOTest::onMenuSIOClientClicked ( cocos2d::Ref * sender )

在文件 SocketIOTest.cpp 第 196 行定义.

{
    //create a client by using this static method, url does not need to contain the protocol
    _sioClient = SocketIO::connect("ws://tools.itharbors.com:4000", *this);
    //you may set a tag for the client for reference in callbacks
    _sioClient->setTag("Test Client");
 
    //register event callbacks using the CC_CALLBACK_2() macro and passing the instance of the target class
    _sioClient->on("testevent", CC_CALLBACK_2(SocketIOTest::testevent, this));
    _sioClient->on("echotest", CC_CALLBACK_2(SocketIOTest::echotest, this));
    _sioClient->on("message", CC_CALLBACK_2(SocketIOTest::message, this));
    _sioClient->on("json", CC_CALLBACK_2(SocketIOTest::json, this));
    _sioClient->on("connect", CC_CALLBACK_2(SocketIOTest::connect, this));
    _sioClient->on("disconnect", CC_CALLBACK_2(SocketIOTest::disconnect, this));
 
}

引用了 _sioClient, connect(), disconnect(), echotest(), json(), message() , 以及 testevent().

被这些函数引用 SocketIOTest().

函数调用图:

这是这个函数的调用关系图:

◆ onMenuSIOEndpointClicked()

void SocketIOTest::onMenuSIOEndpointClicked ( cocos2d::Ref * sender )

在文件 SocketIOTest.cpp 第 213 行定义.

{
    //repeat the same connection steps for the namespace "testpoint"
    _sioEndpoint = SocketIO::connect("ws://tools.itharbors.com:4000/testpoint", *this); 
    //a tag to differentiate in shared callbacks
    _sioEndpoint->setTag("Test Endpoint");
 
    //demonstrating how callbacks can be shared within a delegate
    _sioEndpoint->on("testevent", CC_CALLBACK_2(SocketIOTest::testevent, this));
    _sioEndpoint->on("echotest", CC_CALLBACK_2(SocketIOTest::echotest, this));
    _sioEndpoint->on("message", CC_CALLBACK_2(SocketIOTest::message, this));
    _sioEndpoint->on("json", CC_CALLBACK_2(SocketIOTest::json, this));
    _sioEndpoint->on("connect", CC_CALLBACK_2(SocketIOTest::connect, this));
    _sioEndpoint->on("disconnect", CC_CALLBACK_2(SocketIOTest::disconnect, this));
 
}

引用了 _sioEndpoint, connect(), disconnect(), echotest(), json(), message() , 以及 testevent().

被这些函数引用 SocketIOTest().

函数调用图:

这是这个函数的调用关系图:

◆ onMenuTestClientDisconnectClicked()

void SocketIOTest::onMenuTestClientDisconnectClicked ( cocos2d::Ref * sender )

在文件 SocketIOTest.cpp 第 260 行定义.

{
    // Disconnecting from the default namespace "" or "/" will also disconnect all other endpoints
    std::stringstream s;
 
    if (_sioClient != nullptr) {
        s << _sioClient->getTag() << " manually closed!";
        _sioClient->disconnect();
        _sioClient = nullptr;
    }
    else {
        s << "Socket.io Test Client not initialized!";
    }
 
    _sioClientStatus->setString(s.str().c_str());
 
}

引用了 _sioClient , 以及 _sioClientStatus.

被这些函数引用 SocketIOTest().

这是这个函数的调用关系图:

◆ onMenuTestEndpointDisconnectClicked()

void SocketIOTest::onMenuTestEndpointDisconnectClicked ( cocos2d::Ref * sender )

在文件 SocketIOTest.cpp 第 278 行定义.

{
    std::stringstream s;
 
    if (_sioEndpoint != nullptr) {
        s << _sioEndpoint->getTag() << " manually closed!";
        _sioEndpoint->disconnect();
        _sioEndpoint = nullptr;
    }
    else {
        s << "Socket.io Test Endpoint not initialized!";
    }
 
    _sioClientStatus->setString(s.str().c_str());
 
}

引用了 _sioClientStatus , 以及 _sioEndpoint.

被这些函数引用 SocketIOTest().

这是这个函数的调用关系图:

◆ onMenuTestEventClicked()

void SocketIOTest::onMenuTestEventClicked ( cocos2d::Ref * sender )

在文件 SocketIOTest.cpp 第 245 行定义.

{
    //check that the socket is != nullptr before sending or emitting events
    //the client should be nullptr either before initialization and connection or after disconnect
    if (_sioClient != nullptr) _sioClient->emit("echotest", "{\"name\":\"myname\",\"type\":\"mytype\"}");
 
}

引用了 _sioClient.

被这些函数引用 SocketIOTest().

这是这个函数的调用关系图:

◆ onMenuTestEventEndpointClicked()

void SocketIOTest::onMenuTestEventEndpointClicked ( cocos2d::Ref * sender )

在文件 SocketIOTest.cpp 第 253 行定义.

{
 
    if (_sioEndpoint != nullptr) _sioEndpoint->emit("echotest", "{\"name\":\"myname\",\"type\":\"mytype\"}");
 
}

引用了 _sioEndpoint.

被这些函数引用 SocketIOTest().

这是这个函数的调用关系图:

◆ onMenuTestMessageClicked()

void SocketIOTest::onMenuTestMessageClicked ( cocos2d::Ref * sender )

在文件 SocketIOTest.cpp 第 230 行定义.

{
    //check that the socket is != nullptr before sending or emitting events
    //the client should be nullptr either before initialization and connection or after disconnect
    if (_sioClient != nullptr) _sioClient->send("Hello Socket.IO!");
 
}

引用了 _sioClient.

被这些函数引用 SocketIOTest().

这是这个函数的调用关系图:

◆ onMenuTestMessageEndpointClicked()

void SocketIOTest::onMenuTestMessageEndpointClicked ( cocos2d::Ref * sender )

在文件 SocketIOTest.cpp 第 238 行定义.

{
 
    if (_sioEndpoint != nullptr) _sioEndpoint->send("Hello Socket.IO!");
 
}

引用了 _sioEndpoint.

被这些函数引用 SocketIOTest().

这是这个函数的调用关系图:

◆ testevent()

void SocketIOTest::testevent	(	cocos2d::network::SIOClient *	client,
		const std::string &	data
	)

Socket.io event handler for custom event "testevent"

在文件 SocketIOTest.cpp 第 116 行定义.

                                                                     {
 
    CCLOGINFO("SocketIOTest::testevent called with data: %s", data.c_str());
 
    std::stringstream s;
    s << client->getTag() << " received event testevent with data: " << data.c_str();
 
    _sioClientStatus->setString(s.str().c_str());
 
}

引用了 _sioClientStatus.

被这些函数引用 onMenuSIOClientClicked() , 以及 onMenuSIOEndpointClicked().

这是这个函数的调用关系图:

◆ title()

virtual std::string SocketIOTest::title ( ) const

inlineoverridevirtual

重载 TestCase .

在文件 SocketIOTest.h 第 100 行定义.

100{ return "SocketIO Extension Test"; }

类成员变量说明

◆ _sioClient

cocos2d::network::SIOClient* SocketIOTest::_sioClient

protected

在文件 SocketIOTest.h 第 104 行定义.

被这些函数引用 closedSocketAction(), onMenuSIOClientClicked(), onMenuTestClientDisconnectClicked(), onMenuTestEventClicked() , 以及 onMenuTestMessageClicked().

◆ _sioClientStatus

cocos2d::Label* SocketIOTest::_sioClientStatus

protected

在文件 SocketIOTest.h 第 106 行定义.

被这些函数引用 connect(), disconnect(), echotest(), json(), message(), onClose(), onError(), onMenuTestClientDisconnectClicked(), onMenuTestEndpointDisconnectClicked(), SocketIOTest() , 以及 testevent().

◆ _sioEndpoint

cocos2d::network::SIOClient * SocketIOTest::_sioEndpoint

protected

在文件 SocketIOTest.h 第 104 行定义.

被这些函数引用 closedSocketAction(), onMenuSIOEndpointClicked(), onMenuTestEndpointDisconnectClicked(), onMenuTestEventEndpointClicked() , 以及 onMenuTestMessageEndpointClicked().

该类的文档由以下文件生成:

/Users/yujizhu/Documents/Git/cocos2d-x-4.0/tests/cpp-tests/Classes/ExtensionsTest/NetworkTest/SocketIOTest.h
/Users/yujizhu/Documents/Git/cocos2d-x-4.0/tests/cpp-tests/Classes/ExtensionsTest/NetworkTest/SocketIOTest.cpp

Public 成员函数

Protected 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ SocketIOTest()

◆ ~SocketIOTest()

成员函数说明

◆ closedSocketAction()

◆ connect()

◆ CREATE_FUNC()

◆ disconnect()

◆ echotest()

◆ json()

◆ message()

◆ onClose()

◆ onError()

◆ onMenuSIOClientClicked()

◆ onMenuSIOEndpointClicked()

◆ onMenuTestClientDisconnectClicked()

◆ onMenuTestEndpointDisconnectClicked()

◆ onMenuTestEventClicked()

◆ onMenuTestEventEndpointClicked()

◆ onMenuTestMessageClicked()

◆ onMenuTestMessageEndpointClicked()

◆ testevent()

◆ title()

类成员变量说明

◆ _sioClient

◆ _sioClientStatus

◆ _sioEndpoint