Difference between revisions of "ClientObject:connect"

m
 
Line 8: Line 8:
 
{{param|string|host|The host to connect to.}}
 
{{param|string|host|The host to connect to.}}
 
{{param|number|port|The port to connect to on the host.}}
 
{{param|number|port|The port to connect to on the host.}}
{{param|string|dns|Specifies if the host is a name or an IP (If its a hostname, Then do a DNS lookup).}}
+
{{param|string|dns|Specifies if the host is a name or an IP (If its a hostname, Then do a DNS lookup). Default is IP.}}
 
=== Returns ===
 
=== Returns ===
Nothing.
+
Assertion upon failure, or true upon success.
 +
self.host becomes the host name.
 +
self.port becomes the port name.
 +
self.connected becomes a boolean set to true.
 
== See Also ==
 
== See Also ==
 
* [[parent::ClientObject]]
 
* [[parent::ClientObject]]

Latest revision as of 02:31, 16 March 2013

Connect to a server.

Function

Synopsis

clientobject:connect(host, port, dns)

Arguments

string host
The host to connect to.
number port
The port to connect to on the host.
string dns
Specifies if the host is a name or an IP (If its a hostname, Then do a DNS lookup). Default is IP.

Returns

Assertion upon failure, or true upon success. self.host becomes the host name. self.port becomes the port name. self.connected becomes a boolean set to true.

See Also

Other Languages