Difference between revisions of "Dataserver"

From Second Life Wiki
Jump to navigation Jump to search
m
m (Replaced <source> with <syntaxhighlight>)
 
(16 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Issues/SVC-2596}}{{LSL_Event
{{LSL_Event
|inject-2={{Issues/SVC-6831}}{{Issues/SVC-2596}}
|event_id=24|event_delay|event=dataserver
|event_id=24|event_delay|event=dataserver
|p1_type=key|p1_name=queryid|p1_desc=matches the return of the requesting function
|p1_type=key|p1_subtype=handle|p1_name=queryid|p1_desc=matches the return of the requesting function
|p2_type=string|p2_name=data|p2_desc=the requested data (cast as a string as necessary).
|p2_type=string|p2_name=data|p2_desc=the requested data (cast as a string as necessary).
|event_desc=Triggered when task receives asynchronous data
|event_desc=Triggered when task receives asynchronous data
Line 23: Line 24:
{{!}} rowspan="7" {{!}} [[llRequestAgentData]]
{{!}} rowspan="7" {{!}} [[llRequestAgentData]]
{{LSL Constants/llRequestAgentData}}
{{LSL Constants/llRequestAgentData}}
{{!}}-
{{!}} colspan="3" {{!}} [[llRequestDisplayName]]
{{!}} [[string]]
{{!}} colspan="4" {{!}} The agent's display name
{{!}}-
{{!}} colspan="3" {{!}} [[llRequestUsername]]
{{!}} [[string]]
{{!}} colspan="4" {{!}} The agent's username (legacy format: "first.last")
{{!}}-
{{!}} {{!}} [[llRequestUserKey]]
{{!}} string name
{{!}}
{{!}}[[key]]
{{!}} colspan="4" {{!}} The agent's unique ID.
{{!}}-
{{!}}-
{{!}} rowspan="1" {{!}} [[llRequestInventoryData]]
{{!}} rowspan="1" {{!}} [[llRequestInventoryData]]
{{LSL Constants/llRequestInventoryData}}
{{LSL Constants/llRequestInventoryData}}
{{!}}-
{{!}}-
{{!}} rowspan="9" {{!}} [[llRequestSimulatorData]]
{{!}} rowspan="13" {{!}} [[llRequestSimulatorData]]
{{LSL Constants/llRequestedSimulatorData}}
{{LSL Constants/llRequestedSimulatorData}}
{{!}}-
{{!}} colspan="3" {{!}} [[llCreateKeyValue]]
{{!}} [[llCSV2List]]()
{{!}} colspan="4" {{!}} {{LSL Function/KeyValue|k|v|dataserver|value=value|d2_type=string|d2_name=value|dataserver=*}}
{{!}}-
{{!}} colspan="3" {{!}} [[llDataSizeKeyValue]]
{{!}} [[llCSV2List]]()
{{!}} colspan="4" {{!}} {{LSL Function/KeyValue|d2_type=integer|d2_name=used|d2_desc=Number of bytes used|d3_type=integer|d3_name=quota|d3_desc=Number of bytes the key-store can utilize|dataserver=*}}
{{!}}-
{{!}} colspan="3" {{!}} [[llDeleteKeyValue]]
{{!}} [[llCSV2List]]()
{{!}} colspan="4" {{!}} {{LSL Function/KeyValue|k|value=value|d2_type=string|d2_name=value|dataserver=*}}
{{!}}-
{{!}} colspan="3" {{!}} [[llKeyCountKeyValue]]
{{!}} [[llCSV2List]]()
{{!}} colspan="4" {{!}} {{LSL Function/KeyValue|d2_type=integer|d2_name=pairs|d2_desc=number of keys-value pairs in the key-value store|dataserver=*}}
{{!}}-
{{!}} colspan="3" {{!}} [[llKeysKeyValue]]
{{!}} [[llCSV2List]]()
{{!}} colspan="4" {{!}} {{LSL Function/KeyValue|dl_name=keys
|dl_desc=A list of keys ([[String|strings]]) used in the key-value store
|dl_hover=A list of keys (strings) used in the key-value store|dataserver=*}}
{{!}}-
{{!}} colspan="3" {{!}} [[llReadKeyValue]]
{{!}} [[llCSV2List]]()
{{!}} colspan="4" {{!}} {{LSL Function/KeyValue|k|value=value|d2_type=string|d2_name=value|dataserver=*}}
{{!}}-
{{!}} colspan="3" {{!}} [[llUpdateKeyValue]]
{{!}} [[llCSV2List]]()
{{!}} colspan="4" {{!}} {{LSL Function/KeyValue|k|v|value=value|d2_type=string|d2_name=value|dataserver=*}}
{{!}}-
{{!}}}
{{!}}}
|caveats=
|caveats=
*Dataserver answers do not necessarily come in the order they were requested.
**If there are multiple pending requests, always use the queryid key to determine which answer is being received.
*Dataserver requests will trigger '''dataserver''' events in all scripts within the same prim where the request was made.
*Dataserver requests will trigger '''dataserver''' events in all scripts within the same prim where the request was made.
**If there are multiple scripts with '''dataserver''' events in the same prim, always use the queryid key to determine which answer is being received.
**If there are multiple scripts with '''dataserver''' events in the same prim, always use the <code>queryid</code> key to determine which answer is being received.
**'''dataserver''' events will not be triggered in scripts contained in other prims in the same linked object.
**'''dataserver''' events will not be triggered in scripts contained in other prims in the same linked object.
*If more data is requested using the same query_id before the '''dataserver''' event dealing with that query_id has resolved the data will be trashed. To avoid the trashing do not ask [[if]](query_key == query_id). Though (see above caveats) this has its own drawbacks.
*When dealing with multiple dataserver queries it is possible to receive the responses in any order, if you receive a response at all. It is good practise to maintain variables (or a list) with keys of all data server events you are waiting for, then use <code>queryid</code>
|notes=*Requesting a dataserver event from within a dataserver event is a very valid use of this function. Be aware not to make your own loop inside the event.  It will lock the event open till the loop is finished then send all the requests made, from within, with the data from the first retrieval.
**When using <code>if (dKey == queryid)</code>, or similar, in your dataserver events it is important to remember that changes to <code>dKey</code> will cause your script to ignore any requests that were made earlier that have not yet arrived; consider using more than one variable (or a list) if such cases may cause desired events to be ignored.
|examples=<lsl>key kQuery;
**When using a list to track events, it is important to periodically check the list for requests that have taken too long and either resend them, or remove them (see examples), as it is possible for any dataserver request to fail, usually due to high traffic or the script receiving too many other events.
integer iLine = 0;
|notes=*Requesting data from within the '''dataserver''' event is quite valid. However, be aware that further '''dataserver''' events cannot be received until the event that sent the request has been completed.
default {
|examples=
   
<syntaxhighlight lang="lsl2">
     state_entry() {
// Example script handling sequential data server events (notecard reading)
 
string notecardNameOrKey = "name or key of the notecard goes here";
key notecardQueryId;
integer notecardLine;//  first notecard line is 0, so we don't have to set notecardLine = 1 here
 
default
{
     state_entry()
    {
         llSay(0, "Reading notecard...");
         llSay(0, "Reading notecard...");
         kQuery = llGetNotecardLine("My Notecard", iLine);
         notecardQueryId = llGetNotecardLine(notecardNameOrKey, notecardLine);
     }
     }


     dataserver(key query_id, string data) {
     dataserver(key query_id, string data)
    {
        if (query_id == notecardQueryId)
        {
            if (data == EOF)//  we have reached the EOF (end of file)
            {
                llSay(0, "No more lines in notecard, read " + (string) notecardLine + " lines.");
            }
            else
            {
            //  increment line index first, both for line number reporting, and for reading the next line
                ++notecardLine;
                llSay(0, "Line " + (string) notecardLine + ": " + data);
                notecardQueryId = llGetNotecardLine(notecardNameOrKey, notecardLine);
            }
        }
    }
}
</syntaxhighlight>
<syntaxhighlight lang="lsl2">
// Example script handling multiple data server events
 
list events;
integer stride = 3;
 
default
{
    touch_start(integer num_detected)
    {
        key id = llDetectedKey(0);
        events += [llRequestDisplayName(id), id, llGetUnixTime()];
        llSetTimerEvent(35.0);
    }


         if (query_id == kQuery) {
    dataserver(key request_id, string data)
            // this is a line of our notecard
    {
            if (data == EOF) {   
         integer index = llListFindList(events, [ request_id] );
        // The chance of getting a match on an avatar UUID instead of the dataserver event key, is less than 1 in 2^100


                llSay(0, "No more lines in notecard, read " + (string)iLine + " lines.");
        if (~index )
        {
            key id = llList2Key(events, index + 1);
            llRegionSayTo(id, 0, "Hello " + data + "!");


             } else {
             events = llDeleteSubList(events, index, index + stride - 1);
 
            if (events == [])
                llSetTimerEvent(0);
        }
    }


                // increment line count
    timer()
                llSay(0, "Line " + (string)iLine + ": " + data);
    {
               
        integer length = (events != []);
                //request next line
                ++iLine;
                kQuery = llGetNotecardLine("My Notecard", iLine);


             }
        // Loop until we find a valid entry (as all entries after will be valid too)
        while (length && llList2Integer(events, 2) < (llGetUnixTime() - 30))
        {
             events = llDeleteSubList(events, 0, stride - 1);
            length -= stride;
         }
         }
        if (events == [])
            llSetTimerEvent(0);
     }
     }
}</lsl>
}
</syntaxhighlight>
|helpers
|helpers
|also_header
|also_header
Line 77: Line 176:
|mode
|mode
|deprecated
|deprecated
|haiku={{Haiku|Asked questions pile up.|Take a number, get in line,|all answers charge time.}}
|cat1=Dataserver
|cat1=Dataserver
|cat2=Notecard
|cat2=Notecard
Line 83: Line 183:
|cat5=Script
|cat5=Script
|cat6=Prim
|cat6=Prim
|cat7=Avatar
|cat8=Avatar/Name
}}
}}

