AMQP 1.0

Overview

AMQP (Advanced Message Queuing Protocol) 1.0.0 is a messaging protocol designed for reliable, asynchronous communication between distributed systems. It facilitates the exchange of messages between applications or components in a decoupled manner, allowing them to communicate without direct dependencies. Here's a technical breakdown of some key aspects of AMQP 1.0.0:

At a glance

Features

• Native Delphi implementation with full ANSI/Unicode support.

Technical specification

Main properties

The principal published / public properties used to configure and drive the component. Consult the online help for the full list.

Main methods

The principal public methods exposed by the component.

Public events

The component exposes the following published events; consult the online help for full event-handler signatures.

Quick Start

Drop the component on a form, configure the properties below and activate it. The snippet that follows shows the typical TsgcWSPClient_AMQP1 — Connection configuration sourced from the online help.

Delphi (VCL / FireMonkey)

// Creating AMQP client
    oAMQP := TsgcWSPClient_AMQP1.Create(nil);
    // Setting AMQP authentication options
    oAMQP.AMQPOptions.Authentication.AuthType := amqp1authSASLPlain;
    oAMQP.AMQPOptions.Authentication.Username := 'sgc';
    oAMQP.AMQPOptions.Authentication.Password := 'sgc';
    // Creating WebSocket client
    oClient := TsgcWebSocketClient.Create(nil);
    // Setting WebSocket specifications
    oClient.Specifications.RFC6455 := False;
    // Setting WebSocket client properties
    oClient.Host := 'www.esegece.com';
    oClient.Port := 5671;
    oClient.TLS := True;
    // Assigning WebSocket client to AMQP client
    oAMQP.Client := oClient;
    // Activating WebSocket client
    oClient.Active := True;

C++ Builder

// Creating AMQP client
    oAMQP = new TsgcWSPClient_AMQP1(this);
    // Setting AMQP authentication options
    oAMQP->AMQPOptions->Authentication->AuthType = amqp1authSASLPlain;
    oAMQP->AMQPOptions->Authentication->Username = L"sgc";
    oAMQP->AMQPOptions->Authentication->Password = L"sgc";
    // Creating WebSocket client
    oClient = new TsgcWebSocketClient(this);
    // Setting WebSocket specifications
    oClient->Specifications->RFC6455 = false;
    // Setting WebSocket client properties
    oClient->Host = L"www.esegece.com";
    oClient->Port = 5671;
    oClient->TLS = true;
    // Assigning WebSocket client to AMQP client
    oAMQP->Client = oClient;
    // Activating WebSocket client
    oClient->Active = true;

