Script to send a Heartbeat signal to the Signage Table. More...

Functions
	rdProcessFailureMessage (string FailureMessage)
	Convert error messages into something that is more readable.
integer	rdGetVersionNumber (string VersionString)
	Convert Version String into an Integer.
	rdSaveNewTeleportNotecard (list teleport_list)
	Save the Teleportation Destinations into a Notecard.
	rdSendHeartbeatMessage ()

Variables
string	VERSION_STRING = "0.0.1"
float	MINIMUM_HEARTBEAT_PERIOD = 0.1
	The fastest allowable heartbeat.
string	CONFIG_NOTECARD_NAME = "brigadoon_signage.config"
	Script(s) Configuration Notecard.
string	COMMENT_PREAMBLE = "//"
	Preamble for a comment line in the configuration file.
integer	COMMENT_PREAMBLE_LENGTH = 2
	THe number of characters in the comment preamble Menu Item = [17:16] Nothing Found!
string	DATABASE_INTERFACE = "DATABASE_INTERFACE"
	The Configuration File Identifier for the Database Interface URL.
string	HEARTBEAT_PERIOD = "HEARTBEAT_PERIOD"
	The Configuration File Identifier for the Heartbeat Period.
float	TIMER_OFF = 0.0
	Set the Timer delay to 0.0 which turns off the timer events.
float	MINIMUM_HEARTBEAT_INTERVAL = 600
float	MINIMUM_OFFSET = 0.5
	Minimum allowable offset.
key	heartbeat_key
	The Heatbeat HTTP Requrest Key.
string	database_interface
	The address of the database interface.
float	heartbeat_period
	Interval in seconds between Heartbeat messages.
integer	version_number
	Version number as integer.

Detailed Description

Script to send a Heartbeat signal to the Signage Table.

Version: 0.0.1

Date: 01-February-2026

Author: River Drifter @ little-sense.au:9000 \email river.nosp@m._dri.nosp@m.fter@.nosp@m.auss.nosp@m.iebro.nosp@m.adba.nosp@m.nd.co.nosp@m.m.au

Additional Information: https://www.little-sense.au/project_dynamic/BRIGADOON-0012/html/index.html

NOTE: The file extension ".osl" indicates the script uses the Open Simulator Script language (OSSL) and will not function in the Second Life environment. If the script will function using just the Linden Scripting Language (LSL), it will have a a file extension of ".lsl".

Definition in file signage_heartbeat.osl.

Function Documentation

◆ rdGetVersionNumber()

integer rdGetVersionNumber ( string VersionString )

Convert Version String into an Integer.

Parameters

Version String to be converted

Returns: Integer value of the Version String

Definition at line 150 of file signage_heartbeat.osl.

{
    integer version;
    
    list versions = llParseString2List(VersionString, ["."], []);
    version = (integer)llList2String(versions,2) + ((integer)llList2String(versions,1) * 100) + ((integer)llList2String(versions,0) * 10000);
    
    return version;
}

◆ rdProcessFailureMessage()

rdProcessFailureMessage ( string FailureMessage )

Convert error messages into something that is more readable.

Parameters

The	error message string to be decoded

This routine takes the abbreviated error message and expands this to an error message that should be more readable by a user not familar with how the program operates.

Definition at line 124 of file signage_heartbeat.osl.

{
    string failure_message;
    
    list status = llParseString2List(FailureMessage, [":"], ["\n"]);  
    string failure_type = llList2String(status, 0);
    
    // Explain why the Teleporter could not be automatically processed
    if (failure_type == "BANNED")
    {
        failure_message  = "Teleporters owned by user " + llList2String(status, 1) + " are not permitted to";
        failure_message += " add teleporters to the database, update teleporter information or update teleporter destinations.";
    }
       
    // Tell the person what to do if there was an error.
    failure_message += "\n If you wish to report this as an error please send this message to River Drifter with details of what happened and when.\n";
    llSay(0, failure_message); 
}

◆ rdSaveNewTeleportNotecard()

rdSaveNewTeleportNotecard ( list teleport_list )

Save the Teleportation Destinations into a Notecard.

Parameters

telport_list List of telportation destinations

This routine will remove the Teleportation Notecard and make a new Notecard.

Definition at line 168 of file signage_heartbeat.osl.

{
    // Add the Preamble Text before the List of Destinations
    teleport_list = destination_preamble + teleport_list;
       
    // Delete the Existing Teleporter Destination Notecard, if it exists
    integer count = llGetInventoryNumber(INVENTORY_NOTECARD);
    integer index = 0;
    for (; index < count; ++index)
    {
        if (llGetInventoryName(INVENTORY_NOTECARD, index) == CONFIG_DESTINATIONS_NAME)
        {
            llRemoveInventory(CONFIG_DESTINATIONS_NAME);
            index = count;  // Ext Loop
        }
    }
    
    // Write the Teleport List to a New Notecard
    osMakeNotecard(CONFIG_DESTINATIONS_NAME, teleport_list);
}

◆ rdSendHeartbeatMessage()

rdSendHeartbeatMessage ( )

\break Send a heartbeat to the database via the webserver

This message sends a heartbeat command to the program controlling the database. The message contains the following information:

