Altitude/DataLock
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Formatted readme

Browse Source
This commit is contained in:
Teriuihi 2022-05-15 19:50:41 +02:00 committed by GitHub
parent 90c15265ec
commit 5f9666684f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 48 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
README.md
View File

@ -1,30 +1,52 @@
# DataLock
A velocity plugin which provides a way for bukkit plugins to handle data syncing
<p>A velocity plugin which provides a way for bukkit plugins to handle data syncing</p>
Use by sending a message on your own plugin message channel. Add it to the DataLock config in the following format:
`pluginname:customname`
<p>Use by sending a message on your own plugin message channel. Add it to the DataLock config in the following format:<br>
<code>pluginname:customname</code></p>
Possible sub channels to send data on are:
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`.
check-lock: Check if a data entry is locked, it will send the result back as a boolean on `check-lock-result`
try-unlock: Attempt to unlock a data entry it will send a boolean back on `try-lock-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
## Sub channels
<ol>
<li>
<code>try-lock</code>:<br>Attempt to lock a data entry it will send a boolean back on <code>try-lock-result</code>.
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 <code>queue-lock-failed</code>.
</li>
<li>
<code>check-lock</code>: Check if a data entry is locked, it will send the result back as a boolean on <code>check-lock-result</code>
</li>
<li>
<code>try-unlock</code>: Attempt to unlock a data entry it will send a boolean back on <code>try-lock-result</code>
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
<code>locked-queued-lock</code> with information on what the data was
</li>
</ol>
data formats:
`try-lock`/`check-lock`/`try-unlock`:
UTF: sub channel (the sub channel)
UTF: data (data to lock/check/unlock)
`try-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)
`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)
`locked-queued-lock`
UTF: sub channel (the sub channel)
UTF: data (data that was locked/checked/unlocked)
## Data formats
<ol>
<li><code>try-lock</code>/<code>check-lock</code>/<code>try-unlock</code>:
<ul>
<li>UTF: sub channel (the sub channel)</li>
<li>UTF: data (data to lock/check/unlock)</li>
</ul>
</li>
<li><code>try-lock-result</code>
<ul>
<li>UTF: sub channel (the sub channel)
<li>boolean: success (if the lock/unlock succeeded or not or if the data was locked or not)</li>
<li>UTF: data (data that was attempted to be locked/checked/unlocked)</li>
</ul>
</li>
<li><code>queue-lock-failed</code>
<ul>
<li>UTF: sub channel (the sub channel)</li>
<li>UTF: data (data that was attempted to be locked/checked/unlocked)</li>
<li>UTF: server name (the servername that the current lock is from)</li>
</ul>
</li>
<li><code>locked-queued-lock</code>
<ul>
<li>UTF: sub channel (the sub channel)</li>
<li>UTF: data (data that was locked/checked/unlocked)</li>
</ul>
</li>
</ol>