[Plugin] Socket.io Client

anonymous_user_a53f035c · March 28, 2017, 11:13pm

Sure I can give you whole example as it’s very easy, it is clean ThirdPersonExample with starter content with custom GameMode containing only what you can see on screens. It is running with dedicated server in the background with 1 client. Engine version is 4.15.1 here are the screens from Unreal:

Here is the code for my node.js app (in TypeScript):


import * as express from 'express'
import * as http from 'http'
import * as socketIO from 'socket.io'

import SelectPlayerNation from './src/SelectPlayerNation'

const app = express()
const server = http.createServer(app)
var io = socketIO(server)

io.on('connection', (socket) => {
    console.log('Game server connected from: ' + socket.handshake.address)

    socket.on('nationize', (msg) => {
        console.log('Selecting nation started...')
        if (SelectPlayerNation("a", 1)) {
            console.log('Nation selected')
            socket.emit('nation-selected')
            return
        }

        console.log('Error while selecting nation')
        socket.emit('nation-selection-error')
    })
})

server.listen(3000, () => {
    console.log('Server listen on *:3000')
})

And here is SelectPlayerNation function that is imported:



export default function GetPlayerNation(sid:string):number {
    return 0;
}

PM2 Logs when I run the server and try to run Unreal client:


C:\Users
ewicz\.pm2\pm2.log last 15 lines:
PM2        | 2017-03-29 01:01:30: ===============================================================================
PM2        | 2017-03-29 01:01:30: --- New PM2 Daemon started ----------------------------------------------------
PM2        | 2017-03-29 01:01:30: Time                 : Wed Mar 29 2017 01:01:30 GMT+0200 (Central European Daylight Time)
PM2        | 2017-03-29 01:01:30: PM2 version          : 2.4.2
PM2        | 2017-03-29 01:01:30: Node.js version      : 6.10.1
PM2        | 2017-03-29 01:01:30: Current arch         : x64
PM2        | 2017-03-29 01:01:30: PM2 home             : C:\Users
ewicz\.pm2
PM2        | 2017-03-29 01:01:30: PM2 PID file         : C:\Users
ewicz\.pm2\pm2.pid
PM2        | 2017-03-29 01:01:30: RPC socket file      : \\.\pipe\rpc.sock
PM2        | 2017-03-29 01:01:30: BUS socket file      : \\.\pipe\pub.sock
PM2        | 2017-03-29 01:01:30: Application log path : C:\Users
ewicz\.pm2\logs
PM2        | 2017-03-29 01:01:30: Process dump file    : C:\Users
ewicz\.pm2\dump.pm2
PM2        | 2017-03-29 01:01:30: Concurrent actions   : 2
PM2        | 2017-03-29 01:01:30: SIGTERM timeout      : 1600
PM2        | 2017-03-29 01:01:30: ===============================================================================

[STREAMING] Now streaming realtime logs for [all] processes
PM2        | [Watch] Start watching 0
PM2        | Starting execution sequence in -fork mode- for app name:api-app id:0
PM2        | App name:api-app id:0 online
0|api-app  | Server listen on *:3000
0|api-app  | Game server connected from: ::1

EDIT: SOLUTION FOUND
I’ve found the reason it was emiting the clean event from nodejs app. Once I changed:


socket.emit('nation-selected')

to


socket.emit('nation-selected', {})

It worked just fine! Thank you for pointing me into right direction, I will leave this for others that may have problem with that.

getnamo · March 29, 2017, 1:43pm

newicz;687304:

Sure I can give you whole example as it’s very easy, it is clean ThirdPersonExample with starter content with custom GameMode containing only what you can see on screens. It is running with dedicated server in the background with 1 client. Engine version is 4.15.1 here are the screens from Unreal:

Here is the code for my node.js app (in TypeScript):


import * as express from 'express'
import * as http from 'http'
import * as socketIO from 'socket.io'

import SelectPlayerNation from './src/SelectPlayerNation'

