From WikiChip
Editing mirc/on events/on socklisten

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 Socklisten - Events}}
+
The '''ON SOCKLISTEN''' event triggers when a connection is made on a listening socket created with {{mIRC|/socklisten}}
The '''ON SOCKLISTEN''' event triggers when a connection is made on a listening {{mIRC|sockets#mIRC sockets|TCP socket}} created with {{mIRC|/socklisten}}
 
  
 
== Synopsis ==
 
== Synopsis ==
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.
  
 
== Accepting a connection ==
 
== Accepting a connection ==
  
'''Note''': By design, you cannot prevent a socket from being accepted, as in, Windows accepts the connection even before mIRC.
+
'''Note''': By design, you cannot prevent a socket from being accepted, as in, Windows accept the connection even before mIRC.
  
 
You can use /sockaccept <newsocket> to accept a socket, mIRC create the new socket.
 
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.
+
'''Note''': If a new connection occurs on a 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 successfuly 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 ==
 
== Examples ==
  
<source lang="mirc">
+
<source langu="mIRC">
 
on *:socklisten:name:{
 
on *:socklisten:name:{
  if (!$sockerr) sockaccept myprefix $+ $ticks
+
sockaccept myprefix $+ $ticks
  else {
 
    echo -s An error occured while trying to accept a connection: $sock($sockname).wsmsg
 
  }
 
 
}
 
}
 
</source>
 
</source>
  
 
== Compatibility ==
 
== Compatibility ==
{{mIRC compatibility|5.3}}
+
{{mIRC compatibility|3.5}}
  
 
== See Also ==
 
== See Also ==
* {{mIRC|on events|mIRC events}}
+
* [[List of on events - mIRC|mIRC Events]]
* {{mirc|on events/on sockopen|on sockopen}}
+
 
* {{mirc|on events/on sockread|on sockread}}
+
{{mIRC on event list}}
* {{mirc|on events/on sockwrite|on sockwrite}}
+
{{mIRC|/sockwrite}}
* {{mirc|on events/on sockclose|on sockclose}}
+
{{mIRC|/sockclose}}
* {{mIRC|/sockwrite}}
+
{{mIRC|/sockread}}
* {{mIRC|/sockclose}}
+
{{mIRC|/sockaccept}}
* {{mIRC|/sockread}}
+
{{mIRC|/sockpause}}
* {{mIRC|/sockaccept}}
+
{{mIRC|$sock}}
* {{mIRC|/sockpause}}
+
{{mIRC|$sockbr}}
* {{mIRC|$sock}}
+
{{mIRC|/sockerr}}
* {{mIRC|$sockbr}}
 
* {{mIRC|$sockerr}}
 
  
[[Category:mIRC on events|socklisten]]
+
[[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)