Semiconductor & Computer Engineering
From WikiChip
Difference between revisions of "mirc/on events/on sockopen"
m (bot: cat fixing naming) |
Yawhatnever (talk | contribs) (→Connection State - wording) |
||
| Line 11: | Line 11: | ||
== Connection State == | == Connection State == | ||
| − | + | Because the sockopen event triggers for failed connections as well, it's important to check the value of {{mIRC|$sockerr}} before continuing with any commands. Here is a list of the possible values returned $sockerr in the on SOCKOPEN event: | |
* '''0''' - Success. | * '''0''' - Success. | ||
| − | * '''3''' - Failure establishing socket connection | + | * '''3''' - Failure establishing socket connection: $sock($sockname).wsmsg will contain a more specific error message. |
* '''4''' - Error resolving given hostname. | * '''4''' - Error resolving given hostname. | ||
Revision as of 00:32, 16 October 2014
The ON SOCKOPEN event triggers when a TCP socket connection initiated with /sockopen is either sucessful or failed.
Synopsis
ON <level>:SOCKOPEN:<matchtext>:<commands>
Parameters
<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.
Connection State
Because the sockopen event triggers for failed connections as well, it's important to check the value of $sockerr before continuing with any commands. Here is a list of the possible values returned $sockerr in the on SOCKOPEN event:
- 0 - Success.
- 3 - Failure establishing socket connection: $sock($sockname).wsmsg will contain a more specific error message.
- 4 - Error resolving given hostname.
Examples
on *:sockopen:name:{ if (!$sockerr) echo -s Connection is sucessful! else { echo -s An error occured while trying to connect: $sock($sockname).wsmsg } }
Compatibility
Added: mIRC v3.5
Added on: 07 Aug 1995
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.