Modules/Sockets/sockClose

From Multi Theft Auto: Wiki
Revision as of 14:34, 25 April 2010 by Gamesnert (talk | contribs)


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

This function destroys a socket.

Syntax

bool sockClose ( socket theSocket )

Required arguments

  • theSocket: The socket to close

Returns

Returns a boolean true if the socket was closed, 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 * :MCvarial & Gamesnert")
         sockWrite(socket,"NICK mta")
         sockWrite(socket,"JOIN #mta")

         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