Latest revision as of 07:36, 30 April 2024

Description

! Event: dataserver( key queryid, string data ){ ; }

Triggered when task receives asynchronous data

• key queryid matches the return of the requesting function
• string data the requested data (cast as a string as necessary).
Function Input Decode Description
llGetNotecardLine string The line in the requested notecard, limited to 255 bytes.
If EOF the line requested is past the end of the notecard.
llGetNumberOfNotecardLines (integer) The number of lines in the notecard requested.
llRequestAgentData DATA_ONLINE 1 (integerboolean If the requested agent is online
DATA_NAME 2 string The requested agent's legacy name
DATA_BORN 3 string The account creation/"born on" date as a string in an ISO 8601 format of YYYY-MM-DD.
DATA_RATING 4 llCSV2List() Deprecated: Returns [0, 0, 0, 0, 0, 0]
Used to return: [pos_behavior, neg_behavior, pos_appearance, neg_appearance, pos_building, neg_building]
DATA_PAYINFO 8 (integermask Flag Description
PAYMENT_INFO_ON_FILE 0x1 If payment info is on file.
PAYMENT_INFO_USED 0x2 If payment info has been used.
llRequestDisplayName string The agent's display name
llRequestUsername string The agent's username (legacy format: "first.last")
llRequestUserKey string name key The agent's unique ID.
llRequestInventoryData Landmark (vector) The vector data received by dataserver is a global position as an offset from the current region's origin (<0,0,0>). To obtain the absolute global position of a landmark, add llGetRegionCorner() to the vector.
llRequestSimulatorData DATA_SIM_POS 5 (vector) The regions global position.
DATA_SIM_STATUS 6 string Value Description
"up" region currently up and running
"down" region currently down
"starting" region currently starting
"stopping" region currently stopping
"crashed" region has crashed
"unknown" region status unknown or unknown region
DATA_SIM_RATING 7 string Value Maturity rating
"PG" Parcel lght G.png General
"MATURE" Parcel lght M.png Moderate
"ADULT" Parcel lght A.png Adult
"UNKNOWN" rating or region unknown
llCreateKeyValue llCSV2List()

The string containing a comma-delimited list (cdl). llDumpList2String([ integer success ] + components);

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.
llDataSizeKeyValue llCSV2List()

The string containing a comma-delimited list (cdl). llDumpList2String([ integer success ] + components);

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.
• integer used Number of bytes used
• integer quota Number of bytes the key-store can utilize
llDeleteKeyValue llCSV2List()

The string containing a comma-delimited list (cdl). llDumpList2String([ integer success ] + components);

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.
llKeyCountKeyValue llCSV2List()

The string containing a comma-delimited list (cdl). llDumpList2String([ integer success ] + components);

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.
• integer pairs number of keys-value pairs in the key-value store
llKeysKeyValue llCSV2List()

The string containing a comma-delimited list (cdl). llDumpList2String([ integer success ] + components);

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.
• list keys A list of keys (strings) used in the key-value store
llReadKeyValue llCSV2List()

The string containing a comma-delimited list (cdl). llDumpList2String([ integer success ] + components);

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.
llUpdateKeyValue llCSV2List()

The string containing a comma-delimited list (cdl). llDumpList2String([ integer success ] + components);

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

  • Dataserver requests will trigger dataserver events in all scripts within the same prim where the request was made.
    • If there are multiple scripts with dataserver events in the same prim, always use the queryid key to determine which answer is being received.
    • dataserver events will not be triggered in scripts contained in other prims in the same linked object.
  • When dealing with multiple dataserver queries it is possible to receive the responses in any order, if you receive a response at all. It is good practise to maintain variables (or a list) with keys of all data server events you are waiting for, then use queryid
    • When using if (dKey == queryid), or similar, in your dataserver events it is important to remember that changes to dKey will cause your script to ignore any requests that were made earlier that have not yet arrived; consider using more than one variable (or a list) if such cases may cause desired events to be ignored.
    • When using a list to track events, it is important to periodically check the list for requests that have taken too long and either resend them, or remove them (see examples), as it is possible for any dataserver request to fail, usually due to high traffic or the script receiving too many other events.


Examples

// Example script handling sequential data server events (notecard reading)

string notecardNameOrKey = "name or key of the notecard goes here";
key notecardQueryId;
integer notecardLine;//  first notecard line is 0, so we don't have to set notecardLine = 1 here

default
{
    state_entry()
    {
        llSay(0, "Reading notecard...");
        notecardQueryId = llGetNotecardLine(notecardNameOrKey, notecardLine);
    }

    dataserver(key query_id, string data)
    {
        if (query_id == notecardQueryId)
        {
            if (data == EOF)//  we have reached the EOF (end of file)
            {
                llSay(0, "No more lines in notecard, read " + (string) notecardLine + " lines.");
            }
            else
            {
            //  increment line index first, both for line number reporting, and for reading the next line
                ++notecardLine;
                llSay(0, "Line " + (string) notecardLine + ": " + data);
                notecardQueryId = llGetNotecardLine(notecardNameOrKey, notecardLine);
            }
        }
    }
}
// Example script handling multiple data server events

list events;
integer stride = 3;

default
{
    touch_start(integer num_detected)
    {
        key id = llDetectedKey(0);
        events += [llRequestDisplayName(id), id, llGetUnixTime()];
        llSetTimerEvent(35.0);
    }

    dataserver(key request_id, string data)
    {
        integer index = llListFindList(events, [ request_id] );
        // The chance of getting a match on an avatar UUID instead of the dataserver event key, is less than 1 in 2^100

        if (~index )
        { 
            key id = llList2Key(events, index + 1);
            llRegionSayTo(id, 0, "Hello " + data + "!");

            events = llDeleteSubList(events, index, index + stride - 1);

            if (events == [])
                llSetTimerEvent(0);
        }
    }

    timer()
    {
        integer length = (events != []);

        // Loop until we find a valid entry (as all entries after will be valid too)
        while (length && llList2Integer(events, 2) < (llGetUnixTime() - 30))
        {
            events = llDeleteSubList(events, 0, stride - 1);
            length -= stride;
        }

        if (events == [])
            llSetTimerEvent(0);
    }
}

Notes

  • Requesting data from within the dataserver event is quite valid. However, be aware that further dataserver events cannot be received until the event that sent the request has been completed.

Deep Notes

Issues

All Issues

~ Search JIRA for related Issues
   llRequestAgentData with DATA_ONLINE parameter has a delay of up to 10 minutes in reporting offline status
   Script dataserver events become permanently blocked until sim restart

Signature

event void dataserver( key queryid, string data );

Haiku

Asked questions pile up.
Take a number, get in line,
all answers charge time.