DataLock/README.md
2022-05-15 20:27:30 +02:00

2.1 KiB

DataLock

A velocity plugin which provides a way for bukkit plugins to handle data syncing

Use by sending a message on your own plugin message channel. Add it to the DataLock config in the following format:
pluginname:customname

Sub channels

  1. try-lock:
    Attempt to lock a data entry it will send a boolean back on try-lock-result. If it can't be locked yet it will attempt to queue your lock call, if there is an existing call it will send a failure message with info on that lock on queue-lock-failed.
  2. check-lock: Check if a data entry is locked, it will send the result back as a boolean on check-lock-result
  3. try-unlock: Attempt to unlock a data entry it will send a boolean back on try-unlock-result If succesfull this will check if there is a queued lock for this data entry and if so lock that for that server and notify it on locked-queued-lock with information on what the data was

Data formats

  1. try-lock/check-lock/try-unlock:
    • UTF: sub channel (the sub channel)
    • UTF: data (data to lock/check/unlock)
  2. try-lock-result/try-unlock-result/check-lock-result
    • UTF: sub channel (the sub channel)
    • boolean: success (if the lock/unlock succeeded or not or if the data was locked or not)
    • UTF: data (data that was attempted to be locked/checked/unlocked)
  3. queue-lock-failed
    • UTF: sub channel (the sub channel)
    • UTF: data (data that was attempted to be locked/checked/unlocked)
    • UTF: server name (the servername that the current lock is from)
  4. locked-queued-lock
    • UTF: sub channel (the sub channel)
    • UTF: data (data that was locked/checked/unlocked)