const app = express()
const server = http.createServer(app)
var io = socketIO(server)

io.on('connection', (socket) => {
    console.log('Game server connected from: ' + socket.handshake.address)

    socket.on('nationize', (msg) => {
        console.log('Selecting nation started...')
        if (SelectPlayerNation("a", 1)) {
            console.log('Nation selected')
            socket.emit('nation-selected')
            return
        }

        console.log('Error while selecting nation')
        socket.emit('nation-selection-error')
    })
})

server.listen(3000, () => {
    console.log('Server listen on *:3000')
})

And here is SelectPlayerNation function that is imported:



export default function GetPlayerNation(sid:string):number {
    return 0;
}

PM2 Logs when I run the server and try to run Unreal client:


C:\Users
ewicz\.pm2\pm2.log last 15 lines:
PM2        | 2017-03-29 01:01:30: ===============================================================================
PM2        | 2017-03-29 01:01:30: --- New PM2 Daemon started ----------------------------------------------------
PM2        | 2017-03-29 01:01:30: Time                 : Wed Mar 29 2017 01:01:30 GMT+0200 (Central European Daylight Time)
PM2        | 2017-03-29 01:01:30: PM2 version          : 2.4.2
PM2        | 2017-03-29 01:01:30: Node.js version      : 6.10.1
PM2        | 2017-03-29 01:01:30: Current arch         : x64
PM2        | 2017-03-29 01:01:30: PM2 home             : C:\Users
ewicz\.pm2
PM2        | 2017-03-29 01:01:30: PM2 PID file         : C:\Users
ewicz\.pm2\pm2.pid
PM2        | 2017-03-29 01:01:30: RPC socket file      : \\.\pipe\rpc.sock
PM2        | 2017-03-29 01:01:30: BUS socket file      : \\.\pipe\pub.sock
PM2        | 2017-03-29 01:01:30: Application log path : C:\Users
ewicz\.pm2\logs
PM2        | 2017-03-29 01:01:30: Process dump file    : C:\Users
ewicz\.pm2\dump.pm2
PM2        | 2017-03-29 01:01:30: Concurrent actions   : 2
PM2        | 2017-03-29 01:01:30: SIGTERM timeout      : 1600
PM2        | 2017-03-29 01:01:30: ===============================================================================

[STREAMING] Now streaming realtime logs for [all] processes
PM2        | [Watch] Start watching 0
PM2        | Starting execution sequence in -fork mode- for app name:api-app id:0
PM2        | App name:api-app id:0 online
0|api-app  | Server listen on *:3000
0|api-app  | Game server connected from: ::1

EDIT: SOLUTION FOUND
I’ve found the reason it was emiting the clean event from nodejs app. Once I changed:


socket.emit('nation-selected')

to


socket.emit('nation-selected', {})

It worked just fine! Thank you for pointing me into right direction, I will leave this for others that may have problem with that.

That’s great! That said it’s still a bug from the plugin side, looks like I don’t handle an empty message case on receive, I’ll add another type check in there in case the JsonValue you get is none and see if that will fix it.

Dannington · March 29, 2017, 1:49pm

Hi , I’ll get you something sometime! I’m running up against crazy deadlines for the next 2/3 weeks or so, our show’s going to air on the 18th.

getnamo · March 29, 2017, 4:21pm

No rush Dan, things always take time

Exciting stuff on the show, it would be awesome to see it action, maybe at the meetup?

getnamo · April 4, 2017, 6:40am

Update to 0.5.2
-Fixed boolean always returning false #35](https://github.com//socketio-client-ue4/issues/35)

From 0.5.1
-Fixed undefined as second emit parameter from server #36](https://github.com//socketio-client-ue4/issues/36)

From 0.5.0
-Fixes for disconnecting while communicating with an unreachable server #32](https://github.com//socketio-client-ue4/issues/32)
-Boost updated to 1.62
-Socket.io-cpp updated to latest master merge
-misc internal features for tracking and killing lambda threads

Grab the latest @ https://github.com//socketio-client-ue4/releases

