Class l2df.manager.network
Network manager
Info:
- Copyright: Atom-TM 2020
- Author: Abelidze
Functions
| Manager:init(kwargs) | Configure l2df.manager.network |
| Manager:initSocket() | Init socket-communication stuff. |
| Manager:isReady() | Determine if manager is ready to setup connetions |
| Manager:isConnected() | Determine if any client is connected |
| Manager:register(host) | Register new master server |
| Manager:destroy() | Dispose all connections |
| Manager:login([username]) | Login to all registered masters and discover your public IP |
| Manager:logout() | Disconnects from all registered masters |
| Manager:join(lobby) | Send search request to master |
| Manager:host() | Create new lobby |
| Manager:list([count[, refresh]]) | |
| Manager:event(name, format, callback) | Register new network event |
| Manager:broadcast(event) | Broadcast event to all connected clients |
| Manager:addClient(id, name, kwargs) | Manually add local client |
| Manager:clients([id]) | Returns an iterator on connected clients |
| Manager:update(dt) | Manager's update |
Functions
Methods- Manager:init(kwargs)
-
Configure l2df.manager.network
Parameters:
-
kwargs
table
- username string
- relay_wait_time number (default 1)
- relay_max_count number (default 10)
- relay_client_attempts number (default 5)
- relay_master_attempts number (default 8)
- min_peer_timeout number (default 2000)
- max_peer_timeout number (default 4000)
Returns:
-
kwargs
table
- Manager:initSocket()
-
Init socket-communication stuff. Called internally and usually should not be used explicitly
Returns:
- Manager:isReady()
-
Determine if manager is ready to setup connetions
Returns:
-
boolean
- Manager:isConnected()
-
Determine if any client is connected
Returns:
-
boolean
- Manager:register(host)
-
Register new master server
Parameters:
- host string
Returns:
- Manager:destroy()
-
Dispose all connections
Returns:
- Manager:login([username])
-
Login to all registered masters and discover your public IP
Parameters:
- username string (optional)
Returns:
- Manager:logout()
-
Disconnects from all registered masters
Returns:
- Manager:join(lobby)
-
Send search request to master
Parameters:
- lobby string ID of lobby to join
Returns:
-
boolean
- Manager:host()
-
Create new lobby
Returns:
-
boolean
- Manager:list([count[, refresh]])
-
Parameters:
- count number (optional)
- refresh boolean (optional)
Returns:
-
function
- Manager:event(name, format, callback)
-
Register new network event
Parameters:
- Manager:broadcast(event)
-
Broadcast event to all connected clients
Parameters:
- event string
Returns:
-
boolean
- Manager:addClient(id, name, kwargs)
-
Manually add local client
Parameters:
Returns:
- Manager:clients([id])
-
Returns an iterator on connected clients
Parameters:
- id string (optional)
Returns:
-
function
- Manager:update(dt)
-
Manager's update
Parameters:
- dt number