Replikwando Messages - Revision history

Jmckinstry: /* Checking Who Has Repushed Recently */

2015-08-06T19:54:40Z

Checking Who Has Repushed Recently

← Older revision		Revision as of 14:54, 6 August 2015
Line 133:		Line 133:

	===Checking Who Has Repushed Recently===		===Checking Who Has Repushed Recently===
	SELECT *		SELECT `timestamp`, `messagetype`, `value` AS `database`, `received` AS `watcher_has_received`, IF(`finished` IS NULL, 'False', 'True') AS `watcher_has_handled`
	FROM heartbeat.message		FROM heartbeat.message
	LEFT JOIN messagedata USING (messageid)		LEFT JOIN messagedata USING (messageid)

Jmckinstry: /* Database Interaction */

2015-08-06T19:52:03Z

Database Interaction

← Older revision		Revision as of 14:52, 6 August 2015
Line 131:		Line 131:

	SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_UPDATE', 'True', 'False');		SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_UPDATE', 'True', 'False');

			===Checking Who Has Repushed Recently===
			SELECT *
			FROM heartbeat.message
			LEFT JOIN messagedata USING (messageid)
			WHERE `timestamp` > NOW() - INTERVAL 4 HOUR
			AND `messagetype` = 'REPLIKWANDO_MESSAGE_FINISHED_REPUSH'
			AND `name` = 'ToDatabase'
			ORDER BY `timestamp` DESC;

	=Replikwando Statuses=		=Replikwando Statuses=

Jmckinstry at 00:03, 7 March 2012

2012-03-07T00:03:35Z

← Older revision		Revision as of 19:03, 6 March 2012
Line 132:		Line 132:
	SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_UPDATE', 'True', 'False');		SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_UPDATE', 'True', 'False');

	==Replikwando Statuses==		=Replikwando Statuses=
	*OK: Replikwando believes everything is operating as intended.		*OK: Replikwando believes everything is operating as intended.
	*ErrorWaiting: Replikwando is still pushing data and reporting in, but it will need to repush when its scheduled time comes.		*ErrorWaiting: Replikwando is still pushing data and reporting in, but it will need to repush when its scheduled time comes.
	*Stopped: Replikwando has either been turned off at the local computer or has failed to report in for more than an hour.		*Stopped: Replikwando has either been turned off at the local computer or has failed to report in for more than an hour.

Jmckinstry at 00:02, 7 March 2012

2012-03-07T00:02:57Z

← Older revision		Revision as of 19:02, 6 March 2012
Line 131:		Line 131:

	SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_UPDATE', 'True', 'False');		SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_UPDATE', 'True', 'False');

			==Replikwando Statuses==
			*OK: Replikwando believes everything is operating as intended.
			*ErrorWaiting: Replikwando is still pushing data and reporting in, but it will need to repush when its scheduled time comes.
			*Stopped: Replikwando has either been turned off at the local computer or has failed to report in for more than an hour.

Jmckinstry at 21:41, 20 July 2011

2011-07-20T21:41:43Z

