Autoit-Socket-IO - Networking in AutoIt made simple!

[autoitter]

Nice job, thanks! Very useful in a project I did recently.

One note: in function __Io_Init() which itself is called by _Io_Listen() the the TCP timeout is set to 5 msec. This is somewhat short, even on a busy LAN. My application sometimes would return a error when calling _Io_Listen() at startup (with @extended set to 10060). Raising this value fixed the problem.

Just in case someone runs into the same problem.

[tarretarretarre]

On 2018-02-03 at 6:54 PM, autoitter said:

Nice job, thanks! Very useful in a project I did recently.

One note: in function __Io_Init() which itself is called by _Io_Listen() the the TCP timeout is set to 5 msec. This is somewhat short, even on a busy LAN. My application sometimes would return a error when calling _Io_Listen() at startup (with @extended set to 10060). Raising this value fixed the problem.

Just in case someone runs into the same problem.

Hi and thanks for the input.

The reason is behind why the TCPTimeout is set to 10 is because

Quote

TCPSend speed is about 200 to 650ms, while v3.3.8.1 is about 28 to 90ms. The higher the string is in size, the more exponential the time becomes. This leads to an unresponsive GUI.

Quote

I found the solution to the slow problem and was right about the 100ms timer.
Starting with v3.3.10.0, you must use Opt('TCPTimeout', 10) in your script
to behave like v3.3.8.1.

The quote is from https://www.autoitscript.com/trac/autoit/ticket/3575

So which @AutoitVersion do you use with this UDF? Im considering making a patch for this

 

/Tarre

[autoitter]

I"m using AutoIt version 3.3.14.2

 

[timmalos]

I don't manage to make it working with a Socket.IO server using NodeJs and an AutoIt Client using this library.

Do I make something wrong ?

AutoIt Client : 

expandcollapse popup

#AutoIt3Wrapper_Change2CUI=Y
#include "..\socketIO.au3"

; Connect to server
_Io_DevDebug(True)
Global $socket = _Io_Connect(@IPAddress1, 8082, True)

If Not @error Then
    ConsoleWrite("Successfully connected to server" & @CRLF)
Else
    ConsoleWrite("Failed to open socket:" & @error & @CRLF)
    Exit
EndIf

; -------------
;   All events are registered here
; -------------

_Io_on("message", callback_serverHasGreetedUs)
_Io_on("disconnect", callback_WeDisconnectedFromServer)

; Start main loop
While _Io_Loop($socket)
    ;_Io_Emit($socket, "message", "Hello from client!")
    Sleep(500)
WEnd

; -------------
;   All event callbacks are defined here
; -------------

Func callback_serverHasGreetedUs(ByRef $socket, $message)
    MsgBox(0, "The Client", "Message received from server: " & $message & @CRLF & "Press OK to send something back to the server")
    _Io_Emit($socket, "message from client", "Hello from client!")
EndFunc   ;==>callback_serverHasGreetedUs

Func callback_WeDisconnectedFromServer($socket)
    MsgBox(0, "The Client", "Lost connection to server... Aborting!")
    Exit
EndFunc   ;==>callback_WeDisconnectedFromServer

Node.Js server : 

var io = require('socket.io')(8082);
// Quand un client se connecte, on le note dans la console
io.sockets.on('connection', function (socket) {
    socket.emit('message', 'You are connected!');

    console.log('Someone connected !');
});

 

I connect successfully, disconnect succesfully but unable to retrieve any message from client to server or server to client.

[tarretarretarre]

Hi @timmalos.

Sorry to burst your bubble, but I just ported the actual concept of SocketIo, they cannot talk to each other (yet).

 

As a consolation you could try this: 

 

But instead of injecting jQuery, you could inject https://cdnjs.com/libraries/socket.io in an hidden page. I cannot guarantee that this will even work, but its worth a shot if you want your autoit-app to talk to a node.js server.

Good luck!

[timmalos]