.NET (C#)

oAMQP = new TsgcWSPClient_AMQP1(this);
    // Setting AMQP authentication options
    oAMQP.AMQPOptions.Authentication.AuthType = amqp1authSASLPlain;
    oAMQP.AMQPOptions.Authentication.Username = "sgc";
    oAMQP.AMQPOptions.Authentication.Password = "sgc";
    // Creating WebSocket client
    oClient = new TsgcWebSocketClient(this);
    // Setting WebSocket specifications
    oClient.Specifications.RFC6455 = false;
    // Setting WebSocket client properties
    oClient.Host = "www.esegece.com";
    oClient.Port = 5671;
    oClient.TLS = true;
    // Assigning WebSocket client to AMQP client
    oAMQP.Client = oClient;
    // Activating WebSocket client
    oClient.Active = true;

Common scenarios

The following scenarios are lifted verbatim from the online help. Each shows the configuration and method calls needed to drive the component through a specific real-world flow.

1 · Client AMQP1 Connect — Basic Usage

Connect to an AMQP 1.0.0 server without authentication. Define the AMQPOptions property values, virtual host and then set in the TsgcWebSocketClient the Host and Port of the server.

// Creating AMQP client
oAMQP := TsgcWSPClient_AMQP1.Create(nil);
// Creating WebSocket client
oClient := TsgcWebSocketClient.Create(nil);
// Setting WebSocket specifications
oClient.Specifications.RFC6455 := False;
// Setting WebSocket client properties
oClient.Host := 'amqp_host_address';
oClient.Port := 5672;
// Assigning WebSocket client to AMQP client
oAMQP.Client := oClient;
// Activating WebSocket client
oClient.Active := True;

// Creating AMQP client
oAMQP = new TsgcWSPClient_AMQP1(this);
// Creating WebSocket client
oClient = new TsgcWebSocketClient(this);
// Setting WebSocket specifications
oClient->Specifications->RFC6455 = false;
// Setting WebSocket client properties
oClient->Host = L"amqp_host_address";
oClient->Port = 5672;
// Assigning WebSocket client to AMQP client
oAMQP->Client = oClient;
// Activating WebSocket client
oClient->Active = true;

oAMQP = new TsgcWSPClient_AMQP1(this);
// Creating WebSocket client
oClient = new TsgcWebSocketClient(this);
// Setting WebSocket specifications
oClient.Specifications.RFC6455 = false;
// Setting WebSocket client properties
oClient.Host = "amqp_host_address";
oClient.Port = 5672;
// Assigning WebSocket client to AMQP client
oAMQP.Client = oClient;
// Activating WebSocket client
oClient.Active = true;

2 · Send Message

Use the method SendMessage passing the Session and SenderLink name to send a text message to the AMQP1 Server. The method has the following parameters:

oAMQP1.SendMessage('MySession', 'MySenderLink', 'My first AMQP Message');

oAMQP1->SendMessage("MySession", "MySenderLink", "My first AMQP Message");

oAMQP1.SendMessage("MySession", "MySenderLink", "My first AMQP Message");

3 · SASL Authentication

The most common authentication is using amqp1authSASLPlain type. This authentication type, can be enabled in the AMQP1 component, accessing to the property AMQPOptions.Authentication.

procedure OnAMQP1SASLAuthentication(Sender: TObject;
  aCode: TsgcAMQP1SaslCode; const aDescription: string; var Handled: Boolean);
begin
  ShowMessage('#sasl-authentication: ' + aDescription);
end;

void __fastcall OnAMQP1SASLAuthentication(System::TObject* Sender, TsgcAMQP1SaslCode aCode,
    const System::UnicodeString aDescription, bool &Handled)
{
  ShowMessage("#sasl-authentication: " + aDescription);
}

public void OnAMQP1SASLAuthentication(object Sender, TsgcAMQP1SaslCode aCode,
	string aDescription, ref bool Handled)
{
  MessageBox.Show("#sasl-authentication: " + aDescription);
}

4 · Sending a Close Reason

The AMQP client can inform the server that the connection will be closed and provide information about the reason why is closing the connection. Use the method Close to request a connection close to the server.

oAMQP.Close('invalid-frame', 'The received frame has an invalid format.');

oAMQP.Close('invalid-frame', "The received frame has an invalid format.");

oAMQP.Close('invalid-frame', "The received frame has an invalid format.");

5 · Create Receiver Link

To Create a new Receiver Link, call the method CreateReceiverLink which contains the following parameters:

oAMQP1.CreateReceiverLink('MySession', 'MyReceiverLink');
procedure procedure TfrmClientAMQP1.AMQP1AMQPLinkOpen(Sender: TObject; const aSession: TsgcAMQP1Session; const aLink: TsgcAMQP1Link; const aAttach: TsgcAMQP1FrameAttach);
begin
  ShowMessage('#link-open: ' + aLink.Name);
end;

oAMQP1->CreateReceiverLink("MySession", "MyReceiverLink");
oAMQP1->OnAMQPLinkOpen = AMQP1AMQPLinkOpen;
void __fastcall TMyForm::AMQP1AMQPLinkOpen(TObject *Sender, TsgcAMQP1Session *const aSession, TsgcAMQP1Link *const aLink, TsgcAMQP1FrameAttach *const aAttach)
{
    ShowMessage("#link-open: " + aLink->Name);
}

oAMQP1.OnAMQPLinkOpen += AMQP1AMQPLinkOpen;
oAMQP1.CreateReceiverLink("MySession", "MyReceiverLink");
private void AMQP1AMQPLinkOpen(object sender, TsgcAMQP1Session aSession, TsgcAMQP1Link aLink, TsgcAMQP1FrameAttach aAttach)
{
    Console.WriteLine("#link-open: " + aLink.Name);
}

6 · Create Sender Link

To Create a new Sender Link, call the method CreateSenderLink which contains the following parameters:

oAMQP1.CreateSenderLink('MySession', 'MySenderLink');
procedure procedure TfrmClientAMQP1.AMQP1AMQPLinkOpen(Sender: TObject; const aSession: TsgcAMQP1Session; const aLink: TsgcAMQP1Link; const aAttach: TsgcAMQP1FrameAttach);
begin
  ShowMessage('#link-open: ' + aLink.Name);
end;

oAMQP1->CreateSenderLink("MySession", "MySenderLink");
oAMQP1->OnAMQPLinkOpen = AMQP1AMQPLinkOpen;
void __fastcall TMyForm::AMQP1AMQPLinkOpen(TObject *Sender, TsgcAMQP1Session *const aSession, TsgcAMQP1Link *const aLink, TsgcAMQP1FrameAttach *const aAttach)
{
    ShowMessage("#link-open: " + aLink->Name);
}

oAMQP1.OnAMQPLinkOpen += AMQP1AMQPLinkOpen;
oAMQP1.CreateSenderLink("MySession", "MySenderLink");
private void AMQP1AMQPLinkOpen(object sender, TsgcAMQP1Session aSession, TsgcAMQP1Link aLink, TsgcAMQP1FrameAttach aAttach)
{
    Console.WriteLine("#link-open: " + aLink.Name);
}

Sources used to build this document

Every external claim links back to a primary source. The online-help references decode the canonical deep-link the company maintains for this component.