Semiconductor & Computer Engineering
From WikiChip
Editing mirc/on events/on sockclose
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 SOCKCLOSE''' event triggers when a {{mIRC|Sockets#mIRC Sockets|TCP socket}} connection is closed by the remote host. | The '''ON SOCKCLOSE''' event triggers when a {{mIRC|Sockets#mIRC Sockets|TCP socket}} connection is closed by the remote host. | ||
| Line 6: | Line 5: | ||
== Parameters == | == Parameters == | ||
| − | <span style="display: inline-block; width: 105px;">'''<level>'''</span>The | + | <span style="display: inline-block; width: 105px;">'''<level>'''</span>The level for the event to trigger. |
| − | <span style="display: inline-block; width: 105px;">'''<matchtext>'''</span>The name of the target socket. Can be a | + | <span style="display: inline-block; width: 105px;">'''<matchtext>'''</span>The name of the target socket. Can be a [[wildcard]]. |
<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. | ||
| − | + | The reason a socket is closed could be because of an error, you can check {{mIRC|$sockerr}}, here is a list of the possible value for $sockerr inside the on sockclose event: | |
| − | |||
| − | The reason a socket is closed could be because of an error | ||
* '''0''' - EOF from the remote host received, this actually means the remote host closed your connection successfuly. | * '''0''' - EOF from the remote host received, this actually means the remote host closed your connection successfuly. | ||
| − | * '''3''' - An error occurred while receiving data, or a SSL error occurred | + | * '''3''' - An error occurred while receiving data, or a SSL error occurred, $sock().wsmsg will contain a more specific error message. |
| − | * '''5''' - An SSL error of some kind occurred when trying to initialize the connection. Unlikely to happen. | + | * '''5''' - An SSL error of some kind occurred when trying to initialize the connection. Unlikely to happen. |
== Example == | == Example == | ||
When the socket closes, echo that the socket has closed and some details about it to the active window: | When the socket closes, echo that the socket has closed and some details about it to the active window: | ||
<source lang="mIRC">ON *:SOCKCLOSE:*: { | <source lang="mIRC">ON *:SOCKCLOSE:*: { | ||
| − | + | echo -a ::=> $sockname Connection to $sock($sockname).ip on port $sock($sockname).port closed by the remote host! | |
| − | |||
}</source> | }</source> | ||
== Compatibility == | == Compatibility == | ||
| − | {{mIRC compatibility| | + | {{mIRC compatibility|6.14}} |
== See Also == | == See Also == | ||
| − | * | + | * [[Sockets - mIRC|Sockets]] |
| − | * | + | * [[On socklisten - mIRC|ON SOCKLISTEN]] |
| − | * | + | * [[On sockopen - mIRC|ON SOCKOPEN]] |
| − | + | * [[On sockread - mIRC|ON SOCKREAD]] | |
| + | * [[On sockwrite - mIRC|ON SOCKWRITE]] | ||
* {{mIRC|/sockaccept}} | * {{mIRC|/sockaccept}} | ||
* {{mIRC|/socklist}} | * {{mIRC|/socklist}} | ||
| Line 47: | Line 44: | ||
{{mIRC on event list}} | {{mIRC on event list}} | ||
| − | [[Category: | + | [[Category:MIRC on events]] |