TsgcWSPClient_STOMP_ActiveMQ is the STOMP client tuned for Apache ActiveMQ. It adds queue and topic helpers over ActiveMQ's destination naming, typed header objects on every event, and an ActiveMQ_Options property for the broker-specific settings that durable subscriptions need.
Everything in the generic STOMP client still applies. The additions are the destination helpers, the ActiveMQ-named events and the broker options.
TsgcWSPClient_STOMP_ActiveMQ
STOMP 1.0, 1.1 and 1.2
TCP (61613) or TLS (61612)
Delphi, C++ Builder
Transport: plain TCP and TLS. sgcMQ talks to ActiveMQ over plain TCP and TLS. ActiveMQ's STOMP-over-WebSocket connector is a WebSocket endpoint, so reaching it requires a sgcWebSockets package, which provides the WebSocket client.
This sample uses ActiveMQ's native STOMP port, 61613. For an encrypted link, switch on TLS on the carrier and use the broker's stomp+ssl connector on port 61612.
uses
sgcTCP_Client_WS, sgcWebSocket_Classes, sgcWebSocket_Protocols,
sgcWebSocket_Protocol_STOMP_Broker_Client,
sgcWebSocket_Protocol_STOMP_ActiveMQ_Client;
var
TCPClient: TsgcTCPClient;
STOMP: TsgcWSPClient_STOMP_ActiveMQ;
begin
TCPClient := TsgcTCPClient.Create(nil);
TCPClient.Host := 'broker.example.com';
TCPClient.Port := 61613;
STOMP := TsgcWSPClient_STOMP_ActiveMQ.Create(nil);
STOMP.Client := TCPClient;
STOMP.ActiveMQ_Options.ClientId := 'delphi-consumer-1';
STOMP.Authentication.Enabled := True;
STOMP.Authentication.UserName := 'admin';
STOMP.Authentication.Password := 'admin';
STOMP.OnActiveMQConnected := ActiveMQConnected;
STOMP.OnActiveMQMessage := ActiveMQMessage;
TCPClient.Active := True;
end;
procedure TForm1.ActiveMQConnected(Connection: TsgcWSConnection;
Headers: TsgcWSActiveMQSTOMPHeadersConnected);
begin
STOMP.SubscribeQueue('orders');
STOMP.PublishQueue('orders', '{"id":42}');
end;
procedure TForm1.ActiveMQMessage(Connection: TsgcWSConnection;
MessageText: string; Headers: TsgcWSActiveMQSTOMPHeadersMessage;
Subscription: TsgcWSBrokerSTOMPSubscriptionItem);
begin
Memo1.Lines.Add(Headers.Destination + ': ' + MessageText);
end;// include: sgcTCP_Client_WS.hpp, sgcWebSocket_Protocols.hpp,
// sgcWebSocket_Protocol_STOMP_ActiveMQ_Client.hpp
TsgcTCPClient *TCPClient = new TsgcTCPClient(this);
TCPClient->Host = "broker.example.com";
TCPClient->Port = 61613;
TsgcWSPClient_STOMP_ActiveMQ *STOMP =
new TsgcWSPClient_STOMP_ActiveMQ(this);
STOMP->Client = TCPClient;
STOMP->ActiveMQ_Options->ClientId = "cbuilder-consumer-1";
STOMP->Authentication->Enabled = true;
STOMP->Authentication->UserName = "admin";
STOMP->Authentication->Password = "admin";
STOMP->OnActiveMQConnected = ActiveMQConnected;
STOMP->OnActiveMQMessage = ActiveMQMessage;
TCPClient->Active = true;
// In the OnActiveMQConnected handler:
STOMP->SubscribeQueue("orders");
STOMP->PublishQueue("orders", "{\"id\":42}");The members you reach for most often.
SubscribeQueue, PublishQueue and UnSubscribeQueue take the plain queue name and build the /queue/ destination, with durable, exclusive and ack-mode arguments.
SubscribeTopic, PublishTopic and UnSubscribeTopic do the same for /topic/ destinations, which is where durable subscriptions matter most.
SubscribeEx, PublishEx and UnSubscribeEx take a raw destination string for anything the named helpers do not cover.
ActiveMQ_Options carries the ActiveMQ-specific settings, including the ClientId the broker uses to recognise a returning durable subscriber.
The subscribe helpers take a Durable flag, so a topic subscriber can disconnect and later collect the messages the broker held for it.
OnActiveMQMessage delivers a TsgcWSActiveMQSTOMPHeadersMessage plus the matching subscription item, so destination, message id and ack mode are properties.
Pass an ack mode when subscribing, then call ACK or NACK with the message id. In ackAuto the broker considers a message delivered as soon as it is sent.
Every publish helper accepts a content type, an optional transaction name and a message-options object for ActiveMQ headers such as priority, persistence and expiration.
Client, Authentication, HeartBeat, Versions and Options behave exactly as they do on the generic STOMP client.
| Online HelpFull API reference and usage guide. | Open | |
| Generic STOMP ClientThe base component with the standard frame set. | Open | |
| AMQP 1.0 ClientActiveMQ Artemis also speaks AMQP 1.0. | Open | |
| Download Free TrialRun against a local ActiveMQ broker. | Open | |
| PricingSingle, Team and Site licenses with full source code. | Open |