Editing mirc/on events/on socklisten

{{mirc title|On Socklisten - Events}}
The '''ON SOCKLISTEN''' event triggers when a connection is made on a listening {{mIRC|sockets#mIRC sockets|TCP socket}} created with {{mIRC|/socklisten}}

== Synopsis ==
<pre>ON <level>:SOCKLISTEN:<matchtext>:<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 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.

== Accepting a connection ==

'''Note''': By design, you cannot prevent a socket from being accepted, as in, Windows accepts the connection even before mIRC.

You can use /sockaccept <newsocket> to accept a socket, mIRC create the new socket.

'''Note''': If a new connection occurs on a listening socket but there is no on socklisten event matching that socket, the connection is rejected.

You should be checking for $sockerr before accepting the connection to see if an error occured, here is a list of the possible value for $sockerr in the on SOCKLISTEN event:

* '''0''' - New socket successfully accepted.
* '''1''' - Error occurred on listening socket, $sock().wsmsg will contain a more specific error message. Note that getting this error is considered rare.
* '''2''' - Error accepting new socket, $sock().wsmsg will contain a more specific error message.
* '''4''' - Not enough memory for new socket. Note that getting this error is considered rare.

== Examples ==

<source lang="mirc">
on *:socklisten:name:{
  if (!$sockerr) sockaccept myprefix $+ $ticks
  else {
    echo -s An error occured while trying to accept a connection: $sock($sockname).wsmsg
  }
}
</source>

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

== See Also ==
* {{mIRC|on events|mIRC events}}
* {{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 sockclose|on sockclose}}
* {{mIRC|/sockwrite}}
* {{mIRC|/sockclose}}
* {{mIRC|/sockread}}
* {{mIRC|/sockaccept}}
* {{mIRC|/sockpause}}
* {{mIRC|$sock}}
* {{mIRC|$sockbr}}
* {{mIRC|$sockerr}}

[[Category:mIRC on events|socklisten]]