MigratoryDataAccessListener::DisconnectEvent

Provide information about the client which disconnects from the server.

Inherits from Event

Public Functions

Name
String getClientAddress()
Provides the IP address of the client.
String getDisconnectReason()
Provides the reason for disconnection.
Map< String, Object > getAdditionalInfo()
Get additional attributes of the user as key/value pairs.

Public Functions Documentation

function getClientAddress

String getClientAddress()

Provides the IP address of the client.

Return: the IP address of the client

function getDisconnectReason

String getDisconnectReason()

Provides the reason for disconnection.

Return: the reason for disconnection

The typical reasons of disconnections are as follows:

  • connection_passive_close - triggered when the client closes the connection
  • connection_active_close - the connection is actively closed by the server because no keep-alive is received from the client
  • connection_error - the details about the error are provided

function getAdditionalInfo

Map< String, Object > getAdditionalInfo()

Get additional attributes of the user as key/value pairs.

Return: a map with additional attributes

No additional attributes are currently available.