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:
−
{{mirc title|On Sockwrite - Events}}
 
 
The '''ON SOCKWRITE''' event triggers when data has been sent on a socket, even on a UDP 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, even on a UDP socket. This event allows you to send more data without reaching the limit of the queue.
  
Line 6: Line 5:
  
 
== Parameters ==
 
== Parameters ==
−
<span style="display: inline-block; width: 105px;"> '''<level>'''</span>The corresponding {{mIRC|access levels}} for the event to trigger.
 
−
 
 
<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.
  
−
== Writing more ==
+
== Writting more ==
  
−
It is possible that the data hasn't been sent successfuly, especially with UDP, 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:
+
It is possible that the data hasn't sent successfuly, especially with UDP, 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 successfuly.
+
* '''0''' - The data has been written sucessfuly.
−
* '''3''' - Error occurred while trying to send the data, $sock($sockname).wsmsg will contain a more specific error message.
+
* '''3''' - Error occurred while trying to send the data, $sock().wsmsg will contain a more specific error message.
  
 
== Examples ==
 
== Examples ==
−
 
−
'''Note''': Those example are not checking for {{mIRC|$sockerr}} to focus on their real purpose
 
  
 
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|/fopen|/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.
+
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 66: Line 61:
  
 
on *:sockwrite:socket:{
 
on *:sockwrite:socket:{
−
  ;if we sent all of the previous content
+
;if we sent all of the previous content
−
  if ($sock(socket).sq == 0) {
+
if ($sock(socket).sq == 0) {
−
    if ($fread(handle,16384,&tosend) > 0) sockwrite socket &tosend
+
if ($fread(handle,16384,&tosend) > 0) sockwrite socket &tosend
−
    else ;we're done sending the content
+
else ;we're done sending the content
−
  }
+
}
 
}
 
}
 
</source>
 
</source>
−
 
−
Note that this is how you should theorically handle the sending of an unknown length of data. However, if the sending buffer is empty, you can send more than 16384 bytes (as long as you can set the binary variable holding more than that) using a binary variable. mIRC will correctly cut that in chunk of 16384 bytes or less. This then only becomes a problem if you are willing to queue more without waiting for it to be sent (which could take some times, you would end up with an error because the sending buffer is full, and you would need the above event)
 
  
 
== Compatibility ==
 
== Compatibility ==
Line 80: Line 73:
  
 
== See Also ==
 
== See Also ==
−
* [[mirc/on events|List of on events]]
+
* {{mIRC|List of on events|mIRC events}}
−
* {{mirc|on events/on sockopen|on sockopen}}
 
−
* {{mirc|on events/on sockread|on sockread}}
 
−
* {{mirc|on events/on socklisten|on socklisten}}
 
−
* {{mirc|on events/on sockclose|on sockclose}}
 
 
* {{mIRC|/sockwrite}}
 
* {{mIRC|/sockwrite}}
 
* {{mIRC|/sockclose}}
 
* {{mIRC|/sockclose}}
Line 93: Line 82:
 
* {{mIRC|$sockbr}}
 
* {{mIRC|$sockbr}}
 
* {{mIRC|$sockerr}}
 
* {{mIRC|$sockerr}}
−
* {{mIRC|$sockname}}
 
  
−
[[Category:mIRC on events|sockwrite]]
+
[[Category:MIRC on events]]

Please note that all contributions to WikiChip may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see WikiChip:Copyrights for details). Do not submit copyrighted work without permission!

Cancel | Editing help (opens in new window)

Templates used on this page:

Retrieved from "https://en.wikichip.org/wiki/mirc/on_events/on_sockwrite"