LlUpdateKeyValue/ja

/ja

/LSL

UpdateKeyValue/ja

llUpdateKeyValue

Summary

Function: key llUpdateKeyValue( string k, string v, integer checked, string original_value );

	Forced Delay
	Energy

Start an asynchronous transaction to update a key-value pair associated with the script's Experience with the given key (k) and value (v).
Returns a handle (a key) that can be used to identify the corresponding dataserver event to determine if this command succeeded or failed and the results.

• string	k	–	The key for the key-value pair
• string	v	–	The value for the key-value pair. Maximum 2047 characters, or 4095 if using Mono.
• integer	checked	–	If TRUE the update will only happen if original_value matches the value in the key-value store.
• string	original_value	–	The value to compare with the current value in the key-value store.

If checked is set to TRUE then the update will only happen if original_value matches the current value in key-value store, otherwise the dataserver/ja will return a failure along with the error XP_ERROR_RETRY_UPDATE. This can be used to create an in-use flag so that  Atomicity can be achieved.

As of Jan 1, 2016 maximum bytes is 1011 for key and 4095 for value for both LSO and Mono scripts.
Using llUpdateKeyValue to update a key that does not exist will not generate XP_ERROR_KEY_NOT_FOUND. Instead, it will generate a new key with the specified value, as if you had used llCreateKeyValue.

For this function to work, the script must be compiled into an Experience.

Specification

Dataserver

The dataserver callback parameters are:

• A key containing the handle returned from llUpdateKeyValue
• A string containing a comma-delimited list (cdl). llDumpList2String([ integer success ] + components);
  • components vary depending upon success or failure of request.
  • Failure: cdl = llDumpList2String([ 0, integer error],",")
  • Success: cdl = llDumpList2String([ 1, string value ],",")

String Components

• integer	success	–	A boolean specifying if the transaction succeeded (1) or not (0).
• integer	error	–	An XP_ERROR_* flag that describes why the operation failed.
• string	value	–	The value for the key-value pair. Maximum 2047 characters, or 4095 if using Mono. Note! This value may contain commas.

Caveats

• If you recompile a script that was previously associated with an Experience but do so with a client that lacks the ability to compile scripts into an experience the script will lose the associated Experience.
• It is recommended that keys do not contain commas due to llKeysKeyValue returning keys in CSV format.

Examples

key trans;
default
{
    state_entry()
    {
        trans = llUpdateKeyValue("FOO", "BLAH", TRUE, "BAR");
    }

    dataserver(key t, string value)
    {
        if (t == trans)
        {
            // our llUpdateKeyValue transaction is done
            list result = llCSV2List(value);
            if (llList2Integer(result, 0) == 1)
            {
                // the key-value pair was successfully updated
                llSay(0, "New key-value pair was successfully updated");
            }
            else
            {
                integer error = llList2Integer(result, 1);
                if(error == XP_ERROR_RETRY_UPDATE)
                    llSay(0, "Key-value update failed, checked value is out of date");
                else
                    llSay(0, "Key-value update failed: " + llGetExperienceErrorMessage(error) );
            }  
        }
    }
}

This script demonstrates how to avoid update conflicts (two scripts updating the store at the same time), performing fully atomic updates is more complicated. If all scripts writing to the key-value store abide by the virtual lock ($DB_Lock), and only do updates in update_db state, then all writes will be atomic.

key tid;
list tids;

default {
    state_entry() {
        state lock_db;
    }
}

state lock_db {
    state_entry() {
        tid = llUpdateKeyValue("$DB_Lock", "LOCK", TRUE, "unlock");
    }
    dataserver(key did, string value) {
        if(did == tid) {
            string payload = llDeleteSubString(value, 0, 1);
            if(llGetSubString(value+",", 0, 1) == "1,"){
                llUpdateKeyValue("$DB_LockedBy", llDumpList2String([llGetOwner(),llGetKey(),llGetLinkKey(!!llGetLinkNumber()),llGetRegionName(),llGetPos(),llGetAttached()],":"), FALSE, "");
                state update_db;
            } else {
                integer err = (integer)payload;
                if(err == XP_ERROR_RETRY_UPDATE) {
                    llSay(0, "Database is already locked!");
                } else {
                    llSay(0, "Key-value update failed: " + llGetExperienceErrorMessage(err) );
                }
                state error;
            }
        }
    }
}

state update_db {
    state_entry() {
        tids = [
            llUpdateKeyValue("CatsPermissable", "5", FALSE, ""),
            llUpdateKeyValue("MonkeyMutations", "3", FALSE, ""),
            llUpdateKeyValue("CodFlavorSupport", "NEVER", FALSE, "")
        ];
    }
    dataserver(key did, string value) {
        integer i = llListFindList(tid, [did]);
        if(~i) {
            string payload = llDeleteSubString(value, 0, 1);
            if(llGetSubString(value+",", 0, 1) == "1,"){
                tids = llDeleteSubList(tids, i, i);
                if(tids == []) {
                    state unlock_db;
                }
            } else {
                llSay(0, "Key-value update failed: " + llGetExperienceErrorMessage((integer)payload) );
                state error;
            }
        }
    }
}

state unlock_db {
    state_entry() {
        tid = llUpdateKeyValue("$DB_Lock", "unlock", TRUE, "LOCK");
    }
    dataserver(key did, string value) {
        if(did == tid) {
            string payload = llDeleteSubString(value, 0, 1);
            if(llGetSubString(value+",", 0, 1) == "1,"){
                state done;
            } else {
                integer err = (integer)payload;
                if(err == XP_ERROR_RETRY_UPDATE) {
                    llSay(0, "Someone has violated the database lock!");
                } else {
                    llSay(0, "Key-value update failed: " + llGetExperienceErrorMessage(err) );
                }
                state error;
            }
        }
    }
}

state done {
    state_entry(){;}
}

state error {
    state_entry(){;}
}

Notes

Compiling

For a script to be associated with an Experience...

• It must be compiled with a client that is Experience aware,
• The "Use Experience" checkbox must be checked,
• And one of the users Experience keys selected.

重要 Not all TPVs have this functionality.

See Also

Functions

• llGetExperienceErrorMessage/ja
• llCreateKeyValue/ja
• llReadKeyValue/ja
• llUpdateKeyValue/ja
• llDeleteKeyValue/ja
• llDataSizeKeyValue/ja
• llKeyCountKeyValue/ja
• llKeysKeyValue/ja

Deep Notes

Signature
function key llUpdateKeyValue( string k, string v, integer checked, string original_value );