Latest revision as of 10:39, 18 February 2024

The ON SOCKLISTEN event triggers when a connection is made on a listening TCP socket created with /socklisten

Synopsis[edit]

ON <level>:SOCKLISTEN:<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.

Accepting a connection[edit]

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 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[edit]

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

Compatibility[edit]

Added: mIRC v5.3
Added on: 13 Dec 1997
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.

See Also[edit]

• mIRC events
• on sockopen
• on sockread
• on sockwrite
• on sockclose
• /sockwrite
• /sockclose
• /sockread
• /sockaccept
• /sockpause
• $sock
• $sockbr
• $sockerr