Class l2df.class.client

Last updated 2021-05-28 15:24:22

Network client class.

Inherited from l2df.Class.

Info:

Functions

Client:init([kwargs]) Client initialization.
Client:verify(event) Client verified event.
Client:connected(event) Client connected event.
Client:disconnected(event) Client disconnected event.
Client:received(event) Client received payload event.
Client:state() Get current client's connection state.
Client:isConnected() Check if client is connected.
Client:isRelayed() Check if client is connected via relay.
Client:islocal() Check if client is local.
Client:id(channel, endpoint) Generate "unique" client's id.
Client:ping() Get client's ping.
Client:disconnect(event) Disconnect client.
Client:send(event, ...) Send event previously registered with NetworkManager:event().
Client:rawsend(format, ...) Send raw-formatted message to client.


Functions

Methods
Client:init([kwargs])
Client initialization.

Parameters:

  • kwargs table Keyword arguments.
    • events table Array of encoded network events generated by NetworkManager:event(). (optional)
    • emap table Map to decode network events' ids. Internal use. (optional)
    • emitter function Function which accepts 3 arguments: event name, client instance, event data table. (optional)
Client:verify(event)
Client verified event.

Parameters:

  • event table Event data table.

Returns:

    l2df.class.client
Client:connected(event)
Client connected event.

Parameters:

  • event table Event data table.

Returns:

    l2df.class.client
Client:disconnected(event)
Client disconnected event.

Parameters:

  • event table Event data table.
Client:received(event)
Client received payload event. Returns false if there're no known event for provided data and true otherwise.

Parameters:

  • event table Event data table.

Returns:

    boolean
Client:state()
Get current client's connection state.

Returns:

    boolean
Client:isConnected()
Check if client is connected.

Returns:

    boolean
Client:isRelayed()
Check if client is connected via relay.

Returns:

    boolean
Client:islocal()
Check if client is local.

Returns:

    boolean
Client:id(channel, endpoint)
Generate "unique" client's id.

Parameters:

  • channel number Channel of the communication. Internal use.
  • endpoint string Client's peer endpoint to use for generation.

Returns:

    string
Client:ping()
Get client's ping.

Returns:

    number
Client:disconnect(event)
Disconnect client. Fires 'disconnected' event with provided event's data.

Parameters:

  • event table Event data table.
Client:send(event, ...)
Send event previously registered with NetworkManager:event().

Parameters:

  • event string Event name.
  • ... Arguments for event's format string.

Returns:

    boolean
Client:rawsend(format, ...)
Send raw-formatted message to client.

Parameters:

  • format string Message format string.
  • ... Arguments for format string.

Returns:

    boolean