Difference between revisions of "enet.host create"

(Created page with "Returns a new host. All arguments are optional. A bind_address of nil makes a host that can not be connected to (typically a client). Otherwi...")
 
m
Line 16: Line 16:
 
{{param|number|out_bandwidth|Upstream bandwidth in bytes/sec. Defaults to 0 (unlimited).}}
 
{{param|number|out_bandwidth|Upstream bandwidth in bytes/sec. Defaults to 0 (unlimited).}}
 
=== Returns ===
 
=== Returns ===
{{param|[[enet.host]]|host|The requested [[enet.host | host]].}}
+
{{param|enet.host|host|The requested [[enet.host | host]].}}
  
 
== See Also ==
 
== See Also ==

Revision as of 18:22, 9 October 2014

Returns a new host. All arguments are optional.

A bind_address of nil makes a host that can not be connected to (typically a client). Otherwise the address can either be of the form <ipaddress>:<port>, <hostname>:<port>, or *:<port>.

Example addresses include "127.0.0.1:8888", "localhost:2232", and "*:6767".

Function

Synopsis

host = host_create(bind_address, peer_count, channel_count, in_bandwidth, out_bandwidth)

Arguments

string bind_address
The address to connect to in the format "ip:port".
number peer_count
The max number of peers. Defaults to 64.
number in_bandwidth
Downstream bandwidth in bytes/sec. Defaults to 0 (unlimited).
number channel_count
The max number of channels. Defaults to 1.
number out_bandwidth
Upstream bandwidth in bytes/sec. Defaults to 0 (unlimited).

Returns

enet.host host
The requested host.

See Also

Other Languages