Modules/Sockets/onSockData: Difference between revisions
Jump to navigation
Jump to search
(Created page with '__NOTOC__ {{ModuleFunction|Sockets}} This event is triggered when data is received on a socket. ===Parameters=== * '''socket''' userdata representing a socket. * '''data''' a st…') |
m (→Example) |
||
(5 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
<pageclass class="#AA7592" subcaption="Sockets Module"></pageclass> | |||
__NOTOC__ | __NOTOC__ | ||
{{ModuleFunction|Sockets}} | {{ModuleFunction|Sockets}} | ||
Line 4: | Line 5: | ||
===Parameters=== | ===Parameters=== | ||
* '''socket''' userdata representing a socket. | <syntaxhighlight lang="lua"> | ||
* '''data''' a string with the data that was received. | userdata socket, string data | ||
</syntaxhighlight> | |||
* '''socket''': userdata representing a socket. | |||
* '''data''': a string with the data that was received. | |||
===Source=== | ===Source=== | ||
The source of this event is | The [[event system#Event source|source]] of this event is the [[root element]]. | ||
==Example== | ==Example== | ||
Line 14: | Line 19: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local root = getRootElement() | local root = getRootElement() | ||
local ircSocket = sockOpen("irc.gtanet.com", | local ircSocket = sockOpen("irc.gtanet.com",6667) | ||
addEventHandler("onSockOpened",root, | addEventHandler("onSockOpened",root, | ||
function (socket) | function (socket) | ||
if socket == ircSocket then | if socket == ircSocket then | ||
sockWrite(socket,"USER mta mta * MCvarial & Gamesnert") | sockWrite(socket,"USER mta mta * :MCvarial & Gamesnert\r\n") | ||
sockWrite(socket,"NICK mta") | sockWrite(socket,"NICK mta\r\n") | ||
sockWrite(socket,"JOIN #mta") | sockWrite(socket,"JOIN #mta\r\n") | ||
outputServerLog("IRC: Connected!") | outputServerLog("IRC: Connected!") | ||
Line 50: | Line 55: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See | ==See Also== | ||
===Functions=== | |||
{{Modules/Sockets/Functions}} | |||
===Events=== | |||
{{Modules/Sockets/Events}} |
Latest revision as of 17:28, 12 May 2010
This function is provided by the external module Sockets. You must install this module to use this function. | |
This event is triggered when data is received on a socket.
Parameters
userdata socket, string data
- socket: userdata representing a socket.
- data: a string with the data that was received.
Source
The source of this event is the root element.
Example
This piece of code connects to irc.gtanet.com, joins #mta and quits in 10 seconds.
local root = getRootElement() local ircSocket = sockOpen("irc.gtanet.com",6667) addEventHandler("onSockOpened",root, function (socket) if socket == ircSocket then sockWrite(socket,"USER mta mta * :MCvarial & Gamesnert\r\n") sockWrite(socket,"NICK mta\r\n") sockWrite(socket,"JOIN #mta\r\n") outputServerLog("IRC: Connected!") setTimer(disconnect,10000,1) end end ) addEventHandler("onSockData",root, function (socket,data) if socket == ircSocket then outputServerLog(data) end end ) addEventHandler("onSockClosed",root, function (socket) if socket == ircSocket then outputServerLog("IRC: disconnected!") end end ) function disconnect () sockClose(ircSocket) end