com.electrotank.electroserver.plugins
Interface LogOutEventInterface

public interface LogOutEventInterface

The LogOutEventInterface is used to define a class as a log out event handler. The implementing class also needs to extend AbstractEventHandler.

Method Summary

void	logOut(String userName) invoked when a user logs out of the server.

Method Detail

logOut

public void logOut(String userName)
            throws EventException

invoked when a user logs out of the server. This log out might be voluntary (LogOutTransaction) or not (closing the socket, kick, ban, etc). This method returns nothing as the user is logged out fully at the point this method completes. The server does not synchronize calls to this method so it's necessary for the implementing class to synchronize as appropriate.

Parameters:

userName - the username of the user logging out.

Throws:

EventException - thrown to indicate there was an error logging the user out. The user will be disconnected from the server if this is thrown or not.