Minimalist Queue Services (MQS) - XML-RPC calls definition

Minimalist Queue Services (MQS) - Basic API definition

This document describes the XML-RPC calls available. We hope that in future the API will be available via some other protocol/interface.

valid for MQS version 0.0.9 and higher

mqs.GetMessage

Purpose
mqs.GetMessage permits to retrieve the next message from a specific queue. With a rdbms backend, the message is logically removed from the queue (flagged). With a flat file database backend, the message is really removed from the queue.
Call
mqs.GetMessage(string auth, string queue )
Return value
is the message itself if the queue is not empty.

mqs.GetMessageBulk

Purpose
mqs.GetMessageBulk permits to retrieve the next messages from a specific queue. With a rdbms backend, the messages are logically removed from the queue (flagged). With a flat file database backend, the messages are really removed from the queue.
Call
mqs.GetMessageBulk(string auth, string queue, int maxmessages )
Return value
is an array containing the message(s).

mqs.SubmitMessage

Purpose
mqs.SubmitMessage permits to submit a message into a specific queue.
Call
mqs.SubmitMessage(string auth, string message, string queue, string cid, int priority )
Return value
1 if the message is correctly stored in the queue.

mqs.SubmitMessageBulk

Purpose
mqs.SubmitMessageBulk permits to submit a message into a specific queue.
Call
mqs.SubmitMessageBulk(string auth, array message, string queue, string cid, int priority )
Return value
1 if the messages are correctly stored in the queue.

mqs.DeleteMessage

Purpose
mqs.DeleteMessage call removes the tagged message from a specific queue. The messages are tagged with the mqs.GetMessage call. This is generally used by the queue manager but this can used by some other application if required.
Call
mqs.DeleteMessage(string auth, string queue )
Return value
is the number of deleted messages.

mqs.TestEcho

Purpose
mqs.TestEcho permits to test if the XML-RPC (or any other interface) is working on the mqs server. The procedure is returning the string passed as a parameter.
Call
mqs.TestEcho(string message )

Return value : the message itself.

Sample code

MQS Error Code

MQS url definition

General definition : mqs://protocol/host:port/auth/queue-name/

License

Copyright (C) 2003,2004 Alexandre Dulaunoy <adulau@foo.be>

This program is  free software; you can redistribute  it and/or modify
it under the  terms of the GNU General Public  License as published by
the Free Software Foundation; either  version 2 of the License, or (at
your option) any later version. 

This program  is distributed in the  hope that it will  be useful, but
WITHOUT   ANY  WARRANTY;   without  even   the  implied   warranty  of
MERCHANTABILITY  or FITNESS  FOR A  PARTICULAR PURPOSE.   See  the GNU
General Public License for more details. 

You  should have received  a copy  of the  GNU General  Public License
along  with  this  program;  if   not,  write  to  the  Free  Software
Foundation, Inc., 59 Temple Place  - Suite 330, Boston, MA 02111-1307,
USA. 

Main Page

$Id: mqs.Call.wiki,v 1.10 2004/10/10 15:30:39 adulau Exp $


Copyrights (C) 2002,2003,2004 Alexandre Dulaunoy - released under the GNU Free Documentation License without any options