From WikiChip
Editing mirc/on events/on sockwrite
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
This page supports semantic in-text annotations (e.g. "[[Is specified as::World Heritage Site]]") to build structured and queryable content provided by Semantic MediaWiki. For a comprehensive description on how to use annotations or the #ask parser function, please have a look at the getting started, in-text annotation, or inline queries help pages.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
− | + | The '''ON SOCKWRITE''' event triggers when data has been sent on a {{mIRC|Sockets#mIRC Sockets|TCP socket}}. This event allows you to send more data without reaching the limit of the queue. | |
− | The '''ON SOCKWRITE''' event triggers when data has been sent on a socket | ||
== Synopsis == | == Synopsis == | ||
Line 6: | Line 5: | ||
== Parameters == | == Parameters == | ||
− | |||
− | |||
<span style="display: inline-block; width: 105px;">'''<matchtext>'''</span>The name of the socket you want event to trigger on. | <span style="display: inline-block; width: 105px;">'''<matchtext>'''</span>The name of the socket you want event to trigger on. | ||
<span style="display: inline-block; width: 105px;">'''<commands>'''</span>The commands to be performed when the event listener's criteria is met. | <span style="display: inline-block; width: 105px;">'''<commands>'''</span>The commands to be performed when the event listener's criteria is met. | ||
− | == | + | == Writting more == |
− | It is possible that the data hasn't | + | It is possible that the data hasn't sent successfuly, you should be checking for error with {{mIRC|$sockerr} before trying to do anything, here is a list of the possible value for $sockerr in the on SOCKWRITE event: |
− | * '''0''' - The data has been written | + | * '''0''' - The data has been written sucessfuly. |
− | * '''3''' - Error occurred while trying to send the data, $sock( | + | * '''3''' - Error occurred while trying to send the data, $sock().wsmsg will contain a more specific error message. |
== Examples == | == Examples == | ||
− | |||
− | |||
What if you are making a server and you want to close the socket of a client, but you want to warn that client that you are going to close the socket? | What if you are making a server and you want to close the socket of a client, but you want to warn that client that you are going to close the socket? | ||
Line 54: | Line 49: | ||
We are naturally not using a single line otherwise our limit would be of the line length limit of mIRC (4150 bytes). | We are naturally not using a single line otherwise our limit would be of the line length limit of mIRC (4150 bytes). | ||
− | The limit of the sending buffer being 16384, that's our maximum. A nice method is to write the content to be sent to a file and then to use {{mIRC|File handling}}. After {{mIRC | + | The limit of the sending buffer being 16384, that's our maximum. A nice method is to write the content to be sent to a file and then to use {{mIRC|File handling}}. After {{mIRC|/fopening}} the file, use {{mIRC|$fread}}(<name>,<N>,<&binvar>) which will fill <&binvar> with N bytes from the current pointer in the file, you can set N here to 16384 to get the fastest sending. |
<source lang="mirc"> | <source lang="mirc"> | ||
Line 62: | Line 57: | ||
;we check for the return value of $fread because if you get 0, the file is empty and there is nothing to send | ;we check for the return value of $fread because if you get 0, the file is empty and there is nothing to send | ||
if ($fread(handle,16384,&tosend) > 0) sockwrite socket &tosend | if ($fread(handle,16384,&tosend) > 0) sockwrite socket &tosend | ||
+ | on *:sockwrite:socket:{ | ||
+ | ;if we sent all of the previous content | ||
+ | if ($sock(socket).sq == 0) { | ||
+ | if ($fread(handle,16384,&tosend) > 0) sockwrite socket &tosend | ||
+ | } | ||
+ | } | ||
+ | </source> | ||
− | |||
− | on *: | + | |
− | + | <source lang="mirc"> | |
− | if ($ | + | on *:socklisten:name:{ |
− | + | if (!$sockerr) sockaccept myprefix $+ $ticks | |
− | + | else { | |
+ | echo -s An error occured while trying to accept a connection: $sock($sockname).wsmsg | ||
} | } | ||
} | } | ||
</source> | </source> | ||
− | |||
− | |||
== Compatibility == | == Compatibility == | ||
Line 80: | Line 80: | ||
== See Also == | == See Also == | ||
− | * | + | * {{mIRC|List of on events|mIRC events}} |
− | |||
− | |||
− | |||
− | |||
* {{mIRC|/sockwrite}} | * {{mIRC|/sockwrite}} | ||
* {{mIRC|/sockclose}} | * {{mIRC|/sockclose}} | ||
Line 93: | Line 89: | ||
* {{mIRC|$sockbr}} | * {{mIRC|$sockbr}} | ||
* {{mIRC|$sockerr}} | * {{mIRC|$sockerr}} | ||
− | |||
− | [[Category: | + | [[Category:MIRC on events]] |