Modules/Sockets/sockOpen: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Fixed broken reference)
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<pageclass class="#AA7592" subcaption="Sockets Module"></pageclass>
__NOTOC__
__NOTOC__
{{ModuleFunction|Sockets}}
{{ModuleFunction|Sockets}}
Line 5: Line 6:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
socket sockOpen ( string hostname, int port)
socket sockOpen ( string hostname, int port )
</syntaxhighlight>
</syntaxhighlight>
===Required arguments===
===Required arguments===
* '''hostname:''' The DNS or IP to connect to e.g. "www.google.com"
* '''hostname:''' The DNS or IP to connect to e.g. "www.google.com"
* '''port:''' The port to bind the socket to e.g. 80
* '''port:''' The port to bind the socket to e.g. 80
<!--* '''secure:''' A boolean specifying whether the connection should be secure (ssl)-->


===Returns===
===Returns===
Line 23: Line 25:
   function (socket)
   function (socket)
       if socket == ircSocket then
       if socket == ircSocket then
         sockWrite(socket,"USER mta mta * :MCvarial & Gamesnert")
         sockWrite(socket,"USER mta mta * :Bot\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 56: Line 58:
==See Also==
==See Also==
===Functions===
===Functions===
* [http://wiki.mtasa.com/wiki/Modules/Sockets/sockOpen sockOpen()]
{{Modules/Sockets/Functions}}
* [http://wiki.mtasa.com/wiki/Modules/Sockets/sockWrite sockWrite()]
* [http://wiki.mtasa.com/wiki/Modules/Sockets/sockClose sockClose()]


===Events===
===Events===
* [http://wiki.mtasa.com/wiki/Modules/Sockets/onSockOpened onSockOpened]
{{Modules/Sockets/Events}}
* [http://wiki.mtasa.com/wiki/Modules/Sockets/onSockData onSockData]
 
* [http://wiki.mtasa.com/wiki/Modules/Sockets/onSockClosed onSockClosed]
[[pl:Modules/Sockets/sockOpen]]
[[Category:Modules]]

Latest revision as of 17:45, 15 January 2022


Package-x-generic.png This function is provided by the external module Sockets. You must install this module to use this function.

This function creates a socket.

Syntax

socket sockOpen ( string hostname, int port )

Required arguments

  • hostname: The DNS or IP to connect to e.g. "www.google.com"
  • port: The port to bind the socket to e.g. 80

Returns

Returns userdata that represents the socket if you correct arguments were given, false otherwise.

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 * :Bot\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

See Also

Functions

Events