newicz;687304:

…
socket.emit('nation-selected')
to
socket.emit('nation-selected', {})
It worked just fine! Thank you for pointing me into right direction, I will leave this for others that may have problem with that.

This is now fixed in 0.5.1 allowing you to leave the second parameter empty.

@Dannington @Avatarochnik and anyone else who has had disconnect crashes, try the latest version for 4.15 (0.5.2) and let me know if the crashes and hangs have gone away.

Dannington · April 5, 2017, 10:41am

Hi @.

My PC is currently in a box coming back from France, but i’ll test it as soon as I get back. Something I realised is that I nearly always do my builds as development builds rather than shipping so I can get access to the console, but for a presentation I did yesterday I made a shipping build and it was a lot less likely to crash (It did only once over the last 3 days on exit, whereas with a development build it would happen more often than not).

Thanks

anonymous_user_247e6be7 · April 22, 2017, 3:59am

Hi @.

On 4.15 and the most recent SocketIO, I’m also getting the bug where, when not using auto-connect, my packaged project crashes on loading a level.

edcolmar · April 26, 2017, 2:10am

Thanks for this @! I would like to use this within an Online Subsystem. Is it possible? Do you have any suggestions on how to implement the client in c++ at this (sub actor) level?

getnamo · April 29, 2017, 1:37am

Not too familiar with the online subsystem layout, do you have some code scaffold of what you want to do?

Noted, does it only happen in packaged projects? and do you have any logs you can PM me (found under Saved/Logs)?

edcolmar · April 29, 2017, 3:57am

[QUOTE=;701473]
Not too familiar with the online subsystem layout, do you have some code scaffold of what you want to do?

Yes, all of the online subsystems have the same interface.

There are no actors involved, so using the actor component isn’t going to work, right?

I started experimenting with it, but I haven’t been having much success so far.

getnamo · April 30, 2017, 1:43pm

I should be able to refactor the plugin to encapsulate the C++ functionality in a pure C++ class e.g. FSocketIOClient which can then be used as a rebase for the ActorComponent (keep a local shared ptr, and forward all calls). This would allow you to add it anywhere in C++ via raw ptrs e.g. new FSocketIOClient or shared ptrs e.g. MakeSharedPtr(new FSocketIOClient) and not break any ActorComponent functionality while keeping a common core.

I’ve added the enhancement suggestion as an issue to the repo: https://github.com//socketio-client-ue4/issues/43

anonymous_user_247e6be7 · April 30, 2017, 8:11pm

@ I did some more testing. As far as I can tell, yes, it only happens in packaged builds. Doesn’t matter if it’s packaged for shipping or development. Using Windows 64-bit build.

The situation is this: I load into a level just fine. Then I have seven blueprints with SocketIO components which all connect properly to my server. Everything is fine.

Then one of these seven blueprints emits a signal to the server, all of them disconnect from the server, and then I switch the level.

I’ll PM you the logs, but it doesn’t look like it’s too helpful. I’ve narrowed it down to the disconnecting step causing the crash in the packaged version. It works without hitch in the editor. Thanks!

edcolmar · May 2, 2017, 2:02am

I managed to get the base implementation working. I ripped all of your code out of the plugin to do it though, so it’s not really useful as a plugin anymore. I’ll post what I did one I get a bit more testing on it.

getnamo · May 2, 2017, 1:08pm

Try this branch instead (awaiting a few more tests before merging to master, but it seems solid): https://github.com//socketio-client-ue4/tree/fclass-refactor

It’s still a plugin and you can make a FSocketIONative wherever you like and use the same methods. E.g. the component spawns it on initialize component https://github.com//socketio-client-ue4/blob/fclass-refactor/Source/SocketIOClient/Private/SocketIOClientComponent.cpp#L25 but you can use your own life cycle. Instead of the multicast delegate system for connected/disconnected you just use raw lambdas as callbacks, these are set before I connect in the component to forward to the multicast delegates: https://github.com//socketio-client-ue4/blob/fclass-refactor/Source/SocketIOClient/Private/SocketIOClientComponent.cpp#L138

