Package net.luckperms.api.messaging

Interface MessagingService

public interface MessagingService
A means to push changes to other servers using the platforms networking

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull String
    getName()
    Gets the name of this messaging service
    void
    pushUpdate()
    Uses the messaging service to inform other servers about a general change.
    void
    pushUserUpdate(@NonNull User user)
    Uses the messaging service to inform other servers about a change to a specific user.

  • Method Details

    • getName

      @NonNull String getName()
      Gets the name of this messaging service
      Returns:
      the name of this messaging service

    • pushUpdate

      void pushUpdate()
      Uses the messaging service to inform other servers about a general change.

      The standard response by other servers will be to execute a overall sync of all live data, equivalent to calling LuckPerms.runUpdateTask().

      This will push the update asynchronously, and this method will return immediately. Note that this method will not cause an update to be processed on the local server.

    • pushUserUpdate

      void pushUserUpdate(@NonNull User user)
      Uses the messaging service to inform other servers about a change to a specific user.

      The standard response by other servers is undefined, however the current implementation will reload the corresponding users data if they are online.

      This will push the update asynchronously, and this method will return immediately. Note that this method will not cause an update to be processed on the local server.

      Parameters:
      user - the user to push the update for