Platforms to show: All Mac Windows Linux Cross-Platform

RabbitMQConnectionMBS.ClientProperties as Dictionary
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Get the client properties table
Notes:
Get the properties that were passed to the broker on connection.
(Read only property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.DataInBuffer as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Check to see if there is data left in the receive buffer.
Notes:
Can be used to see if there is data still in the buffer, if so calling SimpleWaitFrame will not immediately enter a blocking read.

Returns true if there is data in the recieve buffer, false otherwise.
(Read only property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.FramesEnqueued as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Checks to see if there are any incoming frames ready to be read.
Notes:
Checks to see if there are any frame objects buffered by the connection object. Having one or more frames buffered means that SimpleWaitFrame() will return a frame without potentially blocking on a read() call.

Returns true if there are frames enqueued, false otherwise.
(Read only property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.Handle as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The internal object reference.
Notes: (Read and Write property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.HandshakeTimeout as Double
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Get or set the login handshake timeout.
Notes:
Login performs the login handshake with the broker. This function sets the timeout associated with completing this operation from the client side.

The timeout must be set before Login is called to change from the default timeout.

Note that the RabbitMQ broker has a configurable timeout for completing the login handshake, the default is 10 seconds. rabbitmq-c has a default of 12 seconds.
(Read and Write property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.Heartbeat as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Get the number of seconds between heartbeats of the connection.
Notes:
The number of seconds between heartbeats is set when connection negotiation takes place in Login.

Returns the number of seconds between heartbeats.
(Read only property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.MaximumChannel as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Get the maximum number of channels the connection can handle.
Notes:
The maximum number of channels is set when connection negotiation takes
place in Login.

Returns the maximum number of channels. 0 if there is no limit.
(Read only property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.MaximumFrameSize as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Get the maximum size of an frame the connection can handle.
Notes:
The maximum size of an frame is set when connection negotiation takes place in Login.

Return the maximum size in bytes of an frame.
(Read only property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.RPCReply as RabbitMQRPCReplyMBS
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Get the last global RPCReply
Notes:
The API methods corresponding to most synchronous AMQP methods return a pointer to the decoded method result. Upon error, they return nil, and we need some way of discovering what, if anything,
went wrong. RPCReply() returns the most recent RabbitMQRPCReplyMBS instance corresponding to such an API operation for the given connection.

Only use it for operations that do not themselves return RabbitMQRPCReplyMBS; operations that do return RabbitMQRPCReplyMBS generally do NOT update this per-connection-global RabbitMQRPCReplyMBS instance.

Returns the most recent RabbitMQRPCReplyMBS object:

  • Reply.Type = kResponseNormal. Login completed successfully
  • Reply.Type = kResponseLibraryException. In most cases errors from the broker when logging in will be represented by the broker closing the socket. In this case r.libraryError will be set to kStatusConnectionClosed. This error can represent a number of error conditions including: invalid vhost, authentication failure.
  • Reply.Type = kResponseServerException. The broker returned an exception:
  • If Reply.MethodId = kChannelCloseMethod a channel exception occurred, check decoded properties to see details of the exception. The client should SendMethod() a kChannelCloseOkMethod. The channel must be re-opened before it can be used again. Any resources associated with the channel (auto-delete exchanges, auto-delete queues, consumers) are invalid and must be recreated before attempting to use them again.
  • If Reply.MethodId = kConnectionCloseMethod a connection exception occurred, check decoded properties to see details of the exception. The client SendMethod() a kConnectionCloseOkMethod and disconnect from the broker.
(Read only property)

Some examples using this property:

Feedback, Comments & Corrections

RabbitMQConnectionMBS.RPCTimeout as Double
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The RPC timeout.
Notes:
Get or set the RPC timeout.

Sets the timeout for any RPC-style AMQP command (e.g., QueueDeclare).
This timeout may be changed at any time by calling this function with a new
timeout. The timeout applies individually to each RPC that is made.

The default value is 0, or an infinite timeout.

When an RPC times out, the function will return an error kStatusTimeout,
and the connection will be closed.

RPC-timeouts are an advanced feature intended to be used to detect
dead connections quickly when the rabbitmq-c implementation of heartbeats
does not work. Do not use RPC timeouts unless you understand the implications
of doing so.
(Read and Write property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.ServerProperties as Dictionary
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Get the broker properties table.
Notes:
Returns a dictionary containing the properties advertised by the broker on connection.
(Read only property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.SocketFileDescriptor as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Get the socket descriptor in use by a socket object.
Notes:
Retrieve the underlying socket descriptor. This function can be used to perform low-level socket operations that aren't supported by the socket interface. Use with caution!
(Read only property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.SSLCACertPath as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The CA certificate file path.
Notes:
cacert Path to the CA cert file in PEM format.
(Read only property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.SSLCertPath as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The certificate file path.
Notes:
Cert file in PEM format.
(Read only property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.SSLKeyData as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The client key.
Notes:
A buffer containing client key in PEM format.
(Read only property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.SSLKeyPath as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The file path to the SSL key.
Notes: (Read only property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.SSLMaxVersion as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Maximum allowed SSL version.
Notes:
Defaults to latest TLS version.
(Read and Write property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.SSLMinVersion as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Minimum allowed SSL version.
Notes:
Defaults to TLS v1.0.
(Read and Write property)

Feedback, Comments & Corrections

RabbitMQConnectionMBS.SSLVerifyHostname as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Enable or disable hostname verification.
Notes:
Hostname verification checks the broker cert for a CN or SAN that matches the hostname that OpenSocket() is presented.
Peer verification is controlled by SSLVerifyPeer property.
(Read and Write property)

Some examples using this property:

Feedback, Comments & Corrections

RabbitMQConnectionMBS.SSLVerifyPeer as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
property RabbitMQ MBS RabbitMQ Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Enable or disable peer verification.
Notes:
Peer verification validates the certificate chain that is sent by the broker.
Hostname validation is controlled by SSLVerifyHostname.
(Read and Write property)

Some examples using this property:

Feedback, Comments & Corrections

The items on this page are in the following plugins: MBS RabbitMQ Plugin.

The biggest plugin in space...




Links
MBS Xojo tutorial videos

Start Chat