edcolmar · May 2, 2017, 10:55pm

I got connecting and emitting events to work. Yay!

I’m stuck on how to receive events.

In your c++ docs:
https://github.com//socketio-client-ue4
You have:

OnRawEvent(&](const FString& Name, const sio::message::ptr& Message)

This gives a compilation error:
no suitable user-defined conversion from “lambda ]void (const FString &Name, const sio::message::ptr &Message)->void” to “const FString” exists

Digging through the code, I see you use this instead:
OnRawEvent(EventName, &](const FString& Event, const sio::message::ptr& RawMessage)

I can’t get this to work either.

Can you show how to receive events in c++ in context? I feel like I’m doing it totally wrong.

getnamo · May 2, 2017, 11:50pm

Looks like I missed a key C++ documentation bit, bind events in c++ not using the raw format, thanks for catching this! Generally OnRawEvent should be avoided unless you want to use sio::message data types (these are not UE4 native).

I’ve now added the UE4 native section here: https://github.com//socketio-client-ue4/blob/master/README.md#receiving-events

Since we’re using the FSocketIONative the function is https://github.com//socketio-client-ue4/blob/fclass-refactor/Source/SocketIOClient/Public/FSocketIONative.h#L212

So the syntax for that should be:




//Smart pointer method
TSharedPtr<FSocketIONative> NativeClient; //assuming this is valid

or

//Raw pointer method
FSocketIONative* NativeClient; //assuming this is valid

...

NativeClient->OnEvent(FString("MyEvent"), ](const FString& Event, const TSharedPtr<FJsonValue>& Message)
	{
		//Called when the event is received
	}, FString("Optional Namespace"));

note that you’ll need to add variables you use in the lambda capture to

so that they are captured. E.g. if you call the above inside a member function


[this]

would normally be sufficient. See Lambda expressions (since C++11) - cppreference.com for reference on C++ lambdas.

edcolmar · May 3, 2017, 12:06am

You bet.

Thanks for the detailed explanation. I’ll report back with my findings, after I dig in.

edcolmar · May 3, 2017, 12:21am

OnNativeEvent(FString(“MyEvent”), ](const FString& Event, const TSharedPtr<FJsonValue>& Message)
{
//Called when the event is received
}, FString(“Optional Namespace”));

Thank you! This is working.

getnamo · May 7, 2017, 6:42pm

Update to 0.6.0
Changes:

API Changes:
-Rebased to accomodate #43](https://github.com//socketio-client-ue4/issues/43). You can now put FSocketIONative anywhere with your own allocation structure.
-‘On’ event dispatch changed to ‘OnEvent’.

Fixes:
-Candidate fixes for #41](https://github.com//socketio-client-ue4/issues/41), #32](https://github.com//socketio-client-ue4/issues/32), and #38](https://github.com//socketio-client-ue4/issues/38)
-Fixes to underlying library stopping re connection attempts when you close a connection: /socket.io-client-cpp@3f0cd99

You can find the latest release at https://github.com//socketio-client-ue4/releases

If you had crashes with 0.5.2 try 0.6.0 and let me know if that has resolved issues. You should be able to open maps in packaged games with components whether your server is up or not. The only potentially unhandled use case is when you open a map to a server that is up and you swap map after the server status changes (e.g. becomes unreachable/goes down). If you have this use case you can use the workaround of setting bAsyncQuitDisconnect to false in your components (https://github.com//socketio-client-ue4/blob/master/Source/SocketIOClient/Public/SocketIOClientComponent.h#L54) which will synchronize your disconnects. If you have a lot of components it will add about ~ 1sec per component delay.

edcolmar · May 7, 2017, 6:57pm

Reporting success with my experiments over here, so far.

Are socket.io “rooms” available to use in this implementation? If so, I’d love to see a quick c++ example on how to listen to one.

Thanks again ! =)