This message serves two purposes. First, it confirms that the teleporter still exists and is operational. Secondly, it confirms, and updates if necessary, the information about the Teleporter.

This information allows the database program to automatically delete destinations where the teleporter and by inference, the regions has disappeared.

Definition at line 202 of file signage_heartbeat.osl.

{
    // Do a cursory Check that the configuration has been set up
    if (database_interface != "")
    {       
        key messageboard_key = llGetKey();
        list details = llGetObjectDetails(teleporter_key, [OBJECT_OWNER, OBJECT_GROUP]);
        
        string heartbeat_message = database_interface + "?command=heartbeat"
                                + "&key="          + messageboard_key
                                + "&owner="        + llList2String(details, 0)
                                + "&group="        + llList2String(details, 1)
        heartbeat_key = llHTTPRequest(heartbeat_message, [HTTP_BODY_MAXLENGTH,16384], [""]);      
    }
    else
    {
        llSay(DEBUG_CHANNEL, "The database_interface are undefined! Teleporter " + location_name + " has been disabled");
        llSetScriptState(llGetScriptName(), FALSE); 
    }
} 

References database_interface, and heartbeat_key.

Variable Documentation

◆ COMMENT_PREAMBLE

string COMMENT_PREAMBLE = "//"

Preamble for a comment line in the configuration file.

The configuration file only allows comments which take up the complete lilne in the file.

Definition at line 44 of file signage_heartbeat.osl.

◆ COMMENT_PREAMBLE_LENGTH

integer COMMENT_PREAMBLE_LENGTH = 2

THe number of characters in the comment preamble Menu Item = [17:16] Nothing Found!

Definition at line 51 of file signage_heartbeat.osl.

◆ CONFIG_NOTECARD_NAME

string CONFIG_NOTECARD_NAME = "brigadoon_signage.config"

Script(s) Configuration Notecard.

This notecard is used to configure the brigadoon_teleporter.osl and the teleporter_heartbeat.osl scripts.

Definition at line 36 of file signage_heartbeat.osl.

◆ DATABASE_INTERFACE

string DATABASE_INTERFACE = "DATABASE_INTERFACE"

The Configuration File Identifier for the Database Interface URL.

Definition at line 57 of file signage_heartbeat.osl.

◆ database_interface

string database_interface

The address of the database interface.

Definition at line 96 of file signage_heartbeat.osl.

Referenced by rdSendHeartbeatMessage().

◆ heartbeat_key

key heartbeat_key

The Heatbeat HTTP Requrest Key.

Definition at line 90 of file signage_heartbeat.osl.

Referenced by rdSendHeartbeatMessage().

◆ HEARTBEAT_PERIOD

string HEARTBEAT_PERIOD = "HEARTBEAT_PERIOD"

The Configuration File Identifier for the Heartbeat Period.

Definition at line 63 of file signage_heartbeat.osl.

◆ heartbeat_period

float heartbeat_period

Interval in seconds between Heartbeat messages.

Definition at line 103 of file signage_heartbeat.osl.

◆ MINIMUM_HEARTBEAT_INTERVAL

float MINIMUM_HEARTBEAT_INTERVAL = 600

Definition at line 78 of file signage_heartbeat.osl.

◆ MINIMUM_HEARTBEAT_PERIOD

float MINIMUM_HEARTBEAT_PERIOD = 0.1

The fastest allowable heartbeat.

This is the minimum interval allowed between heartbeats. This is set to prevent the script from flooding the databse webserver with heartbeat messages, in what would essentially be a denial of service attack.

Definition at line 27 of file signage_heartbeat.osl.

◆ MINIMUM_OFFSET

float MINIMUM_OFFSET = 0.5

Minimum allowable offset.

Definition at line 84 of file signage_heartbeat.osl.

◆ TIMER_OFF

float TIMER_OFF = 0.0

Set the Timer delay to 0.0 which turns off the timer events.

Definition at line 70 of file signage_heartbeat.osl.

◆ version_number

integer version_number

Version number as integer.

This integer takes the version string like "1.2.3" into a single integer. The integer is calculated using:

(1 * 10000) + (2 * 100) + 3 => 10023

Definition at line 114 of file signage_heartbeat.osl.

◆ VERSION_STRING

string VERSION_STRING = "0.0.1"

Definition at line 17 of file signage_heartbeat.osl.

Functions

Variables

Detailed Description

Function Documentation

◆ rdGetVersionNumber()

◆ rdProcessFailureMessage()

◆ rdSaveNewTeleportNotecard()

◆ rdSendHeartbeatMessage()

Variable Documentation

◆ COMMENT_PREAMBLE

◆ COMMENT_PREAMBLE_LENGTH

◆ CONFIG_NOTECARD_NAME

◆ DATABASE_INTERFACE

◆ database_interface

◆ heartbeat_key

◆ HEARTBEAT_PERIOD

◆ heartbeat_period

◆ MINIMUM_HEARTBEAT_INTERVAL

◆ MINIMUM_HEARTBEAT_PERIOD

◆ MINIMUM_OFFSET

◆ TIMER_OFF

◆ version_number

◆ VERSION_STRING