← Older revision		Revision as of 16:41, 20 July 2011
Line 2:		Line 2:
	Replikwando currently has a messaging back-end (using libITMySQLMessageFramework) that allows it to send and receive information. While there are plans for implementing a GUI interface to do this (at which point this documentation will change to reflect that), these sections will get you by.		Replikwando currently has a messaging back-end (using libITMySQLMessageFramework) that allows it to send and receive information. While there are plans for implementing a GUI interface to do this (at which point this documentation will change to reflect that), these sections will get you by.

			==Usage Examples==
			*[[Database:Replikwando_Message#Repush\|Repushing]]
			*[[Database:Replikwando_Message#Version%20Update\|Update Version]]
			*[[Database:Replikwando_Message#Status\|Get Current Status]]
	==Messages==		==Messages==
	===REPLIKWANDO_MESSAGE_REPUSH===		===REPLIKWANDO_MESSAGE_REPUSH===

Jmckinstry: /* Updating Replikwando */

2010-12-31T21:25:52Z

Updating Replikwando

← Older revision		Revision as of 16:25, 31 December 2010
Line 124:		Line 124:
	<insert the file blob data into `t_update_data`.`data`>		<insert the file blob data into `t_update_data`.`data`>

	SELECT heartbeat.f_message_attach_data(1446, 'Input', '~~data~~', `data`) FROM t_update_data;		SELECT heartbeat.f_message_attach_data(1446, 'Input', 'Data', `data`) FROM t_update_data;

	SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_UPDATE', 'True', 'False');		SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_UPDATE', 'True', 'False');

Jmckinstry: /* Database Interaction */

2010-12-31T21:15:45Z

Database Interaction

Jmckinstry: /* Updating Replikwando */ lolz this is kinda important

2010-12-31T21:14:28Z

Updating Replikwando: lolz this is kinda important

← Older revision		Revision as of 16:14, 31 December 2010
Line 110:		Line 110:
	===Updating Replikwando===		===Updating Replikwando===
	SELECT heartbeat.f_message_init('<uuid_handle>') INTO @messageID;		SELECT heartbeat.f_message_init('<uuid_handle>') INTO @messageID;
	SELECT heartbeat.f_message_attach_data(@messageID, 'Input', '~~PostBack~~', '~~True~~');		SELECT heartbeat.f_message_attach_data(@messageID, 'Input', 'Version', '<version>');
	SELECT heartbeat.f_message_attach_data(@messageID, 'Input', 'IsService', 'False');		SELECT heartbeat.f_message_attach_data(@messageID, 'Input', 'IsService', 'False');
	CREATE TEMPORARY TABLE t_update_data(`data` MEDIUMBLOB);		CREATE TEMPORARY TABLE t_update_data(`data` MEDIUMBLOB);

Jmckinstry: Created page with "=Replikwando Messages= Replikwando currently has a messaging back-end (using libITMySQLMessageFramework) that allows it to send and receive information. While there are plans fo..."

2010-12-31T20:46:40Z

Created page with "=Replikwando Messages= Replikwando currently has a messaging back-end (using libITMySQLMessageFramework) that allows it to send and receive information. While there are plans fo..."

New page

=Replikwando Messages=
Replikwando currently has a messaging back-end (using libITMySQLMessageFramework) that allows it to send and receive information. While there are plans for implementing a GUI interface to do this (at which point this documentation will change to reflect that), these sections will get you by.

==Messages==
===REPLIKWANDO_MESSAGE_REPUSH===
Inputs
*RepushTime (seconds, int, optional) - When to restart. If unspecified, Replikwando will choose
*PostBack (True/False, enum, optional) - Declares if a response is wanted back. If unspecified, Replikwando will not respond
Outputs
*Success (True/False, enum) - If Replikwando will really restart
*Reason (error message, string, opt) - The reason Replikwando won't be restarting, if any

===REPLIKWANDO_MESSAGE_RESTART===
Inputs
*PostBack (True/False, enum, optional) - Declares if a response is wanted back. If unspecified, Replikwando will not respond
Outputs
*None

===REPLIKWANDO_MESSAGE_REQUEST_STATUS===
Inputs
*ReplikwandoDataObject (object name, string, optional) - The specific data you wish to get. If unspecified, Replikwando will respond with a generic string. See below for object values
Outputs
*Value (object value, string) - The object's value, or a generic output if no object was specified

====Object Values====
REPLIKWANDO_STATUS_OBJECT_STARTED_AT // Returns the date/time Replikwando started at

REPLIKWANDO_STATUS_OBJECT_TOTAL_QUERIES // Total queries executed

REPLIKWANDO_STATUS_OBJECT_QUERIES_IN_MEMORY // Number of queries in memory currently

REPLIKWANDO_STATUS_OBJECT_QUERIES_IN_TABLE // Number of queries in the sqlite table

REPLIKWANDO_STATUS_OBJECT_CURRENT_STATUS // Replikwando's current running status

REPLIKWANDO_STATUS_OBJECT_CURRENT_ERROR // Replikwando's current stopping error. Empty String if everything is okay (Not implemented yet)

REPLIKWANDO_STATUS_OBJECT_REPUSH_TIME // The time Replikwando will re-push. Empty String if no repush is scheduled

REPLIKWANDO_STATUS_OBJECT_MOST_RECENT_QUERY // The most recent query Replikwando has handled (includes both successful and failing queries, and is dependent on the state of Replikwando)

REPLIKWANDO_STATUS_OBJECT_VERSION // Replikwando's static version

===REPLIKWANDO_MESSAGE_SKIP_QUERY===
Inputs
*PostBack (True/False, enum, optional) - Declares if a response is wanted back. If unspecified, Replikwando will not respond
Outputs
*Success (True/False, enum) - True

===REPLIKWANDO_MESSAGE_FINISHED_REPUSH===
Inputs
*ToDatabase (table name, string) - The name of the database that had its data finish pushing
*ToConnection (connection name, string) - The name of the connection that the ToDatabase table can be found in
Outputs
*None

===REPLIKWANDO_MESSAGE_GET_INI===
Inputs
*None
Outputs
*Value (ini values, string) - The replication.ini file in all its glory.

===REPLIKWANDO_MESSAGE_GET_INI_VALUE===
Inputs
*Header (header, string) - The replication.ini value's header
*Name (setting name, string) - The replication.ini value's name
Outputs
*Found (True/False, enum) - True if the value was found, and Value will be set, False otherwise and Value will not be set
*Value (value, string, optional) - The replication.ini's recorded value for [Header]Name, if any

===REPLIKWANDO_MESSAGE_SET_INI_VALUE===
Inputs
*Header (header, string) - The replication.ini value's header
*Name (setting name, string) - The replication.ini value's name
*Value (setting value, string) - The replication.ini value's actual data
Outputs
*None

===REPLIKWANDO_MESSAGE_UPDATE===
Inputs
*Version (version, string) - The version of Replikwando that the file data represents
*IsService (True/False, enum) - True if the update included as Data is the service version
*Data (file data, blob) - The file data that makes up the file. May be very large
Outputs
*None

==Database Interaction==
The basic setup of a message being sent to replikwando goes like this:
#Initialize the message
#If the message requires inputs, add them
#Post the message
#If you expect a response, check v_responses until you get one
#Close the message if you wanted a response

Here are some examples:
===Getting Status===
SELECT heartbeat.f_message_init('<uuid_handle>') INTO @messageID;
SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_REQUEST_STATUS', 'False', 'True');
SELECT * FROM heartbeat.v_responses where messageid = @messageID;

===Getting Specific Status===
SELECT heartbeat.f_message_init('<uuid_handle>') INTO @messageID;
SELECT heartbeat.f_message_attach_data(@messageID, 'Input', 'ReplikwandoDataObject', 'REPLIKWANDO_STATUS_OBJECT_STARTED_AT');
SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_REQUEST_STATUS', 'True', 'True');

===Restarting Replikwando===
SELECT heartbeat.f_message_init('<uuid_handle>') INTO @messageID;
SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_RESTART', 'False', 'False');

===Updating Replikwando===
SELECT heartbeat.f_message_init('<uuid_handle>') INTO @messageID;
SELECT heartbeat.f_message_attach_data(@messageID, 'Input', 'PostBack', 'True');
SELECT heartbeat.f_message_attach_data(@messageID, 'Input', 'IsService', 'False');
CREATE TEMPORARY TABLE t_update_data(`data` MEDIUMBLOB);
<insert the file blob data into `t_update_data`.`data`>
SELECT heartbeat.f_message_attach_data(1446, 'Input', 'data', `data`) FROM t_update_data;
SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_UPDATE', 'True', 'False');

← Older revision		Revision as of 16:15, 31 December 2010
Line 96:		Line 96:
	===Getting Status===		===Getting Status===
	SELECT heartbeat.f_message_init('<uuid_handle>') INTO @messageID;		SELECT heartbeat.f_message_init('<uuid_handle>') INTO @messageID;

	SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_REQUEST_STATUS', 'False', 'True');		SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_REQUEST_STATUS', 'False', 'True');

	SELECT * FROM heartbeat.v_responses where messageid = @messageID;		SELECT * FROM heartbeat.v_responses where messageid = @messageID;

	===Getting Specific Status===		===Getting Specific Status===
	SELECT heartbeat.f_message_init('<uuid_handle>') INTO @messageID;		SELECT heartbeat.f_message_init('<uuid_handle>') INTO @messageID;

	SELECT heartbeat.f_message_attach_data(@messageID, 'Input', 'ReplikwandoDataObject', 'REPLIKWANDO_STATUS_OBJECT_STARTED_AT');		SELECT heartbeat.f_message_attach_data(@messageID, 'Input', 'ReplikwandoDataObject', 'REPLIKWANDO_STATUS_OBJECT_STARTED_AT');

	SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_REQUEST_STATUS', 'True', 'True');		SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_REQUEST_STATUS', 'True', 'True');

	===Restarting Replikwando===		===Restarting Replikwando===
	SELECT heartbeat.f_message_init('<uuid_handle>') INTO @messageID;		SELECT heartbeat.f_message_init('<uuid_handle>') INTO @messageID;

	SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_RESTART', 'False', 'False');		SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_RESTART', 'False', 'False');

	===Updating Replikwando===		===Updating Replikwando===
	SELECT heartbeat.f_message_init('<uuid_handle>') INTO @messageID;		SELECT heartbeat.f_message_init('<uuid_handle>') INTO @messageID;

	SELECT heartbeat.f_message_attach_data(@messageID, 'Input', 'Version', '<version>');		SELECT heartbeat.f_message_attach_data(@messageID, 'Input', 'Version', '<version>');

	SELECT heartbeat.f_message_attach_data(@messageID, 'Input', 'IsService', 'False');		SELECT heartbeat.f_message_attach_data(@messageID, 'Input', 'IsService', 'False');

	CREATE TEMPORARY TABLE t_update_data(`data` MEDIUMBLOB);		CREATE TEMPORARY TABLE t_update_data(`data` MEDIUMBLOB);

	<insert the file blob data into `t_update_data`.`data`>		<insert the file blob data into `t_update_data`.`data`>

	SELECT heartbeat.f_message_attach_data(1446, 'Input', 'data', `data`) FROM t_update_data;		SELECT heartbeat.f_message_attach_data(1446, 'Input', 'data', `data`) FROM t_update_data;

	SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_UPDATE', 'True', 'False');		SELECT heartbeat.f_message_post(@messageID, 'REPLIKWANDO_MESSAGE_UPDATE', 'True', 'False');