Home > Development
  Developer Reference

   Home : Developer Reference

1 2 3 4 5 6 7 8 9 10

AOS commands

Command sqOpen
Syntax: http://www.afteroffice.com/sqopen.user.mms?da=DAName
Parameters:da: The name of the DA. AOS will look up the DA
database for this name, compare the IP from the host making the
query from.
Use: DA send this command to AOS to notify that the DA host is
available to handle user query. It is an authentication process for
AOS to recognise the DA as well.
Return:"true" if the DAName is recognise and the IP verification
correct. "false" if either one not regconise.
See also: sqClose,sqIdle

Command sqClose
Syntax: http://www.afteroffice.com/sqclose.user.mms
Parameters: none
Use:Tells the AOS to stop directing user query to DA. Use before
DA host performing a restart or some major upgrade.
Return:"true" if the sqOpen was successful, "false" if the
connection between DA and AOS has never established.
See also: sqClose,sqOpen

Command sqIdle
Syntax: http://www.afteroffice.com/sqIdle.user.mms
Parameters: none
Use:Tell the AOS that the DA is on idle. It it necessary to invoke
this query on the following situation:-
- the DA has been idle, not sending any query to AOS for more than
an hour.
- the DA is AOS call-back compatible, and ready to process the AOS
non-critical instructions (garbage collection or other tasks).
Note that AOS has a habit to "forget" the availability of DA after 2
hours (120 minutes) of inactivity (the DA fail to query the AOS with
any command in 2 hours). sqClose will be invoked by AOS after DA
time-out. The DA will have to initiate sqOpen again if AOS closes the
DA. It is a good practice to send sqIdle to AOS every hour to ensure
the connectivity. However, DA should not send the sqIdle query to
AOS if there is enough traffic to keep the AOS acknowledge that the
DA is alive.
Return:"true" if the sqOpen was successful, "false" if the
connection between DA and AOS has never established.
See also: sqClose,sqOpen