Studio:AutoScript Messages - Revision history

Timd at 16:06, 21 August 2009

2009-08-21T16:06:56Z

← Older revision		Revision as of 16:06, 21 August 2009
Line 230:		Line 230:


	[[Category: AutoScript]]		[[Category:Studio:AutoScript]]

Timd: moved AutoScript Messages to Studio:AutoScript Messages

2009-08-21T16:05:59Z

moved AutoScript Messages to Studio:AutoScript Messages

← Older revision	Revision as of 16:05, 21 August 2009
(No difference)

Ivailop: /* Two-Way Messaging Process */

2008-12-12T00:45:34Z

Two-Way Messaging Process

← Older revision		Revision as of 00:45, 12 December 2008
Line 76:		Line 76:
	1. The Message User script constructs a Command Payload [[AutoScript_Dynamic_Objects\|Dynamic Object]].<br>		1. The Message User script constructs a Command Payload [[AutoScript_Dynamic_Objects\|Dynamic Object]].<br>
	2. The Message User script makes a call (SendAndRead or SendCmd) to send the Command Payload to the Message Owner script.<br>		2. The Message User script makes a call (SendAndRead or SendCmd) to send the Command Payload to the Message Owner script.<br>
	3. The Message User script:		3. The Message User script:<br>
	3.1. in case of SendAndRead blocks and if the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown.<br>		3.1. in case of SendAndRead blocks and if the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown.<br>
	3.2. or explicitly would need to read an event from its event queue using [[AutoScript_Events#WaitForEvent\|WaitForEvent()]].<br>		3.2. or explicitly would need to read an event from its event queue using [[AutoScript_Events#WaitForEvent\|WaitForEvent()]].<br>

Ivailop: /* Two-Way Messaging Process */

2008-12-12T00:45:19Z

Two-Way Messaging Process

← Older revision		Revision as of 00:45, 12 December 2008
Line 76:		Line 76:
	1. The Message User script constructs a Command Payload [[AutoScript_Dynamic_Objects\|Dynamic Object]].<br>		1. The Message User script constructs a Command Payload [[AutoScript_Dynamic_Objects\|Dynamic Object]].<br>
	2. The Message User script makes a call (SendAndRead or SendCmd) to send the Command Payload to the Message Owner script.<br>		2. The Message User script makes a call (SendAndRead or SendCmd) to send the Command Payload to the Message Owner script.<br>
	3. The Message User script ~~blocks (~~in case of SendAndRead and ~~may throw an exception~~ if the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time) or explicitly would need to read an event from its event queue using [[AutoScript_Events#WaitForEvent\|WaitForEvent()]].<br>		3. The Message User script:
			3.1. in case of SendAndRead blocks and if the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown.<br>
			3.2. or explicitly would need to read an event from its event queue using [[AutoScript_Events#WaitForEvent\|WaitForEvent()]].<br>
	4. The Message Owner script processes the Command Payload.<br>		4. The Message Owner script processes the Command Payload.<br>
	5. The Message Owner script performs some processing.<br>		5. The Message Owner script performs some processing.<br>

Ivailop: /* Two-Way Messaging Process */

2008-12-12T00:43:23Z

Two-Way Messaging Process

← Older revision		Revision as of 00:43, 12 December 2008
Line 76:		Line 76:
	1. The Message User script constructs a Command Payload [[AutoScript_Dynamic_Objects\|Dynamic Object]].<br>		1. The Message User script constructs a Command Payload [[AutoScript_Dynamic_Objects\|Dynamic Object]].<br>
	2. The Message User script makes a call (SendAndRead or SendCmd) to send the Command Payload to the Message Owner script.<br>		2. The Message User script makes a call (SendAndRead or SendCmd) to send the Command Payload to the Message Owner script.<br>
	3. The Message User script blocks (in case of SendAndRead) or explicitly would need to read an event from its event queue using [[AutoScript_Events#WaitForEvent\|WaitForEvent()]].<br>		3. The Message User script blocks (in case of SendAndRead and may throw an exception if the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time) or explicitly would need to read an event from its event queue using [[AutoScript_Events#WaitForEvent\|WaitForEvent()]].<br>
	4. The Message Owner script processes the Command Payload.<br>		4. The Message Owner script processes the Command Payload.<br>
	5. The Message Owner script performs some processing.<br>		5. The Message Owner script performs some processing.<br>

Stevel at 19:20, 21 August 2008

2008-08-21T19:20:54Z

Stevel at 17:41, 20 August 2008

2008-08-20T17:41:53Z

← Older revision		Revision as of 17:41, 20 August 2008
Line 8:		Line 8:

	=== Message User ===		=== Message User ===
	A [[~~ascript~~#ascript.Messages.Item.User\|Message User]] may be any script that is not registered as the message owner or message override owner. The [[~~ascript~~#ascript.Messages.Item.User\|Message User]] may be access via the message as [[~~ascript~~#ascript.Messages.Item.User\|ascript.Messages.Item.User]].		A [[AutoScript#ascript.Messages.Item.User\|Message User]] may be any script that is not registered as the message owner or message override owner. The [[AutoScript#ascript.Messages.Item.User\|Message User]] may be access via the message as [[AutoScript#ascript.Messages.Item.User\|ascript.Messages.Item.User]].
	<br>		<br>

	=== Message Owner ===		=== Message Owner ===
	The [[~~ascript~~#ascript.Messages.Item.Owner\|Message Owner]] is the script that has successfully registered itself as the owner of the message (by calling the Register method). A message will only have one registered owner. Calls to register a second owner will result in an exception will be thrown. Ownership can be surrendered by calling the Unregister method (or by exiting the script that registered ownership). The [[~~ascript~~#ascript.Messages.Item.Owner\|Message Owner]] may be accessed via [[~~ascript~~#ascript.Messages.Item.Owner\|ascript.Messages.Item.Owner]].		The [[AutoScript#ascript.Messages.Item.Owner\|Message Owner]] is the script that has successfully registered itself as the owner of the message (by calling the Register method). A message will only have one registered owner. Calls to register a second owner will result in an exception will be thrown. Ownership can be surrendered by calling the Unregister method (or by exiting the script that registered ownership). The [[AutoScript#ascript.Messages.Item.Owner\|Message Owner]] may be accessed via [[AutoScript#ascript.Messages.Item.Owner\|ascript.Messages.Item.Owner]].
	<br>		<br>

Line 23:		Line 23:
	<br>		<br>

	These payloads are defined as properties for both a [[~~ascript~~#ascript.Messages.Item.User\|Message User]] and a [[~~ascript~~#ascript.Messages.Item.Owner\|Message Owner]]. By being part of both user and owner allows their values can be checked for validity in the event that a message didn't make it from user to owner (or visa-versa).		These payloads are defined as properties for both a [[AutoScript#ascript.Messages.Item.User\|Message User]] and a [[AutoScript#ascript.Messages.Item.Owner\|Message Owner]]. By being part of both user and owner allows their values can be checked for validity in the event that a message didn't make it from user to owner (or visa-versa).
	<br>		<br>

Stevel at 18:48, 16 August 2008

2008-08-16T18:48:45Z

Ivailop: /* Message User Methods */

2008-08-06T00:47:14Z

Message User Methods

← Older revision		Revision as of 00:47, 6 August 2008
Line 226:		Line 226:
	\| align="center" \| [[Image:Send_output.jpg]]		\| align="center" \| [[Image:Send_output.jpg]]
	\|}		\|}


			[[Category: AutoScript]]

Ivailop: Messaging moved to AutoScript Messages

2008-08-06T00:46:49Z

Messaging moved to AutoScript Messages

← Older revision	Revision as of 00:46, 6 August 2008
(No difference)

← Older revision		Revision as of 19:20, 21 August 2008
Line 35:		Line 35:
	2. The payload is logged onto the receiving script's event queue.<br>		2. The payload is logged onto the receiving script's event queue.<br>
	3. The initiator script continues processing.<br>		3. The initiator script continues processing.<br>
	4. Later the receiving script makes a call to [[~~Events~~#WaitForEvent\|WaitForEvent]] to processing the payload.<br>		4. Later the receiving script makes a call to [[AutoScript_Events#WaitForEvent\|WaitForEvent]] to processing the payload.<br>
	<br>		<br>
	The initiator script was not blocked from continuing processing. <br>		The initiator script was not blocked from continuing processing. <br>
Line 55:		Line 55:
	3. The Message Owner script makes a call to Broadcast() to broadcast its Response Payload. <br>		3. The Message Owner script makes a call to Broadcast() to broadcast its Response Payload. <br>
	4. The Response Payload is placed on the event queue of each of its subscribers. <br>		4. The Response Payload is placed on the event queue of each of its subscribers. <br>
	5. The Message User script may retrieve messages from its event queue by calling [[~~Events~~#WaitForEvent\|WaitForEvent()]].<br>		5. The Message User script may retrieve messages from its event queue by calling [[AutoScript_Events#WaitForEvent\|WaitForEvent()]].<br>
	6. When the Message User script is finished listening for messages, a call to Unsubscribe() is made to cease receiving messages.<br>		6. When the Message User script is finished listening for messages, a call to Unsubscribe() is made to cease receiving messages.<br>
	<br>		<br>
Line 76:		Line 76:
	1. The Message User script constructs a Command Payload [[AutoScript_Dynamic_Objects\|Dynamic Object]].<br>		1. The Message User script constructs a Command Payload [[AutoScript_Dynamic_Objects\|Dynamic Object]].<br>
	2. The Message User script makes a call (SendAndRead or SendCmd) to send the Command Payload to the Message Owner script.<br>		2. The Message User script makes a call (SendAndRead or SendCmd) to send the Command Payload to the Message Owner script.<br>
	3. The Message User script blocks (in case of SendAndRead) or explicitly would need to read an event from its event queue using [[~~Events~~#WaitForEvent\|WaitForEvent()]].<br>		3. The Message User script blocks (in case of SendAndRead) or explicitly would need to read an event from its event queue using [[AutoScript_Events#WaitForEvent\|WaitForEvent()]].<br>
	4. The Message Owner script processes the Command Payload.<br>		4. The Message Owner script processes the Command Payload.<br>
	5. The Message Owner script performs some processing.<br>		5. The Message Owner script performs some processing.<br>
Line 100:		Line 100:
	3. The Command Payload is logged onto the event queue for the Message Owner script.<br>		3. The Command Payload is logged onto the event queue for the Message Owner script.<br>
	4. The Message User script continues processing.<br>		4. The Message User script continues processing.<br>
	5. The Message Owner script eventually reads an event from its event queue using [[~~Events~~#WaitForEvent\|WaitForEvent()]].<br>		5. The Message Owner script eventually reads an event from its event queue using [[AutoScript_Events#WaitForEvent\|WaitForEvent()]].<br>
	6. The Message Owner script formulates a Response Payload.<br>		6. The Message Owner script formulates a Response Payload.<br>
	7. The Message Owner makes a call (SendRsp) to send its Response Payload to the Message User script.<br>		7. The Message Owner makes a call (SendRsp) to send its Response Payload to the Message User script.<br>
	8. The Response Payload is logged onto the event queue for the Message User script.<br>		8. The Response Payload is logged onto the event queue for the Message User script.<br>
	9. The Message User eventually reads an event from its event queue using [[~~Events~~#WaitForEvent\|WaitForEvent()]].<br>		9. The Message User eventually reads an event from its event queue using [[AutoScript_Events#WaitForEvent\|WaitForEvent()]].<br>
	<br>		<br>

← Older revision		Revision as of 18:48, 16 August 2008
Line 20:		Line 20:

	== Message Payloads ==		== Message Payloads ==
	Payloads are [[~~Dynamic Objects~~\|Dynamic Objects]] containing data related to a message. A One-Way Command message may have a Command Payload. A One-Way Response message may have a Response Payload. A Two-Way Message may have both a Command Payload and a Response Payload. The word 'may' is used here because these are the legal conditions of what payloads may exist. For a Command Payload to exist, the captured message must take one or more parameters. For a Response Payload to exist, the captured message must be defined with a response payload.		Payloads are [[AutoScript_Dynamic_Objects\|Dynamic Objects]] containing data related to a message. A One-Way Command message may have a Command Payload. A One-Way Response message may have a Response Payload. A Two-Way Message may have both a Command Payload and a Response Payload. The word 'may' is used here because these are the legal conditions of what payloads may exist. For a Command Payload to exist, the captured message must take one or more parameters. For a Response Payload to exist, the captured message must be defined with a response payload.
	<br>		<br>

Line 74:		Line 74:
	===== Two-Way Messaging Process =====		===== Two-Way Messaging Process =====
	Two-Way Command/Response messaging is synchronous. The process for two-way messages is as follows:<br>		Two-Way Command/Response messaging is synchronous. The process for two-way messages is as follows:<br>
	1. The Message User script constructs a Command Payload [[~~Dynamic Objects~~\|Dynamic Object]].<br>		1. The Message User script constructs a Command Payload [[AutoScript_Dynamic_Objects\|Dynamic Object]].<br>
	2. The Message User script makes a call (SendAndRead or SendCmd) to send the Command Payload to the Message Owner script.<br>		2. The Message User script makes a call (SendAndRead or SendCmd) to send the Command Payload to the Message Owner script.<br>
	3. The Message User script blocks (in case of SendAndRead) or explicitly would need to read an event from its event queue using [[Events#WaitForEvent\|WaitForEvent()]].<br>		3. The Message User script blocks (in case of SendAndRead) or explicitly would need to read an event from its event queue using [[Events#WaitForEvent\|WaitForEvent()]].<br>
Line 96:		Line 96:
	===== One-Way Messaging Process =====		===== One-Way Messaging Process =====
	One-Way Command messaging is asynchronous. The process for One-Way messages is as follows:<br>		One-Way Command messaging is asynchronous. The process for One-Way messages is as follows:<br>
	1. The Message User script constructs a Command Payload [[~~Dynamic Objects~~\|Dynamic Object]].<br>		1. The Message User script constructs a Command Payload [[AutoScript_Dynamic_Objects\|Dynamic Object]].<br>
	2. The Message User script makes a call (SendCmd or SendCmdBypass) to send the Command Payload to the Message Owner.<br>		2. The Message User script makes a call (SendCmd or SendCmdBypass) to send the Command Payload to the Message Owner.<br>
	3. The Command Payload is logged onto the event queue for the Message Owner script.<br>		3. The Command Payload is logged onto the event queue for the Message Owner script.<br>