Net::ST...nection(3)

🎀 NAME 🎀

Net::STOMP::Client::Connection — connection support for Net::STOMP::Client.

Okay bestie, this page is Net::STOMP::Client::Connection(3), straight from the User Contributed Perl Documentation shelf. It’s literally the connection-support module for Net::STOMP::Client.

---

💖 DESCRIPTION 💖

This module provides connection establishment support — both plain TCP and SSL — as well as URI handling. It’s the little backend gremlin that makes the connection part work.

🚨 It is used internally by Net::STOMP::Client and should not be directly used elsewhere. Respect the internal-use warning, bestie.

---

🛠️ FUNCTIONS 🛠️

This module provides the following function (which is not exported):

• new([OPTIONS]) — attempt to establish a new connection to a STOMP server.

---

🔐 SSL 🔐

When creating an object with Net::STOMP::Client's new() method, SSL gets activated in either of these cases:

• you supply some socket options (via sockopts) with a name starting with SSL_, or
• you supply a URI (via uri) with a scheme containing ssl.

In those cases, IO::Socket::SSL will be used to create the socket instead of IO::Socket::INET, and the communication with the server will then go through SSL. It’s giving secure-channel main character energy 💅.

Here are the most commonly used SSL socket options:

• SSL_ca_path — path to a directory containing several trusted certificates as separate files as well as an index of the certificates.
• SSL_key_file — path of your RSA private key.
• SSL_cert_file — path of your certificate.
• SSL_passwd_cb — subroutine that should return the password required to decrypt your private key.

For more information, see IO::Socket::SSL.

---

🌈 FAILOVER 🌈

The uri option of Net::STOMP::Client's new() method can be given a complex URI indicating some kind of failover, for instance:

failover:(tcp://msg01:6163,tcp://msg02:6163)

The given URI must use the ActiveMQ failover syntax (see <http://activemq.apache.org/failover-transport-reference.html>) and only some options are supported, namely:

• backOffMultiplier
• initialReconnectDelay
• maxReconnectAttempts
• maxReconnectDelay
• randomize
• useExponentialBackOff

When specified, these failover options will be used only inside the new() method (so at the TCP connection level) and not elsewhere. If the broker later fails during the STOMP interaction, it is up to the program author, knowing the logic of their code, to perform the appropriate recovery actions and eventually reconnect, using again the new() method.

---

👀 SEE ALSO 👀

• IO::Socket::INET
• IO::Socket::SSL
• Net::STOMP::Client

---

👑 AUTHOR 👑

Lionel Cons <http://cern.ch/lionel.cons>

Copyright (C) CERN 2010-2017

---

Okay bye bestie, the footer tea is: perl v5.32.1, dated 2019-07-26, and the footer label is Net::ST...nection(3) 💅✨🫶