Platforms to show: All Mac Windows Linux Cross-Platform
Back to RabbitMQConnectionMBS class.
RabbitMQConnectionMBS.QueueDelete(channel as Integer, queue as String, ifUnused as Boolean, ifEmpty as Boolean) as Dictionary
Function:
Delete a queue.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | RabbitMQ | MBS RabbitMQ Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
RabbitMQConnectionMBS.QueuePurge(channel as Integer, queue as String) as Dictionary
Function:
Purge a queue.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | RabbitMQ | MBS RabbitMQ Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
RabbitMQConnectionMBS.QueueUnbind(channel as Integer, queue as String, exchange as String, routingKey as String, arguments as Dictionary) as Dictionary
Function:
Unbind a queue.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | RabbitMQ | MBS RabbitMQ Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Some examples using this method:
RabbitMQConnectionMBS.ReadMessage(channel as Integer, byref message as RabbitMQMessageMBS, flags as Integer = 0) as RabbitMQRPCReplyMBS
Function:
Reads the next message on a channel
Notes:
Reads a complete message (header + body) on a specified channel. This function is intended to be used with amqp_basic_get() or when an AMQP_BASIC_DELIVERY_METHOD method is received.
channel: the channel on which to read the message from
message: The parameter receiving the message.
flags: currently unused.
Returns RabbitMQRPCReplyMBS, which may contain error information.
Type of the object is RabbitMQRPCReplyMBS.ResponseTypeNormal on success.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | RabbitMQ | MBS RabbitMQ Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
Reads a complete message (header + body) on a specified channel. This function is intended to be used with amqp_basic_get() or when an AMQP_BASIC_DELIVERY_METHOD method is received.
channel: the channel on which to read the message from
message: The parameter receiving the message.
flags: currently unused.
Returns RabbitMQRPCReplyMBS, which may contain error information.
Type of the object is RabbitMQRPCReplyMBS.ResponseTypeNormal on success.
RabbitMQConnectionMBS.SendHeader as Integer
Function:
Send initial AMQP header to the broker.
Notes:
This is a low level function intended for those who want to interact with the broker at a very low level. Use of this function without understanding what it does will result in AMQP protocol errors.
This function sends the AMQP protocol header to the broker.
Returns error code, kStatusOK on success, a negative value on failure. Possible error codes:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | RabbitMQ | MBS RabbitMQ Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
This is a low level function intended for those who want to interact with the broker at a very low level. Use of this function without understanding what it does will result in AMQP protocol errors.
This function sends the AMQP protocol header to the broker.
Returns error code, kStatusOK on success, a negative value on failure. Possible error codes:
- kStatusConnectionClosed: the connection to the broker was closed.
- kStatusSocketError: a socket error occurred. It is likely the underlying socket has been closed. errno or WSAGetLastError() may provide further information.
- kStatusSSLError: a SSL error occurred. The connection to the broker was closed.
RabbitMQConnectionMBS.SetCACert(File as FolderItem) as Boolean
Function:
Sets CACert file with root certificates.
Notes: Returns true on success and false on failure.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | RabbitMQ | MBS RabbitMQ Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: Returns true on success and false on failure.
See also:
RabbitMQConnectionMBS.SetCACert(Path as String) as Boolean
Function:
Sets CACert file with root certificates.
Notes: Returns true on success and false on failure.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | RabbitMQ | MBS RabbitMQ Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: Returns true on success and false on failure.
See also:
RabbitMQConnectionMBS.SetKey(CertFile as FolderItem, KeyFile as FolderItem) as Boolean
Function:
Sets SSL key with certificate file path and key file path.
Notes: Returns true on success and false on failure.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | RabbitMQ | MBS RabbitMQ Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: Returns true on success and false on failure.
See also:
RabbitMQConnectionMBS.SetKey(CertPath as String, KeyPath as String) as Boolean
Function:
Sets SSL key with certificate file path and key file path.
Notes: Returns true on success and false on failure.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | RabbitMQ | MBS RabbitMQ Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: Returns true on success and false on failure.
See also:
RabbitMQConnectionMBS.SetKeyData(CertFile as FolderItem, KeyData as String) as Boolean
Function:
Sets SSL key with certificate file and key data as PEM.
Notes: Returns true on success and false on failure.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | RabbitMQ | MBS RabbitMQ Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: Returns true on success and false on failure.
See also:
RabbitMQConnectionMBS.SetKeyData(CertPath as String, KeyData as String) as Boolean
Function:
Sets SSL key with certificate file and key data as PEM.
Notes: Returns true on success and false on failure.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | RabbitMQ | MBS RabbitMQ Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: Returns true on success and false on failure.
See also:
RabbitMQConnectionMBS.SimpleWaitFrame(byref Frame as RabbitMQFrameMBS, timeoutValue as double = 30) as Integer
Function:
Read a single frame with a timeout.
Notes:
Waits for the next frame to be read from the broker, up to a timespan specified by tv. The function will return kStatusTimeout if the timeout is reached. The tv value is not modified by the function.
The library may buffer frames. When an connection object has frames buffered calling SimpleWaitFrame_noblock() will return an frame without entering a blocking read(). You can test to see if an connection object has frames buffered by calling the FramesEnqueued() function.
The library has a socket read buffer. When there is data in an connection read buffer, SimpleWaitFrame() may return an frame without entering a blocking read(). You can test to see if an connection object has data in its read buffer by calling the DataInBuffer() function.
This function does not return heartbeat frames. When enabled, heartbeating is handed internally internally by the library.
Frame: receives decoded frame the frame
timeoutValue: the maximum time to wait for a frame to be read in seconds. Setting
to 0 will do a non-blocking read.
Returns kStatusOK on success. An kStatus value is returned otherwise. Possible errors include:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | RabbitMQ | MBS RabbitMQ Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
Waits for the next frame to be read from the broker, up to a timespan specified by tv. The function will return kStatusTimeout if the timeout is reached. The tv value is not modified by the function.
The library may buffer frames. When an connection object has frames buffered calling SimpleWaitFrame_noblock() will return an frame without entering a blocking read(). You can test to see if an connection object has frames buffered by calling the FramesEnqueued() function.
The library has a socket read buffer. When there is data in an connection read buffer, SimpleWaitFrame() may return an frame without entering a blocking read(). You can test to see if an connection object has data in its read buffer by calling the DataInBuffer() function.
This function does not return heartbeat frames. When enabled, heartbeating is handed internally internally by the library.
Frame: receives decoded frame the frame
timeoutValue: the maximum time to wait for a frame to be read in seconds. Setting
to 0 will do a non-blocking read.
Returns kStatusOK on success. An kStatus value is returned otherwise. Possible errors include:
- kStatusTimeout the timeout was reached while waiting for a frame from the broker.
- kStatusInvalidParameter the tv parameter contains an invalid value.
- kStatusNoMemory failure in allocating memory. The library is likely in an indeterminate state making recovery unlikely. Client should note the error and terminate the application
- kStatusBadAMQPData bad AMQP data was received. The connection should be shutdown immediately
- kStatusUnknownMethod: an unknown method was received from the broker. This is likely a protocol error and the connection should be shutdown immediately
- kStatusUnknownClass: a properties frame with an unknown class was received from the broker. This is likely a protocol error and the connection should be shutdown immediately
- kStatusHeartbeatTimeout: timed out while waiting for heartbeat from the broker. The connection has been closed.
- kStatusTimerFailure: system timer indicated failure.
- kStatusSocketError: a socket error occurred. The connection has been closed
- kStatusSSLError: a SSL socket error occurred. The connection has been closed.
Some examples using this method:
RabbitMQConnectionMBS.TXCommit(channel as Integer) as Dictionary
Function:
Commit.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | RabbitMQ | MBS RabbitMQ Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
RabbitMQConnectionMBS.TXRollback(channel as Integer) as Dictionary
Function:
Rollback.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | RabbitMQ | MBS RabbitMQ Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
RabbitMQConnectionMBS.TXSelect(channel as Integer) as Dictionary
Function:
Select.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | RabbitMQ | MBS RabbitMQ Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The items on this page are in the following plugins: MBS RabbitMQ Plugin.
