Sagittarius Users' Reference

(net mq amqp) - AMQP library

Providing APIs for AMQP, Advanced Message Queuing Protocol.

Currently, the library lacks security layer such as TLS and SAML, and transaction support.

Example

Following examples describes how to send and receive messages from remote queues.

(import (rnrs) (net mq amqp api))

;; Sends text message to SAMPLE.QUEUE on localhost:5672
(call-with-amqp-connection "localhost" "5672"
  (lambda (conn)
    (call-with-amqp-session conn
      (lambda (session)
        (let ((sender (create-amqp-sender session "SAMPLE.QUEUE"))
              (message (create-amqp-text-message "Hello AMQP!!")))
          (send-amqp-message sender message)
          (destroy-amqp-sender sender))))))

;; Receives text message from SAMPLE.QUEUE on localhost:5672
(call-with-amqp-connection "localhost" "5672"
  (lambda (conn)
    (call-with-amqp-session conn
      (lambda (session)
        (let* ((receiver (create-amqp-receiver session "SAMPLE.QUEUE"))
               (message (receive-amqp-message receiver)
          (destroy-amqp-sender receiver)
          message)))))))

High level APIs

Function amqp-connection? obj

Returns #t if given obj is AMQP connection. Otherwise #f.

Function open-amqp-connection host port

Creates an AMQP connection object.

Function close-amqp-connection! connection

Closes given AMQP connection.

Function call-with-amqp-connection host port proc

Creates an AMQP connection and pass it to proc. Then returns the result of proc.

The created connection will be closed both proc returns or raises an error. Thus Invoking captured continuation inside of proc would not work.

Function amqp-session? obj

Returns #t if given obj is AMQP session. Otherwise #f.

Function begin-amqp-session! connection

Starts AMQP session on the given connection

Function end-amqp-session! session

Ends given AMQP session.

Function call-with-amqp-connection connection proc

Starts an AMQP session and pass it to proc. Then returns the result of proc.

The stated session will be ended both proc returns or raises an error. Thus Invoking captured continuation inside of proc would not work.

Function amqp-sender? obj

Function amqp-receiver? obj

Returns #t if given obj is AMQP sender and receiver, respectively. Otherwise #f.

Function create-amqp-sender session source-queue

Function create-amqp-receiver session target-queue

Creates an AMQP sender or receiver, respectively.

source-queue and target-queue must be strings and indicating queue names on the remote server.

Function destroy-amqp-sender sender

Function destroy-amqp-receiver receiver

Destory given sender and receiver, respectively.

Function send-amqp-message sender message

Sends message to sender's queue.

message must be am AMQP message object.

Function receive-amqp-message receiver :key (timeout #f)

Receives an AMQP message from receiver's queue.

Keyword argument timeout must be #f or integer. If this is specified then the procedure waits only specified milliseconds.

Function amqp-message? obj

Returns #t if given obj is AMQP message. Otherwise #f.

Function create-amqp-text-message text

Function create-amqp-binary-message data

Function create-amqp-mime-message content-type data

Creates an AMQP text message, binary message and data message, respectively.

text must be a string. data must be a bytevector. content-type must be a string.