Editing mirc/on events/on sockclose

{{mirc title|On Sockclose - Events}}
The '''ON SOCKCLOSE''' event triggers when a {{mIRC|Sockets#mIRC Sockets|TCP socket}} connection is closed by the remote host.

== Synopsis ==
<pre>ON <level>:SOCKCLOSE:<name>:<commands></pre>

== 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 target socket. Can be a {{mirc|wildcard}}.

<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:

* '''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 (most likely SSL cert cypher incompatibility), $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. If you get this you most likely are trying to initiate an SSL socket connection without SSL capabilities (check {mIRC|$sslready}}, which is $false if you don't have them)

== Example ==
When the socket closes, echo that the socket has closed and some details about it to the active window:
<source lang="mIRC">ON *:SOCKCLOSE:*: {
  if (!$sockerr) echo -ag ::=> $sockname Connection to $sock($sockname).ip on port $sock($sockname).port closed by the remote host!
  else echo -ag ::=> An error occured with the socket $sock($sockname).wsmsg
}</source>

== Compatibility ==
{{mIRC compatibility|5.3}}

== See Also ==
* {{mirc|on events/on sockopen|on sockopen}}
* {{mirc|on events/on sockread|on sockread}}
* {{mirc|on events/on sockwrite|on sockwrite}}
* {{mirc|on events/on socklisten|on socklisten}}
* {{mIRC|/sockaccept}}
* {{mIRC|/socklist}}
* {{mIRC|/sockmark}}
* {{mIRC|/sockopen}}
* {{mIRC|/sockpause}}
* {{mIRC|/sockread}}
* {{mIRC|/sockrename}}
* {{mIRC|/sockudp}}
* {{mIRC|/sockwrite}}
* {{mIRC|$sock}}
{{mIRC on event list}}

[[Category:mIRC on events|sockclose]]