That's what I was afraid of. Wasn't able to really look inide the _IO funcitons but I was hoping since it exists multiple Socket IO clients on other languages than JS. Thanks anyway for your answer.

[tarretarretarre]

I have updated the UDF to 2.0.0

 

Version 2.0.0 (This update break scripts. Please consult the upgrade.md for guidance)

• All global internal variables has been renamed.
• Added a bunch of new API methods: _Io_RegisterMiddleware, _Io_whoAmI, _Io_IsClient, _Io_IsServer, _Io_getAllByProperty and _Io_getFirstByProperty and some more. Read more about these in the documentation.
• _Io_socketGetProperty now has a setter method called _Io_socketSetProperty which can be used to set custom properties.
• _Io_socketGetProperty now has a third parameter "default" which is used when a property is not found
• Removed _Io_setEventPostScript and _Io_setEventPretScript in favor of _Io_RegisterMiddleware
• Improved documentation (It still needs some love though)
• Improved the verbosity of _Io_DevDebug

[mLipok]

added here:

https://www.autoitscript.com/wiki/User_Defined_Functions#Inter_Process_Communications

[tarretarretarre]

Hi all, almost a year later

 

 

Version 3.0.0 (This update break scripts. Please consult the upgrade.md for guidance)

• Now supports serialization Scripting Dictionaries
• Added UnitTester UDF to the mix
• This is the last version of the current code base.

Version 3.0.0 is not gonna live long though, because I already have a 4.0 version coming up soon with major changes and improvements.

[tarretarretarre]

Version 4.0.0-beta (This update break scripts.)

• Code base fully rewritten with Autoit-Events and decoupled to improve code quality and reduce bloat.
• The new UDF is very different from 3.x.x so please checkout the UPGRADE guide to fully understand all changes
• Added new documentation documentaion

[Trong]

Thank you for the update!
I wait, test and seek high speed data transfer function!

[x_bennY]

very well written code @tarretarretarre

does it now supports socket.io with node.js?

[carloselectro]

Hi,

I want to use autoit socketIO to send data to my python server, but I am struggling to unserialize the received data.

Is there any way to not serialize it or make it compatible with Python?

My python thread:

https://python-forum.io/Thread-Cannot-unpickle-tcp-data-unpickling-stack-underflow

Any help will be greatly appreciated.

[tarretarretarre]

Hi,

As I replied in your DM.

AutoIT SocketIo is built for autoit 2 autoit communication exclusivly. You would need to rebuild my whole UDF  and its deserialization dependencies to achieve the same outcome.

However "AutoiT-API-WS" is more suitable for your needs.

You could transfer data between your autoit app and Python app with a few lines of code

And if you want to use the "Observer design pattern",  you could API-WS in conjunction with AutoIt-Events :

 

 

 

[tarretarretarre]

On 11/4/2020 at 2:07 AM, x_bennY said:

very well written code @tarretarretarre

does it now supports socket.io with node.js?

Yes, or at least kindof.

My next project is going to be straight up WebSockets in AutoIt. That means you could establish connections between any language that support WebSockets, Socket Io has support for websockets, so it would be possible to make a straight port of the real Socket IO

But, I am working 150% with so many projects, so I dont know when I will have the time

 

Edited November 30, 2020 by tarretarretarre
CTRL + ENTER is apperently a thing

[pablocapi13]

Hi @tarretarretarre! I wish you could give me some insight on what I'm doing wrong here. I'm using your library to manage communication between two scripts via Lan and It's working flawlessly. My only issue is while testing for reconnection. After I reset my server script, I handle the event and reconnect, but my custom events are lost for the new socket.

How should I approach this scenario.

I registered my server .exe as a service so Windows re-launches it automatically, my client is able to reconnect but the events fail to be fired with "NOT_FOUND"

 

Regards!

 

JP

[tarretarretarre]

On 1/18/2021 at 7:20 PM, pablocapi13 said:

