Queues
 

Queues are a way of having one pipe client communicate directly with another pipe client in real-time.

Queues names are formed as name@account, where if the account is omitted it is assumed to be the same as the login.

 

Open Queue

Syntax: queue.open "msg id" "queue name"(LF)

Opens a queue.

Results:

  • OK "msg id"(LF)
    Queue has been opened.
  • FAIL "msg id"(LF)
    Unable to open queue.

 

Close queue

Syntax: queue.close "msg id" "queue name"(LF)

Closes the queue.

Results:

  • OK "msg id"(LF)
    The queue has been closed.
  • FAIL "msg id"(LF)
    Unable to close the queue.

 

Send message

Syntax: queue.send "msg id" "queue name" arg1 arg2 ... argn(LF)

Places a message into the queue.

Results:

  • OK "msg id"(LF)
    Message was sent.
  • FAIL "msg id"(LF)
    Unable to send message.

 

Start message receive message

Syntax: queue.startreceive "msg id" "queue name"(LF)

Starts message receive thread. You can receive messages only for queues in your account.

Results:

  • OK "msg id"(LF)
    Thread has been started.
  • FAIL "msg id"(LF)
    Unable to start thread.
  • queue "msg id" "queue name" sender "bill to" arg1 arg2 ... argn(LF)
    This is the format of the special response message. Note that the message isd is the provider's message id, so any responses can pass it back. Also note that the bill to name is included if a third party is to be billed.

 

Stop message receive

Syntax: queue.stopreceive "msg id" "queue name"(LF)

Stops the receipt of messages.

Results:

  • OK "msg id"(LF)
    Thread has been stopped.
  • FAIL "msg id"(LF)
    Unable to stop thread.

 

Next: Transfers