Semiconductor & Computer Engineering
m (→Parameters: Link access levels) |
|||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{mirc title|On Udpread - Events}}The '''ON UDPREAD''' triggers when there is info waiting to be read on the specified UDP socket connection. You can read this info using the {{mIRC|/sockread}} command. |
| − | The '''ON UDPREAD''' triggers when there is info waiting to be read on the specified UDP socket connection. You can read this info using the {{mIRC|/sockread}} command. | ||
To be able to use this event, you need to get the udp socket to stay opened (by default it is closed after each {{mIRC|/sockudp}} command) by using the -k switch of /sockudp. | To be able to use this event, you need to get the udp socket to stay opened (by default it is closed after each {{mIRC|/sockudp}} command) by using the -k switch of /sockudp. | ||
| − | '''Note''' | + | '''Note:''' If this event triggers but no /sockread is performed to attempt to read the buffer, it is assumed that no script exists that is handling this buffer, so it is cleared and the info it contained is lost. |
mIRC in general only understand $crlf terminated line. With socket, mIRC will stop at {{mIRC|$lf}} terminated line and any {{mIRC|$cr}} before a $lf is removed. | mIRC in general only understand $crlf terminated line. With socket, mIRC will stop at {{mIRC|$lf}} terminated line and any {{mIRC|$cr}} before a $lf is removed. | ||
| − | '''Note''' | + | '''Note:''' A single /sockread may not be enough to read the entire buffer. You should keep reading until {{mIRC|$sockbr}} is set to zero. This is far faster than letting mIRC re-trigger the event. If your script does not read the whole buffer, the on udpread event is re-triggered if: |
| − | + | # you were reading into a &binvar. | |
| − | + | # you were reading into a %var and there is still a terminated line in the buffer waiting to be read. | |
You can find an example showing how to do that {{mIRC|/sockread#Example|here}} | You can find an example showing how to do that {{mIRC|/sockread#Example|here}} | ||
| Line 19: | Line 18: | ||
== 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. | ||
| Line 56: | Line 57: | ||
* {{mIRC|$sockerr}} | * {{mIRC|$sockerr}} | ||
| − | [[Category:mIRC on events| | + | [[Category:mIRC on events|udpread]] |
Latest revision as of 07:15, 6 February 2024
The ON UDPREAD triggers when there is info waiting to be read on the specified UDP socket connection. You can read this info using the /sockread command.
To be able to use this event, you need to get the udp socket to stay opened (by default it is closed after each /sockudp command) by using the -k switch of /sockudp.
Note: If this event triggers but no /sockread is performed to attempt to read the buffer, it is assumed that no script exists that is handling this buffer, so it is cleared and the info it contained is lost.
mIRC in general only understand $crlf terminated line. With socket, mIRC will stop at $lf terminated line and any $cr before a $lf is removed.
Note: A single /sockread may not be enough to read the entire buffer. You should keep reading until $sockbr is set to zero. This is far faster than letting mIRC re-trigger the event. If your script does not read the whole buffer, the on udpread event is re-triggered if:
- you were reading into a &binvar.
- you were reading into a %var and there is still a terminated line in the buffer waiting to be read.
You can find an example showing how to do that here
Synopsis[edit]
ON <level>:UDPREAD:<matchtext>:<commands>
Parameters[edit]
<level>The corresponding access levels for the event to trigger.
<matchtext>The name of the socket you want event to trigger on.
<commands>The commands to be performed when the event listener's criteria is met.
Connection State[edit]
You should be checking for error with $sockerr before reading data, here is a list of the possible value for $sockerr in the on UDPREAD event:
- 0 - Data received correctly.
- 3 - Error on connected socket occurred, $sock().wsmsg will contain a more specific error message.
Examples[edit]
on *:udpread:name:{ if ($sockerr) { echo -s An error occured while trying to read data: $sock($sockname).wsmsg | return } else { sockread %a echo -s rcvd: %a } }
Compatibility[edit]
Added: mIRC v5.5
Added on: 08 Jan 1999
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.