Hi @tarretarretarre! I wish you could give me some insight on what I'm doing wrong here. I'm using your library to manage communication between two scripts via Lan and It's working flawlessly. My only issue is while testing for reconnection. After I reset my server script, I handle the event and reconnect, but my custom events are lost for the new socket.

How should I approach this scenario.

I registered my server .exe as a service so Windows re-launches it automatically, my client is able to reconnect but the events fail to be fired with "NOT_FOUND"

 

Regards!

 

JP

Hi,

 

Yes I have stumbled upon that as well. V4 is still beta and I will eventually get it patched, meanwhile, try to wrap all your _Io_On events in an function, and run that function after your reconnect attempt, that should solve your "NOT_FOUND" errors

Something like this

func RegisterEvents()
    _Io_On('SomethingHappend')
EndFunc

_Io_Connect()
 RegisterEvents()
 
 
 func ReconnectAttempt()
     _Io_Connect()
     RegisterEvents()
 EndFunc

 

Edited February 15, 2021 by tarretarretarre

[Marius462]

Hi tarretarretarre,

you can make a example "private message" in version 4?

here my function for select User|IP

Func _sendPM(); my function for select User|IP
    Local $iEdit = _GUICtrlListView_GetSelectionMark($UserList)
    Local $bItem = _GUICtrlListView_GetItemTextString($UserList, $iEdit)
    Local $aItem = _GUICtrlListView_GetItemTextArray($UserList, $iEdit)
    If $iEdit > -1 Then
        Local $aItem = _GUICtrlListView_GetItemTextArray($UserList, $iEdit)
        Local $user = $aItem[1]
        Local $userip = $aItem[2]
    EndIf
    ; Send message
    ;_Io_Emit($socket, "private message", $to_ip, $pm)
EndFunc

 

[Rurorita]

On 3/22/2021 at 6:45 PM, Marius462 said:

Hi tarretarretarre,

you can make a example "private message" in version 4?

here my function for select User|IP

Func _sendPM(); my function for select User|IP
    Local $iEdit = _GUICtrlListView_GetSelectionMark($UserList)
    Local $bItem = _GUICtrlListView_GetItemTextString($UserList, $iEdit)
    Local $aItem = _GUICtrlListView_GetItemTextArray($UserList, $iEdit)
    If $iEdit > -1 Then
        Local $aItem = _GUICtrlListView_GetItemTextArray($UserList, $iEdit)
        Local $user = $aItem[1]
        Local $userip = $aItem[2]
    EndIf
    ; Send message
    ;_Io_Emit($socket, "private message", $to_ip, $pm)
EndFunc

 

You could easiely

_Io_Emit($socket, "privatemessage", $to_ip & '|' & $pm)

and on the receiving func simply

Func _On_privatemessage(Const $socket, $data)

Local $arData = StringSplit($data, '|', 1)

; $arData[1] will hold the ip

; $arData[2] will hold the pm

Endfunc

 

[Rurorita]

Hi @tarretarretarre,

i heaviely modified your SoketIO.au3 3.0.0 and also wrote a small framework around it.

I removed the serilization UDF completly and added alot of safety and convenience features. Idk if you care for 3.0.0 anymore as you work on 4.0.0.

However the Client can now Guess how much load is on the Server, this work vise versa. I call it Flood Prevention. It ensures that no packets get discarded because of $g__io_nMaxPacketSize

Then i added packet validation. The packets now also get verified and discarded if corrupted. The next feature is a Safety feature where bad packets get resend. There are more little feature as for example a counter per socket for how much bytes got send and received.. etc.

All of it can be toggled and if used with the framework both side even sync their configurations.

Even tho i didnt optimise nor polished what i coded yet, i still think that it got much faster and safer.

In this picture i have 10 Clients sending constantly packets of 2048 KB
The server handling them so nice that each client can send up to 2 packets per second

Spoiler

 

I try to make it much faster with certain other technics or by recoding more sections. As the Issue is less with the packet size but with the packet and socket count.