# AMQP Component An easy-to-use AMQP 1.0 client implementation. ## Syntax ```text ipworksiot.AMQP ``` ## Remarks The AMQP struct provides an easy-to-use AMQP 1.0 client implementation. The struct supports both plaintext and TLS-enabled connections over TCP. ### Connecting AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions. The struct implements all three layers of the AMQP 1.0 transport protocol, so the first step is to initiate the overall connection. Set the [ContainerId](#containerid-property-amqp-component) property and call the [ConnectTo](#connectto-method-amqp-component) method, passing it the server's hostname and port number. Once connected, the next step is to create at least one session, which can be accomplished by using the [CreateSession](#createsession-method-amqp-component) method. The struct allows creating any number of sessions, up to the limit specified by the [MaxSessionCount](#MaxSessionCount) configuration setting. **Connecting and Creating a Session** ```csharp amqp1.ContainerId = "testClient"; amqp1.ConnectTo("amqp.test-server.com", 5672); amqp1.CreateSession("TestSession"); ``` After creating a session, the next step is to create one or more links (which are created in the context of a session) so that messages can be sent and/or received. Links are unidirectional, so each one has a sender on one end and a receiver on the other. The struct can function both as a sender node (by opening sender links) and as a receiver node (by opening receiver links). But keep in mind that, since the struct is implemented as an AMQP 1.0 *client*, it must be the one to open links (said another way, the struct *cannot* accept any link requests made by other peers). As with sessions, the struct allows creating any number of links for each session, up to the limit specified by the [MaxLinkCountPerSession](#MaxLinkCountPerSession) configuration setting. ### Creating Sender Links To create a sender link, call the [CreateSenderLink](#createsenderlink-method-amqp-component) method, passing it the name of an existing session, a unique name for the link, and (if necessary in your environment) the name of a target for the receiver to use to ensure messages are routed correctly. The [LinkReadyToSend](#linkreadytosend-event-amqp-component) event will fire when the newly created sender link is ready to send messages. **Creating a Sender Link** ```csharp amqp1.OnLinkReadyToSend += (s, e) => { Console.WriteLine("Link '" + e.LinkName + "' is ready to send messages!"); }; amqp1.CreateSenderLink("TestSession", "TestSenderLink", "TestTarget"); ``` ### Sending Messages To send a message, the first step is to set the Message property's properties to the desired values. At minimum, the [MessageValue](#messagevalue-property-amqp-component) and [MessageValueType](#messagevaluetype-property-amqp-component) properties must be set. All other properties are optional, though specifying a unique value for [MessageId](#messageid-property-amqp-component) is recommended. (If the [GenerateMessageId](#GenerateMessageId) configuration setting is enabled, the struct will generate one automatically when the message is sent.) Once the Message property's properties have be assigned as desired, call the [SendMessage](#sendmessage-method-amqp-component) method, passing it the name of an existing sender link on which the message should be sent. The [MessageOut](#messageout-event-amqp-component) event will be fired when the message has been sent (and acknowledged, if [MessageSettled](#messagesettled-property-amqp-component) was set to false). The [MessageOutcome](#messageoutcome-event-amqp-component) event may also fire, if necessary, once the receiver reports the outcome of the message. Refer to [SendMessage](#sendmessage-method-amqp-component), [MessageOut](#messageout-event-amqp-component), and [MessageOutcome](#messageoutcome-event-amqp-component) for more information. **Sending a Message** ```csharp amqp1.OnMessageOut += (s, e) => { Console.WriteLine("Message with Id '" + e.MessageId + "' has been sent on link '" + e.LinkName + "'."); }; amqp1.Message.MessageId = "TestMessageId"; amqp1.Message.Value = "Hello, world!"; amqp1.Message.ValueType = AMQPValueTypes.mvtString; amqp1.SendMessage("TestSenderLink"); ``` The [ResetMessage](#resetmessage-method-amqp-component) method can be used to reset the Message property's properties to their default values. ### Sending Composite AMQP Data The AMQP 1.0 protocol's data model includes the concept of "composite data". Composite data is comprised of one or more type-value pairs (including data structure types), plus a descriptor that describes what the overall data represents. The struct supports sending composite AMQP data in a message through the use of JSON with a well-defined schema. Refer to the [SendMessage](#sendmessage-method-amqp-component) method's documentation for more information and examples. ### Creating Receiver Links Receiver links can operate in one of two receive modes: automatic, where the struct will work to ensure that messages are received as soon as they are available; and retrieve-based, where the struct will only "retrieve" a new message when explicitly instructed to. The [ReceiveMode](#receivemode-property-amqp-component) property controls which receive mode newly-created receiver links will use; refer to its documentation for more information. After ensuring that [ReceiveMode](#receivemode-property-amqp-component) is set as desired, call [CreateReceiverLink](#createreceiverlink-method-amqp-component), passing it the name of an existing session, a unique name for the link, and (if necessary in your environment) the name of a source for the sender to route the link creation request to. **Creating a Receiver Link** ```csharp // Creating an automatic receiver link. amqp1.ReceiveMode = AmqpReceiveModes.rmAutomatic; amqp1.CreateReceiverLink("TestSession", "TestAutoReceiverLink", "TestSource1"); // Creating a retrieve-based receiver link. amqp1.ReceiveMode = AmqpReceiveModes.rmRetrieve; amqp1.CreateReceiverLink("TestSession", "TestRetrieveReceiverLink", "TestSource2"); ``` ### Receiving Messages For receiver links created in automatic receive mode (the default), messages are received automatically. For receiver links created in retrieve-based mode, the struct will attempt to "retrieve" a message each time the [RetrieveMessage](#retrievemessage-method-amqp-component) method is called (optionally timing out after a time, if [RetrieveTimeout](#retrievetimeout-property-amqp-component) is non-zero). When calling [RetrieveMessage](#retrievemessage-method-amqp-component), pass it the name of a retrieve-based receiver link. Regardless of whether a messages is received automatically or retrieved, any incoming message will cause the struct to fire the [MessageIn](#messagein-event-amqp-component) event and update the ReceivedMessage property's properties. When the [MessageIn](#messagein-event-amqp-component) event fires, its *State* event parameter can be used to specify the outcome of the message, which the struct will then transmit back to the sender (as well as self-report by firing the [MessageOutcome](#messageoutcome-event-amqp-component) event). Refer to [MessageIn](#messagein-event-amqp-component) for more information. **Receiving a Message** ```csharp // For automatic receiver links, only the event handler is necessary. amqp1.OnMessageIn += (s, e) => { Console.WriteLine("Message with Id '" + e.MessageId + "' has been received on link '" + e.LinkName + "'. Value:"); Console.WriteLine(amqp1.ReceivedMessage.Value); // The message state is already set to the "Accepted" outcome by default, but we'll set it again // for the purpose of this example. e.State = 0; // 0 = Accepted. }; // For retrieve-based links, it's also necessary to call RetrieveMessage(). It is recommended that the // RetrieveTimeout property be set to a non-zero value (60 seconds is the default) so that the retrieve // request will eventually time out if the sender doesn't have any messages available to deliver. amqp1.RetrieveTimeout = 60; amqp1.RetrieveMessage("TestRetrieveReceiverLink"); ``` ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AuthScheme](#authscheme-property-amqp-component) | The authentication scheme to use when connecting. | | [Connected](#connected-property-amqp-component) | This property indicates whether the class is connected. | | [ContainerId](#containerid-property-amqp-component) | The container Id the class should advertise when connecting. | | [FirewallAutoDetect](#firewallautodetect-property-amqp-component) | Whether to automatically detect and use firewall system settings, if available. | | [FirewallType](#firewalltype-property-amqp-component) | The type of firewall to connect through. | | [FirewallHost](#firewallhost-property-amqp-component) | The name or IP address of the firewall (optional). | | [FirewallPassword](#firewallpassword-property-amqp-component) | A password if authentication is to be used when connecting through the firewall. | | [FirewallPort](#firewallport-property-amqp-component) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [FirewallUser](#firewalluser-property-amqp-component) | A username if authentication is to be used when connecting through a firewall. | | [IdleTimeout](#idletimeout-property-amqp-component) | The maximum period of inactivity the class will allow before disconnecting. | | [IncomingMessageCount](#incomingmessagecount-property-amqp-component) | The number of records in the IncomingMessage arrays. | | [IncomingMessageAbsoluteExpiryTime](#incomingmessageabsoluteexpirytime-property-amqp-component) | The absolute time at which this message should be considered expired. | | [IncomingMessageContentEncoding](#incomingmessagecontentencoding-property-amqp-component) | The content encoding of this message's data. | | [IncomingMessageContentType](#incomingmessagecontenttype-property-amqp-component) | The content type of this message's data. | | [IncomingMessageCorrelationId](#incomingmessagecorrelationid-property-amqp-component) | The correlation Id of this message. | | [IncomingMessageCreationTime](#incomingmessagecreationtime-property-amqp-component) | The creation time of this message. | | [IncomingMessageDeliveryCount](#incomingmessagedeliverycount-property-amqp-component) | How many previous attempts there have been to deliver this message. | | [IncomingMessageDurable](#incomingmessagedurable-property-amqp-component) | Whether this message is durable. | | [IncomingMessageFirstAcquirer](#incomingmessagefirstacquirer-property-amqp-component) | Whether this message may have been acquired by other links previously. | | [IncomingMessageGroupId](#incomingmessagegroupid-property-amqp-component) | The Id of the group this message belongs to. | | [IncomingMessageGroupSequence](#incomingmessagegroupsequence-property-amqp-component) | The position of this message within its group. | | [IncomingMessageLinkName](#incomingmessagelinkname-property-amqp-component) | The name of the link this message is associated with. | | [IncomingMessageId](#incomingmessageid-property-amqp-component) | The unique Id of this message. | | [IncomingMessagePriority](#incomingmessagepriority-property-amqp-component) | The priority of this message. | | [IncomingMessageReplyTo](#incomingmessagereplyto-property-amqp-component) | The address of the node to send replies to for this message. | | [IncomingMessageReplyToGroupId](#incomingmessagereplytogroupid-property-amqp-component) | The Id of the group to send replies to for this message. | | [IncomingMessageSettled](#incomingmessagesettled-property-amqp-component) | Whether this message is settled. | | [IncomingMessageSubject](#incomingmessagesubject-property-amqp-component) | The subject of this message. | | [IncomingMessageTo](#incomingmessageto-property-amqp-component) | The address of the node which this message is intended for. | | [IncomingMessageTTL](#incomingmessagettl-property-amqp-component) | The time-to-live value for this message. | | [IncomingMessageUserId](#incomingmessageuserid-property-amqp-component) | The identity of the user responsible for producing this message. | | [IncomingMessageValue](#incomingmessagevalue-property-amqp-component) | This message's value. | | [IncomingMessageValueType](#incomingmessagevaluetype-property-amqp-component) | This message's value data type. | | [LinkCount](#linkcount-property-amqp-component) | The number of records in the Link arrays. | | [LinkAvailable](#linkavailable-property-amqp-component) | The number of messages which this link's sender could send if it had credit for them. | | [LinkChannelName](#linkchannelname-property-amqp-component) | The channel name this link is using. | | [LinkCredit](#linkcredit-property-amqp-component) | The amount of credit currently available to this link's sender. | | [LinkDeliveryCount](#linkdeliverycount-property-amqp-component) | The current delivery count value for this link. | | [LinkName](#linkname-property-amqp-component) | This link's name. | | [LinkReadyToSend](#linkreadytosend-property-amqp-component) | Whether this link is ready to send a message. | | [LinkReceiveMode](#linkreceivemode-property-amqp-component) | The receive mode this link is operating in. | | [LinkRole](#linkrole-property-amqp-component) | The class's role on this link. | | [LocalHost](#localhost-property-amqp-component) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [LocalPort](#localport-property-amqp-component) | The TCP port in the local host where the class binds. | | [MessageAbsoluteExpiryTime](#messageabsoluteexpirytime-property-amqp-component) | The absolute time at which this message should be considered expired. | | [MessageContentEncoding](#messagecontentencoding-property-amqp-component) | The content encoding of this message's data. | | [MessageContentType](#messagecontenttype-property-amqp-component) | The content type of this message's data. | | [MessageCorrelationId](#messagecorrelationid-property-amqp-component) | The correlation Id of this message. | | [MessageCreationTime](#messagecreationtime-property-amqp-component) | The creation time of this message. | | [MessageDeliveryCount](#messagedeliverycount-property-amqp-component) | How many previous attempts there have been to deliver this message. | | [MessageDurable](#messagedurable-property-amqp-component) | Whether this message is durable. | | [MessageFirstAcquirer](#messagefirstacquirer-property-amqp-component) | Whether this message may have been acquired by other links previously. | | [MessageGroupId](#messagegroupid-property-amqp-component) | The Id of the group this message belongs to. | | [MessageGroupSequence](#messagegroupsequence-property-amqp-component) | The position of this message within its group. | | [MessageLinkName](#messagelinkname-property-amqp-component) | The name of the link this message is associated with. | | [MessageId](#messageid-property-amqp-component) | The unique Id of this message. | | [MessagePriority](#messagepriority-property-amqp-component) | The priority of this message. | | [MessageReplyTo](#messagereplyto-property-amqp-component) | The address of the node to send replies to for this message. | | [MessageReplyToGroupId](#messagereplytogroupid-property-amqp-component) | The Id of the group to send replies to for this message. | | [MessageSettled](#messagesettled-property-amqp-component) | Whether this message is settled. | | [MessageSubject](#messagesubject-property-amqp-component) | The subject of this message. | | [MessageTo](#messageto-property-amqp-component) | The address of the node which this message is intended for. | | [MessageTTL](#messagettl-property-amqp-component) | The time-to-live value for this message. | | [MessageUserId](#messageuserid-property-amqp-component) | The identity of the user responsible for producing this message. | | [MessageValue](#messagevalue-property-amqp-component) | This message's value. | | [MessageValueType](#messagevaluetype-property-amqp-component) | This message's value data type. | | [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) | The number of records in the OutgoingMessage arrays. | | [OutgoingMessageAbsoluteExpiryTime](#outgoingmessageabsoluteexpirytime-property-amqp-component) | The absolute time at which this message should be considered expired. | | [OutgoingMessageContentEncoding](#outgoingmessagecontentencoding-property-amqp-component) | The content encoding of this message's data. | | [OutgoingMessageContentType](#outgoingmessagecontenttype-property-amqp-component) | The content type of this message's data. | | [OutgoingMessageCorrelationId](#outgoingmessagecorrelationid-property-amqp-component) | The correlation Id of this message. | | [OutgoingMessageCreationTime](#outgoingmessagecreationtime-property-amqp-component) | The creation time of this message. | | [OutgoingMessageDeliveryCount](#outgoingmessagedeliverycount-property-amqp-component) | How many previous attempts there have been to deliver this message. | | [OutgoingMessageDurable](#outgoingmessagedurable-property-amqp-component) | Whether this message is durable. | | [OutgoingMessageFirstAcquirer](#outgoingmessagefirstacquirer-property-amqp-component) | Whether this message may have been acquired by other links previously. | | [OutgoingMessageGroupId](#outgoingmessagegroupid-property-amqp-component) | The Id of the group this message belongs to. | | [OutgoingMessageGroupSequence](#outgoingmessagegroupsequence-property-amqp-component) | The position of this message within its group. | | [OutgoingMessageLinkName](#outgoingmessagelinkname-property-amqp-component) | The name of the link this message is associated with. | | [OutgoingMessageId](#outgoingmessageid-property-amqp-component) | The unique Id of this message. | | [OutgoingMessagePriority](#outgoingmessagepriority-property-amqp-component) | The priority of this message. | | [OutgoingMessageReplyTo](#outgoingmessagereplyto-property-amqp-component) | The address of the node to send replies to for this message. | | [OutgoingMessageReplyToGroupId](#outgoingmessagereplytogroupid-property-amqp-component) | The Id of the group to send replies to for this message. | | [OutgoingMessageSettled](#outgoingmessagesettled-property-amqp-component) | Whether this message is settled. | | [OutgoingMessageSubject](#outgoingmessagesubject-property-amqp-component) | The subject of this message. | | [OutgoingMessageTo](#outgoingmessageto-property-amqp-component) | The address of the node which this message is intended for. | | [OutgoingMessageTTL](#outgoingmessagettl-property-amqp-component) | The time-to-live value for this message. | | [OutgoingMessageUserId](#outgoingmessageuserid-property-amqp-component) | The identity of the user responsible for producing this message. | | [OutgoingMessageValue](#outgoingmessagevalue-property-amqp-component) | This message's value. | | [OutgoingMessageValueType](#outgoingmessagevaluetype-property-amqp-component) | This message's value data type. | | [Password](#password-property-amqp-component) | A password to use for SASL authentication. | | [ReadyToSend](#readytosend-property-amqp-component) | Indicates whether the class is ready to send data. | | [ReceivedMessageAbsoluteExpiryTime](#receivedmessageabsoluteexpirytime-property-amqp-component) | The absolute time at which this message should be considered expired. | | [ReceivedMessageContentEncoding](#receivedmessagecontentencoding-property-amqp-component) | The content encoding of this message's data. | | [ReceivedMessageContentType](#receivedmessagecontenttype-property-amqp-component) | The content type of this message's data. | | [ReceivedMessageCorrelationId](#receivedmessagecorrelationid-property-amqp-component) | The correlation Id of this message. | | [ReceivedMessageCreationTime](#receivedmessagecreationtime-property-amqp-component) | The creation time of this message. | | [ReceivedMessageDeliveryCount](#receivedmessagedeliverycount-property-amqp-component) | How many previous attempts there have been to deliver this message. | | [ReceivedMessageDurable](#receivedmessagedurable-property-amqp-component) | Whether this message is durable. | | [ReceivedMessageFirstAcquirer](#receivedmessagefirstacquirer-property-amqp-component) | Whether this message may have been acquired by other links previously. | | [ReceivedMessageGroupId](#receivedmessagegroupid-property-amqp-component) | The Id of the group this message belongs to. | | [ReceivedMessageGroupSequence](#receivedmessagegroupsequence-property-amqp-component) | The position of this message within its group. | | [ReceivedMessageLinkName](#receivedmessagelinkname-property-amqp-component) | The name of the link this message is associated with. | | [ReceivedMessageId](#receivedmessageid-property-amqp-component) | The unique Id of this message. | | [ReceivedMessagePriority](#receivedmessagepriority-property-amqp-component) | The priority of this message. | | [ReceivedMessageReplyTo](#receivedmessagereplyto-property-amqp-component) | The address of the node to send replies to for this message. | | [ReceivedMessageReplyToGroupId](#receivedmessagereplytogroupid-property-amqp-component) | The Id of the group to send replies to for this message. | | [ReceivedMessageSettled](#receivedmessagesettled-property-amqp-component) | Whether this message is settled. | | [ReceivedMessageSubject](#receivedmessagesubject-property-amqp-component) | The subject of this message. | | [ReceivedMessageTo](#receivedmessageto-property-amqp-component) | The address of the node which this message is intended for. | | [ReceivedMessageTTL](#receivedmessagettl-property-amqp-component) | The time-to-live value for this message. | | [ReceivedMessageUserId](#receivedmessageuserid-property-amqp-component) | The identity of the user responsible for producing this message. | | [ReceivedMessageValue](#receivedmessagevalue-property-amqp-component) | This message's value. | | [ReceivedMessageValueType](#receivedmessagevaluetype-property-amqp-component) | This message's value data type. | | [ReceiveMode](#receivemode-property-amqp-component) | Controls what mode new receiver links are created with. | | [RemoteHost](#remotehost-property-amqp-component) | This property includes the address of the remote host. Domain names are resolved to IP addresses. | | [RemotePort](#remoteport-property-amqp-component) | The port of the AMQP server (default is 5672). The default port for SSL is 5671. | | [RetrieveTimeout](#retrievetimeout-property-amqp-component) | How long the class should wait for a message to be received after RetrieveMessage is called. | | [SessionCount](#sessioncount-property-amqp-component) | The number of records in the Session arrays. | | [SessionIncomingWindow](#sessionincomingwindow-property-amqp-component) | The incoming window size of this session. | | [SessionName](#sessionname-property-amqp-component) | The name of this session. | | [SessionOutgoingWindow](#sessionoutgoingwindow-property-amqp-component) | The outgoing window size of this session. | | [SSLAcceptServerCertEffectiveDate](#sslacceptservercerteffectivedate-property-amqp-component) | The date on which this certificate becomes valid. | | [SSLAcceptServerCertExpirationDate](#sslacceptservercertexpirationdate-property-amqp-component) | The date on which the certificate expires. | | [SSLAcceptServerCertExtendedKeyUsage](#sslacceptservercertextendedkeyusage-property-amqp-component) | A comma-delimited list of extended key usage identifiers. | | [SSLAcceptServerCertFingerprint](#sslacceptservercertfingerprint-property-amqp-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLAcceptServerCertFingerprintSHA1](#sslacceptservercertfingerprintsha1-property-amqp-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLAcceptServerCertFingerprintSHA256](#sslacceptservercertfingerprintsha256-property-amqp-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLAcceptServerCertIssuer](#sslacceptservercertissuer-property-amqp-component) | The issuer of the certificate. | | [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-amqp-component) | The private key of the certificate (if available). | | [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-amqp-component) | Whether a PrivateKey is available for the selected certificate. | | [SSLAcceptServerCertPrivateKeyContainer](#sslacceptservercertprivatekeycontainer-property-amqp-component) | The name of the PrivateKey container for the certificate (if available). | | [SSLAcceptServerCertPublicKey](#sslacceptservercertpublickey-property-amqp-component) | The public key of the certificate. | | [SSLAcceptServerCertPublicKeyAlgorithm](#sslacceptservercertpublickeyalgorithm-property-amqp-component) | The textual description of the certificate's public key algorithm. | | [SSLAcceptServerCertPublicKeyLength](#sslacceptservercertpublickeylength-property-amqp-component) | The length of the certificate's public key (in bits). | | [SSLAcceptServerCertSerialNumber](#sslacceptservercertserialnumber-property-amqp-component) | The serial number of the certificate encoded as a string. | | [SSLAcceptServerCertSignatureAlgorithm](#sslacceptservercertsignaturealgorithm-property-amqp-component) | The text description of the certificate's signature algorithm. | | [SSLAcceptServerCertStore](#sslacceptservercertstore-property-amqp-component) | The name of the certificate store for the client certificate. | | [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-amqp-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-amqp-component) | The type of certificate store for this certificate. | | [SSLAcceptServerCertSubjectAltNames](#sslacceptservercertsubjectaltnames-property-amqp-component) | Comma-separated lists of alternative subject names for the certificate. | | [SSLAcceptServerCertThumbprintMD5](#sslacceptservercertthumbprintmd5-property-amqp-component) | The MD5 hash of the certificate. | | [SSLAcceptServerCertThumbprintSHA1](#sslacceptservercertthumbprintsha1-property-amqp-component) | The SHA-1 hash of the certificate. | | [SSLAcceptServerCertThumbprintSHA256](#sslacceptservercertthumbprintsha256-property-amqp-component) | The SHA-256 hash of the certificate. | | [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-amqp-component) | The text description of UsageFlags . | | [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-amqp-component) | The flags that show intended use for the certificate. | | [SSLAcceptServerCertVersion](#sslacceptservercertversion-property-amqp-component) | The certificate's version number. | | [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-amqp-component) | The subject of the certificate used for client authentication. | | [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-amqp-component) | The certificate (PEM/Base64 encoded). | | [SSLCertEffectiveDate](#sslcerteffectivedate-property-amqp-component) | The date on which this certificate becomes valid. | | [SSLCertExpirationDate](#sslcertexpirationdate-property-amqp-component) | The date on which the certificate expires. | | [SSLCertExtendedKeyUsage](#sslcertextendedkeyusage-property-amqp-component) | A comma-delimited list of extended key usage identifiers. | | [SSLCertFingerprint](#sslcertfingerprint-property-amqp-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLCertFingerprintSHA1](#sslcertfingerprintsha1-property-amqp-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLCertFingerprintSHA256](#sslcertfingerprintsha256-property-amqp-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLCertIssuer](#sslcertissuer-property-amqp-component) | The issuer of the certificate. | | [SSLCertPrivateKey](#sslcertprivatekey-property-amqp-component) | The private key of the certificate (if available). | | [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-amqp-component) | Whether a PrivateKey is available for the selected certificate. | | [SSLCertPrivateKeyContainer](#sslcertprivatekeycontainer-property-amqp-component) | The name of the PrivateKey container for the certificate (if available). | | [SSLCertPublicKey](#sslcertpublickey-property-amqp-component) | The public key of the certificate. | | [SSLCertPublicKeyAlgorithm](#sslcertpublickeyalgorithm-property-amqp-component) | The textual description of the certificate's public key algorithm. | | [SSLCertPublicKeyLength](#sslcertpublickeylength-property-amqp-component) | The length of the certificate's public key (in bits). | | [SSLCertSerialNumber](#sslcertserialnumber-property-amqp-component) | The serial number of the certificate encoded as a string. | | [SSLCertSignatureAlgorithm](#sslcertsignaturealgorithm-property-amqp-component) | The text description of the certificate's signature algorithm. | | [SSLCertStore](#sslcertstore-property-amqp-component) | The name of the certificate store for the client certificate. | | [SSLCertStorePassword](#sslcertstorepassword-property-amqp-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLCertStoreType](#sslcertstoretype-property-amqp-component) | The type of certificate store for this certificate. | | [SSLCertSubjectAltNames](#sslcertsubjectaltnames-property-amqp-component) | Comma-separated lists of alternative subject names for the certificate. | | [SSLCertThumbprintMD5](#sslcertthumbprintmd5-property-amqp-component) | The MD5 hash of the certificate. | | [SSLCertThumbprintSHA1](#sslcertthumbprintsha1-property-amqp-component) | The SHA-1 hash of the certificate. | | [SSLCertThumbprintSHA256](#sslcertthumbprintsha256-property-amqp-component) | The SHA-256 hash of the certificate. | | [SSLCertUsage](#sslcertusage-property-amqp-component) | The text description of UsageFlags . | | [SSLCertUsageFlags](#sslcertusageflags-property-amqp-component) | The flags that show intended use for the certificate. | | [SSLCertVersion](#sslcertversion-property-amqp-component) | The certificate's version number. | | [SSLCertSubject](#sslcertsubject-property-amqp-component) | The subject of the certificate used for client authentication. | | [SSLCertEncoded](#sslcertencoded-property-amqp-component) | The certificate (PEM/Base64 encoded). | | [SSLEnabled](#sslenabled-property-amqp-component) | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. | | [SSLProvider](#sslprovider-property-amqp-component) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCertEffectiveDate](#sslservercerteffectivedate-property-amqp-component) | The date on which this certificate becomes valid. | | [SSLServerCertExpirationDate](#sslservercertexpirationdate-property-amqp-component) | The date on which the certificate expires. | | [SSLServerCertExtendedKeyUsage](#sslservercertextendedkeyusage-property-amqp-component) | A comma-delimited list of extended key usage identifiers. | | [SSLServerCertFingerprint](#sslservercertfingerprint-property-amqp-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLServerCertFingerprintSHA1](#sslservercertfingerprintsha1-property-amqp-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLServerCertFingerprintSHA256](#sslservercertfingerprintsha256-property-amqp-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLServerCertIssuer](#sslservercertissuer-property-amqp-component) | The issuer of the certificate. | | [SSLServerCertPrivateKey](#sslservercertprivatekey-property-amqp-component) | The private key of the certificate (if available). | | [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-amqp-component) | Whether a PrivateKey is available for the selected certificate. | | [SSLServerCertPrivateKeyContainer](#sslservercertprivatekeycontainer-property-amqp-component) | The name of the PrivateKey container for the certificate (if available). | | [SSLServerCertPublicKey](#sslservercertpublickey-property-amqp-component) | The public key of the certificate. | | [SSLServerCertPublicKeyAlgorithm](#sslservercertpublickeyalgorithm-property-amqp-component) | The textual description of the certificate's public key algorithm. | | [SSLServerCertPublicKeyLength](#sslservercertpublickeylength-property-amqp-component) | The length of the certificate's public key (in bits). | | [SSLServerCertSerialNumber](#sslservercertserialnumber-property-amqp-component) | The serial number of the certificate encoded as a string. | | [SSLServerCertSignatureAlgorithm](#sslservercertsignaturealgorithm-property-amqp-component) | The text description of the certificate's signature algorithm. | | [SSLServerCertStore](#sslservercertstore-property-amqp-component) | The name of the certificate store for the client certificate. | | [SSLServerCertStorePassword](#sslservercertstorepassword-property-amqp-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLServerCertStoreType](#sslservercertstoretype-property-amqp-component) | The type of certificate store for this certificate. | | [SSLServerCertSubjectAltNames](#sslservercertsubjectaltnames-property-amqp-component) | Comma-separated lists of alternative subject names for the certificate. | | [SSLServerCertThumbprintMD5](#sslservercertthumbprintmd5-property-amqp-component) | The MD5 hash of the certificate. | | [SSLServerCertThumbprintSHA1](#sslservercertthumbprintsha1-property-amqp-component) | The SHA-1 hash of the certificate. | | [SSLServerCertThumbprintSHA256](#sslservercertthumbprintsha256-property-amqp-component) | The SHA-256 hash of the certificate. | | [SSLServerCertUsage](#sslservercertusage-property-amqp-component) | The text description of UsageFlags . | | [SSLServerCertUsageFlags](#sslservercertusageflags-property-amqp-component) | The flags that show intended use for the certificate. | | [SSLServerCertVersion](#sslservercertversion-property-amqp-component) | The certificate's version number. | | [SSLServerCertSubject](#sslservercertsubject-property-amqp-component) | The subject of the certificate used for client authentication. | | [SSLServerCertEncoded](#sslservercertencoded-property-amqp-component) | The certificate (PEM/Base64 encoded). | | [Timeout](#timeout-property-amqp-component) | This property includes the timeout for the class. | | [User](#user-property-amqp-component) | A username to use for SASL authentication. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CloseLink](#closelink-method-amqp-component) | Closes a link. | | [CloseSession](#closesession-method-amqp-component) | Closes a session. | | [Config](#config-method-amqp-component) | Sets or retrieves a configuration setting. | | [Connect](#connect-method-amqp-component) | This method connects to a remote host. | | [ConnectTo](#connectto-method-amqp-component) | This method connects to a remote host. | | [CreateReceiverLink](#createreceiverlink-method-amqp-component) | Creates a new receiver link with the given name on the specified session. | | [CreateSenderLink](#createsenderlink-method-amqp-component) | Creates a new sender link with the given name on the specified session. | | [CreateSession](#createsession-method-amqp-component) | Creates a new session with the given name. | | [Disconnect](#disconnect-method-amqp-component) | This method disconnects from the remote host. | | [DoEvents](#doevents-method-amqp-component) | This method processes events from the internal message queue. | | [Interrupt](#interrupt-method-amqp-component) | This method interrupts the current action. | | [Reset](#reset-method-amqp-component) | This method will reset the class. | | [ResetMessage](#resetmessage-method-amqp-component) | Resets the Message properties. | | [RetrieveMessage](#retrievemessage-method-amqp-component) | Retrieves a single message over the specified receiver link. | | [SendMessage](#sendmessage-method-amqp-component) | Sends a message on the specified link. | ## Event List *The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Connected](#connected-event-amqp-component) | Fired immediately after a connection completes (or fails). | | [ConnectionStatus](#connectionstatus-event-amqp-component) | Fired to indicate changes in the connection state. | | [Disconnected](#disconnected-event-amqp-component) | Fired when a connection is closed. | | [Error](#error-event-amqp-component) | Fired when information is available about errors during data delivery. | | [LinkReadyToSend](#linkreadytosend-event-amqp-component) | Fires when a sender link is ready to send messages. | | [Log](#log-event-amqp-component) | Fires once for each log message. | | [MessageIn](#messagein-event-amqp-component) | Fires when the class receives a message. | | [MessageOut](#messageout-event-amqp-component) | Fires when the class sends a message. | | [MessageOutcome](#messageoutcome-event-amqp-component) | Fires when a message's outcome is available. | | [SSLServerAuthentication](#sslserverauthentication-event-amqp-component) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-amqp-component) | Fired when secure connection progress messages are available. | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AuthorizationIdentity](#AuthorizationIdentity) | The value to use as the authorization identity when SASL authentication is used. | | [AzureSessionFilter](#AzureSessionFilter) | Sets a session id for Azure Service Bus sessions. | | [BinaryMessageEncoding](#BinaryMessageEncoding) | Sets the expected message encoding to use for decoding binary messages. | | [DecodeBinaryMessage](#DecodeBinaryMessage) | Decodes binary message payloads. | | [DefaultCredit](#DefaultCredit) | The amount of credit to create new receiver links with. | | [DefaultCreditThreshold](#DefaultCreditThreshold) | The credit threshold to create new receiver links with. | | [DefaultIncomingWindow](#DefaultIncomingWindow) | The incoming window size to create new sessions with. | | [DefaultOutgoingWindow](#DefaultOutgoingWindow) | The outgoing window size to create new sessions with. | | [DefaultReceiverSettleMode](#DefaultReceiverSettleMode) | The receiver settle mode to create new links with. | | [DefaultSenderSettleMode](#DefaultSenderSettleMode) | The sender settle mode to create new links with. | | [GenerateMessageId](#GenerateMessageId) | Whether a unique message Id should be automatically generated when sending a message. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxFrameSize](#MaxFrameSize) | The maximum frame size. | | [MaxLinkCountPerSession](#MaxLinkCountPerSession) | The maximum number of links to restrict new sessions to. | | [MaxMessageSize](#MaxMessageSize) | The maximum message size to restrict new links to. | | [MaxSessionCount](#MaxSessionCount) | The maximum number of sessions. | | [ModifiedDeliveryFailed](#ModifiedDeliveryFailed) | Whether the sender should treat this transfer as an unsuccessful delivery attempt. | | [ModifiedMessageAnnotations](#ModifiedMessageAnnotations) | The message annotations that the sender should merge into those already on the message. | | [ModifiedUndeliverableHere](#ModifiedUndeliverableHere) | Whether the receiver has indicated that the sender should not attempt to redeliver the message. | | [ProtocolVersion](#ProtocolVersion) | The AMQP protocol version to conform to. | | [RejectErrorCondition](#RejectErrorCondition) | The error condition included with a 'Rejected' delivery outcome. | | [RejectErrorDescription](#RejectErrorDescription) | The error description included with a 'Rejected' delivery outcome. | | [SenderSettleMode\[LinkName\]](#SenderSettleMode[LinkName]) | Retrieves the negotiated sender settle mode for the specified link. | | [SimplifiedJSONFormat](#SimplifiedJSONFormat) | Whether to output simplified JSON where possible. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. | | [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the class binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # AuthScheme Property ([AMQP](#amqp-component) Component) The authentication scheme to use when connecting. ## Syntax *Go Syntax* ```text func (obj *AMQP) AuthScheme() (int32, error)func (obj *AMQP) SetAuthScheme(value int32) error ``` ## Possible Values ```text 0 // None1 // SASLAnonymous2 // SASLPlain3 // SASLExternal ``` ## Default Value 2 ## Remarks This property controls what authentication scheme the struct should use when connecting to the remote host. Valid values are: - smNone (0) - smSASLAnonymous (1) - smSASLPlain (2) - Default - smSASLExternal (3) ## Data Type **int32** # Connected Property ([AMQP](#amqp-component) Component) This property indicates whether the class is connected. ## Syntax *Go Syntax* ```text func (obj *AMQP) Connected() (bool, error) ``` ## Default Value false ## Remarks This property indicates whether the struct is connected to the remote host. Use the [Connect](#connect-method-amqp-component) and [Disconnect](#disconnect-method-amqp-component) methods to manage the connection. This property is read-only. ## Data Type **bool** # ContainerId Property ([AMQP](#amqp-component) Component) The container Id the class should advertise when connecting. ## Syntax *Go Syntax* ```text func (obj *AMQP) ContainerId() (string, error)func (obj *AMQP) SetContainerId(value string) error ``` ## Default Value "" ## Remarks This property specifies the container Id that the struct should advertise when it's connecting to the remote host. In AMQP, the top-level organizational grouping is called a "container", and each container can contain zero or more "nodes", which are the actual entities which send and receive messages over links. Since this struct handles multiple layers of the AMQP transport protocol (the overall connection, the sessions in that connection, and the links attached to those sessions), it must be given a unique container Id. NOTE: The container Id cannot be changed while connected. ## Data Type **string** # FirewallAutoDetect Property ([AMQP](#amqp-component) Component) Whether to automatically detect and use firewall system settings, if available. ## Syntax *Go Syntax* ```text func (obj *AMQP) FirewallAutoDetect() (bool, error)func (obj *AMQP) SetFirewallAutoDetect(value bool) error ``` ## Default Value false ## Remarks Whether to automatically detect and use firewall system settings, if available. ## Data Type **bool** # FirewallType Property ([AMQP](#amqp-component) Component) The type of firewall to connect through. ## Syntax *Go Syntax* ```text func (obj *AMQP) FirewallType() (int32, error)func (obj *AMQP) SetFirewallType(value int32) error ``` ## Possible Values ```text 0 // None1 // Tunnel2 // SOCKS43 // SOCKS510 // SOCKS4A ``` ## Default Value 0 ## Remarks The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [FirewallPort](#firewallport-property-amqp-component) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [FirewallPort](#firewallport-property-amqp-component) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [FirewallPort](#firewallport-property-amqp-component) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [FirewallPort](#firewallport-property-amqp-component) is set to 1080. | ## Data Type **int32** # FirewallHost Property ([AMQP](#amqp-component) Component) The name or IP address of the firewall (optional). ## Syntax *Go Syntax* ```text func (obj *AMQP) FirewallHost() (string, error)func (obj *AMQP) SetFirewallHost(value string) error ``` ## Default Value "" ## Remarks The name or IP address of the firewall (optional). If a [FirewallHost](#firewallhost-property-amqp-component) is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error. ## Data Type **string** # FirewallPassword Property ([AMQP](#amqp-component) Component) A password if authentication is to be used when connecting through the firewall. ## Syntax *Go Syntax* ```text func (obj *AMQP) FirewallPassword() (string, error)func (obj *AMQP) SetFirewallPassword(value string) error ``` ## Default Value "" ## Remarks A password if authentication is to be used when connecting through the firewall. If [FirewallHost](#firewallhost-property-amqp-component) is specified, the [FirewallUser](#firewalluser-property-amqp-component) and [FirewallPassword](#firewallpassword-property-amqp-component) properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error. ## Data Type **string** # FirewallPort Property ([AMQP](#amqp-component) Component) The Transmission Control Protocol (TCP) port for the firewall Host . ## Syntax *Go Syntax* ```text func (obj *AMQP) FirewallPort() (int32, error)func (obj *AMQP) SetFirewallPort(value int32) error ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [FirewallHost](#firewallhost-property-amqp-component). See the description of the [FirewallHost](#firewallhost-property-amqp-component) property for details. NOTE: This property is set automatically when [FirewallType](#firewalltype-property-amqp-component) is set to a valid value. See the description of the [FirewallType](#firewalltype-property-amqp-component) property for details. ## Data Type **int32** # FirewallUser Property ([AMQP](#amqp-component) Component) A username if authentication is to be used when connecting through a firewall. ## Syntax *Go Syntax* ```text func (obj *AMQP) FirewallUser() (string, error)func (obj *AMQP) SetFirewallUser(value string) error ``` ## Default Value "" ## Remarks A username if authentication is to be used when connecting through a firewall. If [FirewallHost](#firewallhost-property-amqp-component) is specified, this property and the [FirewallPassword](#firewallpassword-property-amqp-component) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the struct fails with an error. ## Data Type **string** # IdleTimeout Property ([AMQP](#amqp-component) Component) The maximum period of inactivity the class will allow before disconnecting. ## Syntax *Go Syntax* ```text func (obj *AMQP) IdleTimeout() (int32, error)func (obj *AMQP) SetIdleTimeout(value int32) error ``` ## Default Value 0 ## Remarks This property controls how long, in seconds, the struct will allow the connection to sit idle before it disconnects from the remote host. This property may be set to 0 to prevent the struct from ever closing the connection due to inactivity. NOTE: The idle timeout cannot be changed while connected. ## Data Type **int32** # IncomingMessageCount Property ([AMQP](#amqp-component) Component) The number of records in the IncomingMessage arrays. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageCount() (int32, error) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [IncomingMessageAbsoluteExpiryTime](#incomingmessageabsoluteexpirytime-property-amqp-component) - [IncomingMessageContentEncoding](#incomingmessagecontentencoding-property-amqp-component) - [IncomingMessageContentType](#incomingmessagecontenttype-property-amqp-component) - [IncomingMessageCorrelationId](#incomingmessagecorrelationid-property-amqp-component) - [IncomingMessageCreationTime](#incomingmessagecreationtime-property-amqp-component) - [IncomingMessageDeliveryCount](#incomingmessagedeliverycount-property-amqp-component) - [IncomingMessageDurable](#incomingmessagedurable-property-amqp-component) - [IncomingMessageFirstAcquirer](#incomingmessagefirstacquirer-property-amqp-component) - [IncomingMessageGroupId](#incomingmessagegroupid-property-amqp-component) - [IncomingMessageGroupSequence](#incomingmessagegroupsequence-property-amqp-component) - [IncomingMessageId](#incomingmessageid-property-amqp-component) - [IncomingMessageLinkName](#incomingmessagelinkname-property-amqp-component) - [IncomingMessagePriority](#incomingmessagepriority-property-amqp-component) - [IncomingMessageReplyTo](#incomingmessagereplyto-property-amqp-component) - [IncomingMessageReplyToGroupId](#incomingmessagereplytogroupid-property-amqp-component) - [IncomingMessageSettled](#incomingmessagesettled-property-amqp-component) - [IncomingMessageSubject](#incomingmessagesubject-property-amqp-component) - [IncomingMessageTo](#incomingmessageto-property-amqp-component) - [IncomingMessageTTL](#incomingmessagettl-property-amqp-component) - [IncomingMessageUserId](#incomingmessageuserid-property-amqp-component) - [IncomingMessageValue](#incomingmessagevalue-property-amqp-component) - [IncomingMessageValueType](#incomingmessagevaluetype-property-amqp-component) The array indices start at *0* and end at *IncomingMessageCount - 1*. This property is read-only. ## Data Type **int32** # IncomingMessageAbsoluteExpiryTime Property ([AMQP](#amqp-component) Component) The absolute time at which this message should be considered expired. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageAbsoluteExpiryTime(IncomingMessageIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks The absolute time at which this message should be considered expired. This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time. This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC). The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **int64** # IncomingMessageContentEncoding Property ([AMQP](#amqp-component) Component) The content encoding of this message's data. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageContentEncoding(IncomingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The content encoding of this message's data. This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set. When constructing a message for sending, this property is ignored if [IncomingMessageValueType](#incomingmessagevaluetype-property-amqp-component) is not set to *mvtData (20)*. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # IncomingMessageContentType Property ([AMQP](#amqp-component) Component) The content type of this message's data. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageContentType(IncomingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The content type of this message's data. This property specifies the content type of this message's data. It may be empty if this message does not have a content type set. When constructing a message for sending, this property is ignored if [IncomingMessageValueType](#incomingmessagevaluetype-property-amqp-component) is not set to *mvtData (20)*. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # IncomingMessageCorrelationId Property ([AMQP](#amqp-component) Component) The correlation Id of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageCorrelationId(IncomingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The correlation Id of this message. This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # IncomingMessageCreationTime Property ([AMQP](#amqp-component) Component) The creation time of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageCreationTime(IncomingMessageIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks The creation time of this message. This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set. This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC). The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **int64** # IncomingMessageDeliveryCount Property ([AMQP](#amqp-component) Component) How many previous attempts there have been to deliver this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageDeliveryCount(IncomingMessageIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks How many previous attempts there have been to deliver this message. This property indicates how many (unsuccessful) previous attempts there have been to deliver this message. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **int64** # IncomingMessageDurable Property ([AMQP](#amqp-component) Component) Whether this message is durable. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageDurable(IncomingMessageIndex int32) (bool, error) ``` ## Default Value false ## Remarks Whether this message is durable. This property specifies whether this message is durable or not. If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **bool** # IncomingMessageFirstAcquirer Property ([AMQP](#amqp-component) Component) Whether this message may have been acquired by other links previously. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageFirstAcquirer(IncomingMessageIndex int32) (bool, error) ``` ## Default Value false ## Remarks Whether this message may have been acquired by other links previously. This property specifies whether this message might have previously been acquired by other links. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **bool** # IncomingMessageGroupId Property ([AMQP](#amqp-component) Component) The Id of the group this message belongs to. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageGroupId(IncomingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The Id of the group this message belongs to. This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # IncomingMessageGroupSequence Property ([AMQP](#amqp-component) Component) The position of this message within its group. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageGroupSequence(IncomingMessageIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks The position of this message within its group. This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **int64** # IncomingMessageLinkName Property ([AMQP](#amqp-component) Component) The name of the link this message is associated with. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageLinkName(IncomingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The name of the link this message is associated with. This property holds the name of the link which this message is being sent/was received on. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # IncomingMessageId Property ([AMQP](#amqp-component) Component) The unique Id of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageId(IncomingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The unique Id of this message. This property holds the unique Id of this message. It may be empty if this message does not have a unique Id. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # IncomingMessagePriority Property ([AMQP](#amqp-component) Component) The priority of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessagePriority(IncomingMessageIndex int32) (int32, error) ``` ## Default Value 4 ## Remarks The priority of this message. This property holds the priority of this message; the default is 4 (as defined by the AMQP specification). The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **int32** # IncomingMessageReplyTo Property ([AMQP](#amqp-component) Component) The address of the node to send replies to for this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageReplyTo(IncomingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The address of the node to send replies to for this message. This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # IncomingMessageReplyToGroupId Property ([AMQP](#amqp-component) Component) The Id of the group to send replies to for this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageReplyToGroupId(IncomingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The Id of the group to send replies to for this message. This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # IncomingMessageSettled Property ([AMQP](#amqp-component) Component) Whether this message is settled. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageSettled(IncomingMessageIndex int32) (bool, error) ``` ## Default Value true ## Remarks Whether this message is settled. This property specifies whether this message is settled or not. Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not *Mixed (2)*. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **bool** # IncomingMessageSubject Property ([AMQP](#amqp-component) Component) The subject of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageSubject(IncomingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The subject of this message. This property specifies the subject of this message. It may be empty if this message does not have a subject set. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # IncomingMessageTo Property ([AMQP](#amqp-component) Component) The address of the node which this message is intended for. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageTo(IncomingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The address of the node which this message is intended for. This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # IncomingMessageTTL Property ([AMQP](#amqp-component) Component) The time-to-live value for this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageTTL(IncomingMessageIndex int32) (int64, error) ``` ## Default Value -1 ## Remarks The time-to-live value for this message. This property specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **int64** # IncomingMessageUserId Property ([AMQP](#amqp-component) Component) The identity of the user responsible for producing this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageUserId(IncomingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The identity of the user responsible for producing this message. This property specifies the identity of the user responsible for producing this message. It may be empty if no specific user was responsible for creating this message. A message's user Id *may* be used for verification or authentication by intermediates and/or the final receiver. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # IncomingMessageValue Property ([AMQP](#amqp-component) Component) This message's value. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageValue(IncomingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks This message's value. This property specifies the value to send in this message. The [IncomingMessageValueType](#incomingmessagevaluetype-property-amqp-component) property should be used to specify the data type of the value. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # IncomingMessageValueType Property ([AMQP](#amqp-component) Component) This message's value data type. ## Syntax *Go Syntax* ```text func (obj *AMQP) IncomingMessageValueType(IncomingMessageIndex int32) (int32, error) ``` ## Possible Values ```text 0 // Null1 // Boolean2 // Ubyte3 // Ushort4 // Uint5 // Ulong6 // Byte7 // Short8 // Int9 // Long10 // Float11 // Double12 // Decimal13 // Char14 // Timestamp15 // Uuid16 // Binary17 // String18 // Symbol19 // Json20 // Data ``` ## Default Value 0 ## Remarks This message's value data type. This property specifies the data type of this message's [IncomingMessageValue](#incomingmessagevalue-property-amqp-component). The table below shows the possible value types, their descriptions, and how to format the data assigned to [IncomingMessageValue](#incomingmessagevalue-property-amqp-component). All numeric value types should use their standard string formatting (except for the *mvtDecimal (12)* type, which should be specified as hex-encoded bytes). | Type | Description | Value Format | | --- | --- | --- | | mvtNull (0 - default) | Null | N/A ([IncomingMessageValue](#incomingmessagevalue-property-amqp-component) is ignored) | | mvtBoolean (1) | Boolean | "True" or "False" | | mvtUbyte (2) | Unsigned byte | 0 to 255 | | mvtUshort (3) | Unsigned short | 0 to 65535 | | mvtUint (4) | Unsigned integer | 0 to 4294967295 | | mvtUlong (5) | Unsigned long | 0 to 18446744073709551615 | | mvtByte (6) | Byte | -128 to 127 | | mvtShort (7) | Short | -32768 to 32767 | | mvtInt (8) | Integer | -2147483648 to 2147483647 | | mvtLong (9) | Long | -9223372036854775808 to 9223372036854775807 | | mvtFloat (10) | Float | IEEE 754 32-bit floating point number | | mvtDouble (11) | Double | IEEE 754 64-bit floating point number | | mvtDecimal (12) | Decimal | Hex-encoded byte string | | mvtChar (13) | Char | Single character | | mvtTimestamp (14) | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). | | mvtUuid (15) | UUID | Hex-encoded UUID in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX (hyphens optional, case-insensitive) | | mvtBinary (16) | Binary data | Hex-encoded byte string | | mvtString (17) | String | String | | mvtSymbol (18) | Symbolic value | ASCII string | | mvtJson (19) | Composite data | Composite data JSON structured according to the schema shown in the [SendMessage](#sendmessage-method-amqp-component) method's documentation | | mvtData (20) | Opaque binary data | Hex-encoded byte string or utf-8 string | The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incomingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **int32** # LinkCount Property ([AMQP](#amqp-component) Component) The number of records in the Link arrays. ## Syntax *Go Syntax* ```text func (obj *AMQP) LinkCount() (int32, error) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [LinkAvailable](#linkavailable-property-amqp-component) - [LinkChannelName](#linkchannelname-property-amqp-component) - [LinkCredit](#linkcredit-property-amqp-component) - [LinkDeliveryCount](#linkdeliverycount-property-amqp-component) - [LinkName](#linkname-property-amqp-component) - [LinkReadyToSend](#linkreadytosend-property-amqp-component) - [LinkReceiveMode](#linkreceivemode-property-amqp-component) - [LinkRole](#linkrole-property-amqp-component) The array indices start at *0* and end at *LinkCount - 1*. This property is read-only. ## Data Type **int32** # LinkAvailable Property ([AMQP](#amqp-component) Component) The number of messages which this link's sender could send if it had credit for them. ## Syntax *Go Syntax* ```text func (obj *AMQP) LinkAvailable(LinkIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks The number of messages which this link's sender could send if it had credit for them. This property returns the number of messages which this link's sender has indicated that it *could* send if it had the credit to do so. The *LinkIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [LinkCount](#linkcount-property-amqp-component) property. This property is read-only. ## Data Type **int64** # LinkChannelName Property ([AMQP](#amqp-component) Component) The channel name this link is using. ## Syntax *Go Syntax* ```text func (obj *AMQP) LinkChannelName(LinkIndex int32) (string, error) ``` ## Default Value "" ## Remarks The channel name this link is using. This property holds the channel name this link is using. The *LinkIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [LinkCount](#linkcount-property-amqp-component) property. This property is read-only. ## Data Type **string** # LinkCredit Property ([AMQP](#amqp-component) Component) The amount of credit currently available to this link's sender. ## Syntax *Go Syntax* ```text func (obj *AMQP) LinkCredit(LinkIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks The amount of credit currently available to this link's sender. This property holds the amount of credit currently available to this link's sender. The sender on a link can only send messages if it has non-zero credit. The *LinkIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [LinkCount](#linkcount-property-amqp-component) property. This property is read-only. ## Data Type **int64** # LinkDeliveryCount Property ([AMQP](#amqp-component) Component) The current delivery count value for this link. ## Syntax *Go Syntax* ```text func (obj *AMQP) LinkDeliveryCount(LinkIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks The current delivery count value for this link. This property holds the current delivery count value for this link. The *LinkIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [LinkCount](#linkcount-property-amqp-component) property. This property is read-only. ## Data Type **int64** # LinkName Property ([AMQP](#amqp-component) Component) This link's name. ## Syntax *Go Syntax* ```text func (obj *AMQP) LinkName(LinkIndex int32) (string, error) ``` ## Default Value "" ## Remarks This link's name. This property holds this link's name. The *LinkIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [LinkCount](#linkcount-property-amqp-component) property. This property is read-only. ## Data Type **string** # LinkReadyToSend Property ([AMQP](#amqp-component) Component) Whether this link is ready to send a message. ## Syntax *Go Syntax* ```text func (obj *AMQP) LinkReadyToSend(LinkIndex int32) (bool, error) ``` ## Default Value false ## Remarks Whether this link is ready to send a message. This property reflects whether this link is currently ready to send a message or not; it always returns *False* if [LinkRole](#linkrole-property-amqp-component) is *lrReceiver (1)*. The *LinkIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [LinkCount](#linkcount-property-amqp-component) property. This property is read-only. ## Data Type **bool** # LinkReceiveMode Property ([AMQP](#amqp-component) Component) The receive mode this link is operating in. ## Syntax *Go Syntax* ```text func (obj *AMQP) LinkReceiveMode(LinkIndex int32) (int32, error) ``` ## Possible Values ```text 0 // Automatic1 // Retrieve ``` ## Default Value 0 ## Remarks The receive mode this link is operating in. This property reflects the receive mode which this link is operating in, if it is a receiver link. (For sender links, this property's value means nothing.) Values can be: - lrmAutomatic - Messages will be received automatically - lrmRetrieve - One message will be received after each call to the RetrieveMessage method. Refer to [ReceiveMode](#AMQP_m_ReceiveMode) for more information. The *LinkIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [LinkCount](#linkcount-property-amqp-component) property. This property is read-only. ## Data Type **int32** # LinkRole Property ([AMQP](#amqp-component) Component) The class's role on this link. ## Syntax *Go Syntax* ```text func (obj *AMQP) LinkRole(LinkIndex int32) (int32, error) ``` ## Possible Values ```text 0 // Sender1 // Receiver ``` ## Default Value 0 ## Remarks The struct's role on this link. This property reflects which role the struct is in for this link. Valid values are: - lrSender (0) - lrReceiver (1) The *LinkIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [LinkCount](#linkcount-property-amqp-component) property. This property is read-only. ## Data Type **int32** # LocalHost Property ([AMQP](#amqp-component) Component) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Go Syntax* ```text func (obj *AMQP) LocalHost() (string, error)func (obj *AMQP) SetLocalHost(value string) error ``` ## Default Value "" ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the struct is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window. ## Data Type **string** # LocalPort Property ([AMQP](#amqp-component) Component) The TCP port in the local host where the class binds. ## Syntax *Go Syntax* ```text func (obj *AMQP) LocalPort() (int32, error)func (obj *AMQP) SetLocalPort(value int32) error ``` ## Default Value 0 ## Remarks This property must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine. Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error. This property is useful when trying to connect to services that require a trusted port on the client side. ## Data Type **int32** # MessageAbsoluteExpiryTime Property ([AMQP](#amqp-component) Component) The absolute time at which this message should be considered expired. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageAbsoluteExpiryTime() (int64, error)func (obj *AMQP) SetMessageAbsoluteExpiryTime(value int64) error ``` ## Default Value 0 ## Remarks The absolute time at which this message should be considered expired. This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time. This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC). ## Data Type **int64** # MessageContentEncoding Property ([AMQP](#amqp-component) Component) The content encoding of this message's data. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageContentEncoding() (string, error)func (obj *AMQP) SetMessageContentEncoding(value string) error ``` ## Default Value "" ## Remarks The content encoding of this message's data. This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set. When constructing a message for sending, this property is ignored if [MessageValueType](#messagevaluetype-property-amqp-component) is not set to *mvtData (20)*. ## Data Type **string** # MessageContentType Property ([AMQP](#amqp-component) Component) The content type of this message's data. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageContentType() (string, error)func (obj *AMQP) SetMessageContentType(value string) error ``` ## Default Value "" ## Remarks The content type of this message's data. This property specifies the content type of this message's data. It may be empty if this message does not have a content type set. When constructing a message for sending, this property is ignored if [MessageValueType](#messagevaluetype-property-amqp-component) is not set to *mvtData (20)*. ## Data Type **string** # MessageCorrelationId Property ([AMQP](#amqp-component) Component) The correlation Id of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageCorrelationId() (string, error)func (obj *AMQP) SetMessageCorrelationId(value string) error ``` ## Default Value "" ## Remarks The correlation Id of this message. This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id. ## Data Type **string** # MessageCreationTime Property ([AMQP](#amqp-component) Component) The creation time of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageCreationTime() (int64, error)func (obj *AMQP) SetMessageCreationTime(value int64) error ``` ## Default Value 0 ## Remarks The creation time of this message. This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set. This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC). ## Data Type **int64** # MessageDeliveryCount Property ([AMQP](#amqp-component) Component) How many previous attempts there have been to deliver this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageDeliveryCount() (int64, error)func (obj *AMQP) SetMessageDeliveryCount(value int64) error ``` ## Default Value 0 ## Remarks How many previous attempts there have been to deliver this message. This property indicates how many (unsuccessful) previous attempts there have been to deliver this message. ## Data Type **int64** # MessageDurable Property ([AMQP](#amqp-component) Component) Whether this message is durable. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageDurable() (bool, error)func (obj *AMQP) SetMessageDurable(value bool) error ``` ## Default Value false ## Remarks Whether this message is durable. This property specifies whether this message is durable or not. If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message. ## Data Type **bool** # MessageFirstAcquirer Property ([AMQP](#amqp-component) Component) Whether this message may have been acquired by other links previously. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageFirstAcquirer() (bool, error)func (obj *AMQP) SetMessageFirstAcquirer(value bool) error ``` ## Default Value false ## Remarks Whether this message may have been acquired by other links previously. This property specifies whether this message might have previously been acquired by other links. ## Data Type **bool** # MessageGroupId Property ([AMQP](#amqp-component) Component) The Id of the group this message belongs to. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageGroupId() (string, error)func (obj *AMQP) SetMessageGroupId(value string) error ``` ## Default Value "" ## Remarks The Id of the group this message belongs to. This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group. ## Data Type **string** # MessageGroupSequence Property ([AMQP](#amqp-component) Component) The position of this message within its group. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageGroupSequence() (int64, error)func (obj *AMQP) SetMessageGroupSequence(value int64) error ``` ## Default Value 0 ## Remarks The position of this message within its group. This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group. ## Data Type **int64** # MessageLinkName Property ([AMQP](#amqp-component) Component) The name of the link this message is associated with. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageLinkName() (string, error) ``` ## Default Value "" ## Remarks The name of the link this message is associated with. This property holds the name of the link which this message is being sent/was received on. This property is read-only. ## Data Type **string** # MessageId Property ([AMQP](#amqp-component) Component) The unique Id of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageId() (string, error)func (obj *AMQP) SetMessageId(value string) error ``` ## Default Value "" ## Remarks The unique Id of this message. This property holds the unique Id of this message. It may be empty if this message does not have a unique Id. ## Data Type **string** # MessagePriority Property ([AMQP](#amqp-component) Component) The priority of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessagePriority() (int32, error)func (obj *AMQP) SetMessagePriority(value int32) error ``` ## Default Value 4 ## Remarks The priority of this message. This property holds the priority of this message; the default is 4 (as defined by the AMQP specification). ## Data Type **int32** # MessageReplyTo Property ([AMQP](#amqp-component) Component) The address of the node to send replies to for this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageReplyTo() (string, error)func (obj *AMQP) SetMessageReplyTo(value string) error ``` ## Default Value "" ## Remarks The address of the node to send replies to for this message. This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address. ## Data Type **string** # MessageReplyToGroupId Property ([AMQP](#amqp-component) Component) The Id of the group to send replies to for this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageReplyToGroupId() (string, error)func (obj *AMQP) SetMessageReplyToGroupId(value string) error ``` ## Default Value "" ## Remarks The Id of the group to send replies to for this message. This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message. ## Data Type **string** # MessageSettled Property ([AMQP](#amqp-component) Component) Whether this message is settled. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageSettled() (bool, error)func (obj *AMQP) SetMessageSettled(value bool) error ``` ## Default Value true ## Remarks Whether this message is settled. This property specifies whether this message is settled or not. Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not *Mixed (2)*. ## Data Type **bool** # MessageSubject Property ([AMQP](#amqp-component) Component) The subject of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageSubject() (string, error)func (obj *AMQP) SetMessageSubject(value string) error ``` ## Default Value "" ## Remarks The subject of this message. This property specifies the subject of this message. It may be empty if this message does not have a subject set. ## Data Type **string** # MessageTo Property ([AMQP](#amqp-component) Component) The address of the node which this message is intended for. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageTo() (string, error)func (obj *AMQP) SetMessageTo(value string) error ``` ## Default Value "" ## Remarks The address of the node which this message is intended for. This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node. ## Data Type **string** # MessageTTL Property ([AMQP](#amqp-component) Component) The time-to-live value for this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageTTL() (int64, error)func (obj *AMQP) SetMessageTTL(value int64) error ``` ## Default Value -1 ## Remarks The time-to-live value for this message. This property specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL. ## Data Type **int64** # MessageUserId Property ([AMQP](#amqp-component) Component) The identity of the user responsible for producing this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageUserId() (string, error)func (obj *AMQP) SetMessageUserId(value string) error ``` ## Default Value "" ## Remarks The identity of the user responsible for producing this message. This property specifies the identity of the user responsible for producing this message. It may be empty if no specific user was responsible for creating this message. A message's user Id *may* be used for verification or authentication by intermediates and/or the final receiver. ## Data Type **string** # MessageValue Property ([AMQP](#amqp-component) Component) This message's value. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageValue() (string, error)func (obj *AMQP) SetMessageValue(value string) error ``` ## Default Value "" ## Remarks This message's value. This property specifies the value to send in this message. The [MessageValueType](#messagevaluetype-property-amqp-component) property should be used to specify the data type of the value. ## Data Type **string** # MessageValueType Property ([AMQP](#amqp-component) Component) This message's value data type. ## Syntax *Go Syntax* ```text func (obj *AMQP) MessageValueType() (int32, error)func (obj *AMQP) SetMessageValueType(value int32) error ``` ## Possible Values ```text 0 // Null1 // Boolean2 // Ubyte3 // Ushort4 // Uint5 // Ulong6 // Byte7 // Short8 // Int9 // Long10 // Float11 // Double12 // Decimal13 // Char14 // Timestamp15 // Uuid16 // Binary17 // String18 // Symbol19 // Json20 // Data ``` ## Default Value 0 ## Remarks This message's value data type. This property specifies the data type of this message's [MessageValue](#messagevalue-property-amqp-component). The table below shows the possible value types, their descriptions, and how to format the data assigned to [MessageValue](#messagevalue-property-amqp-component). All numeric value types should use their standard string formatting (except for the *mvtDecimal (12)* type, which should be specified as hex-encoded bytes). | Type | Description | Value Format | | --- | --- | --- | | mvtNull (0 - default) | Null | N/A ([MessageValue](#messagevalue-property-amqp-component) is ignored) | | mvtBoolean (1) | Boolean | "True" or "False" | | mvtUbyte (2) | Unsigned byte | 0 to 255 | | mvtUshort (3) | Unsigned short | 0 to 65535 | | mvtUint (4) | Unsigned integer | 0 to 4294967295 | | mvtUlong (5) | Unsigned long | 0 to 18446744073709551615 | | mvtByte (6) | Byte | -128 to 127 | | mvtShort (7) | Short | -32768 to 32767 | | mvtInt (8) | Integer | -2147483648 to 2147483647 | | mvtLong (9) | Long | -9223372036854775808 to 9223372036854775807 | | mvtFloat (10) | Float | IEEE 754 32-bit floating point number | | mvtDouble (11) | Double | IEEE 754 64-bit floating point number | | mvtDecimal (12) | Decimal | Hex-encoded byte string | | mvtChar (13) | Char | Single character | | mvtTimestamp (14) | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). | | mvtUuid (15) | UUID | Hex-encoded UUID in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX (hyphens optional, case-insensitive) | | mvtBinary (16) | Binary data | Hex-encoded byte string | | mvtString (17) | String | String | | mvtSymbol (18) | Symbolic value | ASCII string | | mvtJson (19) | Composite data | Composite data JSON structured according to the schema shown in the [SendMessage](#sendmessage-method-amqp-component) method's documentation | | mvtData (20) | Opaque binary data | Hex-encoded byte string or utf-8 string | ## Data Type **int32** # OutgoingMessageCount Property ([AMQP](#amqp-component) Component) The number of records in the OutgoingMessage arrays. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageCount() (int32, error) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [OutgoingMessageAbsoluteExpiryTime](#outgoingmessageabsoluteexpirytime-property-amqp-component) - [OutgoingMessageContentEncoding](#outgoingmessagecontentencoding-property-amqp-component) - [OutgoingMessageContentType](#outgoingmessagecontenttype-property-amqp-component) - [OutgoingMessageCorrelationId](#outgoingmessagecorrelationid-property-amqp-component) - [OutgoingMessageCreationTime](#outgoingmessagecreationtime-property-amqp-component) - [OutgoingMessageDeliveryCount](#outgoingmessagedeliverycount-property-amqp-component) - [OutgoingMessageDurable](#outgoingmessagedurable-property-amqp-component) - [OutgoingMessageFirstAcquirer](#outgoingmessagefirstacquirer-property-amqp-component) - [OutgoingMessageGroupId](#outgoingmessagegroupid-property-amqp-component) - [OutgoingMessageGroupSequence](#outgoingmessagegroupsequence-property-amqp-component) - [OutgoingMessageId](#outgoingmessageid-property-amqp-component) - [OutgoingMessageLinkName](#outgoingmessagelinkname-property-amqp-component) - [OutgoingMessagePriority](#outgoingmessagepriority-property-amqp-component) - [OutgoingMessageReplyTo](#outgoingmessagereplyto-property-amqp-component) - [OutgoingMessageReplyToGroupId](#outgoingmessagereplytogroupid-property-amqp-component) - [OutgoingMessageSettled](#outgoingmessagesettled-property-amqp-component) - [OutgoingMessageSubject](#outgoingmessagesubject-property-amqp-component) - [OutgoingMessageTo](#outgoingmessageto-property-amqp-component) - [OutgoingMessageTTL](#outgoingmessagettl-property-amqp-component) - [OutgoingMessageUserId](#outgoingmessageuserid-property-amqp-component) - [OutgoingMessageValue](#outgoingmessagevalue-property-amqp-component) - [OutgoingMessageValueType](#outgoingmessagevaluetype-property-amqp-component) The array indices start at *0* and end at *OutgoingMessageCount - 1*. This property is read-only. ## Data Type **int32** # OutgoingMessageAbsoluteExpiryTime Property ([AMQP](#amqp-component) Component) The absolute time at which this message should be considered expired. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageAbsoluteExpiryTime(OutgoingMessageIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks The absolute time at which this message should be considered expired. This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time. This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC). The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **int64** # OutgoingMessageContentEncoding Property ([AMQP](#amqp-component) Component) The content encoding of this message's data. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageContentEncoding(OutgoingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The content encoding of this message's data. This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set. When constructing a message for sending, this property is ignored if [OutgoingMessageValueType](#outgoingmessagevaluetype-property-amqp-component) is not set to *mvtData (20)*. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # OutgoingMessageContentType Property ([AMQP](#amqp-component) Component) The content type of this message's data. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageContentType(OutgoingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The content type of this message's data. This property specifies the content type of this message's data. It may be empty if this message does not have a content type set. When constructing a message for sending, this property is ignored if [OutgoingMessageValueType](#outgoingmessagevaluetype-property-amqp-component) is not set to *mvtData (20)*. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # OutgoingMessageCorrelationId Property ([AMQP](#amqp-component) Component) The correlation Id of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageCorrelationId(OutgoingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The correlation Id of this message. This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # OutgoingMessageCreationTime Property ([AMQP](#amqp-component) Component) The creation time of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageCreationTime(OutgoingMessageIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks The creation time of this message. This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set. This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC). The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **int64** # OutgoingMessageDeliveryCount Property ([AMQP](#amqp-component) Component) How many previous attempts there have been to deliver this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageDeliveryCount(OutgoingMessageIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks How many previous attempts there have been to deliver this message. This property indicates how many (unsuccessful) previous attempts there have been to deliver this message. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **int64** # OutgoingMessageDurable Property ([AMQP](#amqp-component) Component) Whether this message is durable. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageDurable(OutgoingMessageIndex int32) (bool, error) ``` ## Default Value false ## Remarks Whether this message is durable. This property specifies whether this message is durable or not. If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **bool** # OutgoingMessageFirstAcquirer Property ([AMQP](#amqp-component) Component) Whether this message may have been acquired by other links previously. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageFirstAcquirer(OutgoingMessageIndex int32) (bool, error) ``` ## Default Value false ## Remarks Whether this message may have been acquired by other links previously. This property specifies whether this message might have previously been acquired by other links. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **bool** # OutgoingMessageGroupId Property ([AMQP](#amqp-component) Component) The Id of the group this message belongs to. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageGroupId(OutgoingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The Id of the group this message belongs to. This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # OutgoingMessageGroupSequence Property ([AMQP](#amqp-component) Component) The position of this message within its group. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageGroupSequence(OutgoingMessageIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks The position of this message within its group. This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **int64** # OutgoingMessageLinkName Property ([AMQP](#amqp-component) Component) The name of the link this message is associated with. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageLinkName(OutgoingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The name of the link this message is associated with. This property holds the name of the link which this message is being sent/was received on. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # OutgoingMessageId Property ([AMQP](#amqp-component) Component) The unique Id of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageId(OutgoingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The unique Id of this message. This property holds the unique Id of this message. It may be empty if this message does not have a unique Id. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # OutgoingMessagePriority Property ([AMQP](#amqp-component) Component) The priority of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessagePriority(OutgoingMessageIndex int32) (int32, error) ``` ## Default Value 4 ## Remarks The priority of this message. This property holds the priority of this message; the default is 4 (as defined by the AMQP specification). The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **int32** # OutgoingMessageReplyTo Property ([AMQP](#amqp-component) Component) The address of the node to send replies to for this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageReplyTo(OutgoingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The address of the node to send replies to for this message. This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # OutgoingMessageReplyToGroupId Property ([AMQP](#amqp-component) Component) The Id of the group to send replies to for this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageReplyToGroupId(OutgoingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The Id of the group to send replies to for this message. This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # OutgoingMessageSettled Property ([AMQP](#amqp-component) Component) Whether this message is settled. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageSettled(OutgoingMessageIndex int32) (bool, error) ``` ## Default Value true ## Remarks Whether this message is settled. This property specifies whether this message is settled or not. Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not *Mixed (2)*. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **bool** # OutgoingMessageSubject Property ([AMQP](#amqp-component) Component) The subject of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageSubject(OutgoingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The subject of this message. This property specifies the subject of this message. It may be empty if this message does not have a subject set. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # OutgoingMessageTo Property ([AMQP](#amqp-component) Component) The address of the node which this message is intended for. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageTo(OutgoingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The address of the node which this message is intended for. This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # OutgoingMessageTTL Property ([AMQP](#amqp-component) Component) The time-to-live value for this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageTTL(OutgoingMessageIndex int32) (int64, error) ``` ## Default Value -1 ## Remarks The time-to-live value for this message. This property specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **int64** # OutgoingMessageUserId Property ([AMQP](#amqp-component) Component) The identity of the user responsible for producing this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageUserId(OutgoingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks The identity of the user responsible for producing this message. This property specifies the identity of the user responsible for producing this message. It may be empty if no specific user was responsible for creating this message. A message's user Id *may* be used for verification or authentication by intermediates and/or the final receiver. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # OutgoingMessageValue Property ([AMQP](#amqp-component) Component) This message's value. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageValue(OutgoingMessageIndex int32) (string, error) ``` ## Default Value "" ## Remarks This message's value. This property specifies the value to send in this message. The [OutgoingMessageValueType](#outgoingmessagevaluetype-property-amqp-component) property should be used to specify the data type of the value. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **string** # OutgoingMessageValueType Property ([AMQP](#amqp-component) Component) This message's value data type. ## Syntax *Go Syntax* ```text func (obj *AMQP) OutgoingMessageValueType(OutgoingMessageIndex int32) (int32, error) ``` ## Possible Values ```text 0 // Null1 // Boolean2 // Ubyte3 // Ushort4 // Uint5 // Ulong6 // Byte7 // Short8 // Int9 // Long10 // Float11 // Double12 // Decimal13 // Char14 // Timestamp15 // Uuid16 // Binary17 // String18 // Symbol19 // Json20 // Data ``` ## Default Value 0 ## Remarks This message's value data type. This property specifies the data type of this message's [OutgoingMessageValue](#outgoingmessagevalue-property-amqp-component). The table below shows the possible value types, their descriptions, and how to format the data assigned to [OutgoingMessageValue](#outgoingmessagevalue-property-amqp-component). All numeric value types should use their standard string formatting (except for the *mvtDecimal (12)* type, which should be specified as hex-encoded bytes). | Type | Description | Value Format | | --- | --- | --- | | mvtNull (0 - default) | Null | N/A ([OutgoingMessageValue](#outgoingmessagevalue-property-amqp-component) is ignored) | | mvtBoolean (1) | Boolean | "True" or "False" | | mvtUbyte (2) | Unsigned byte | 0 to 255 | | mvtUshort (3) | Unsigned short | 0 to 65535 | | mvtUint (4) | Unsigned integer | 0 to 4294967295 | | mvtUlong (5) | Unsigned long | 0 to 18446744073709551615 | | mvtByte (6) | Byte | -128 to 127 | | mvtShort (7) | Short | -32768 to 32767 | | mvtInt (8) | Integer | -2147483648 to 2147483647 | | mvtLong (9) | Long | -9223372036854775808 to 9223372036854775807 | | mvtFloat (10) | Float | IEEE 754 32-bit floating point number | | mvtDouble (11) | Double | IEEE 754 64-bit floating point number | | mvtDecimal (12) | Decimal | Hex-encoded byte string | | mvtChar (13) | Char | Single character | | mvtTimestamp (14) | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). | | mvtUuid (15) | UUID | Hex-encoded UUID in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX (hyphens optional, case-insensitive) | | mvtBinary (16) | Binary data | Hex-encoded byte string | | mvtString (17) | String | String | | mvtSymbol (18) | Symbolic value | ASCII string | | mvtJson (19) | Composite data | Composite data JSON structured according to the schema shown in the [SendMessage](#sendmessage-method-amqp-component) method's documentation | | mvtData (20) | Opaque binary data | Hex-encoded byte string or utf-8 string | The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoingmessagecount-property-amqp-component) property. This property is read-only. ## Data Type **int32** # Password Property ([AMQP](#amqp-component) Component) A password to use for SASL authentication. ## Syntax *Go Syntax* ```text func (obj *AMQP) Password() (string, error)func (obj *AMQP) SetPassword(value string) error ``` ## Default Value "" ## Remarks This property contains a password to use for SASL authentication. ## Data Type **string** # ReadyToSend Property ([AMQP](#amqp-component) Component) Indicates whether the class is ready to send data. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReadyToSend() (bool, error) ``` ## Default Value false ## Remarks This property indicates that the underlying TCP/IP subsystem is ready to accept data. This is *True* after connecting to the remote host, and will become *False* if a call to [SendMessage](#sendmessage-method-amqp-component) fails due to a WOULDBLOCK condition. Once data can be sent again, the ReadyToSend event will fire and this property will be *True*. If a WOULDBLOCK error occurs while sending a message the struct will automatically complete the transmission when sending is possible. No action needs to be taken to re-send the message. ReadyToSend will fire after the struct completes any partially sent messages. This property is read-only. ## Data Type **bool** # ReceivedMessageAbsoluteExpiryTime Property ([AMQP](#amqp-component) Component) The absolute time at which this message should be considered expired. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageAbsoluteExpiryTime() (int64, error) ``` ## Default Value 0 ## Remarks The absolute time at which this message should be considered expired. This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time. This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC). This property is read-only. ## Data Type **int64** # ReceivedMessageContentEncoding Property ([AMQP](#amqp-component) Component) The content encoding of this message's data. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageContentEncoding() (string, error) ``` ## Default Value "" ## Remarks The content encoding of this message's data. This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set. When constructing a message for sending, this property is ignored if [ReceivedMessageValueType](#receivedmessagevaluetype-property-amqp-component) is not set to *mvtData (20)*. This property is read-only. ## Data Type **string** # ReceivedMessageContentType Property ([AMQP](#amqp-component) Component) The content type of this message's data. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageContentType() (string, error) ``` ## Default Value "" ## Remarks The content type of this message's data. This property specifies the content type of this message's data. It may be empty if this message does not have a content type set. When constructing a message for sending, this property is ignored if [ReceivedMessageValueType](#receivedmessagevaluetype-property-amqp-component) is not set to *mvtData (20)*. This property is read-only. ## Data Type **string** # ReceivedMessageCorrelationId Property ([AMQP](#amqp-component) Component) The correlation Id of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageCorrelationId() (string, error) ``` ## Default Value "" ## Remarks The correlation Id of this message. This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id. This property is read-only. ## Data Type **string** # ReceivedMessageCreationTime Property ([AMQP](#amqp-component) Component) The creation time of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageCreationTime() (int64, error) ``` ## Default Value 0 ## Remarks The creation time of this message. This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set. This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC). This property is read-only. ## Data Type **int64** # ReceivedMessageDeliveryCount Property ([AMQP](#amqp-component) Component) How many previous attempts there have been to deliver this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageDeliveryCount() (int64, error) ``` ## Default Value 0 ## Remarks How many previous attempts there have been to deliver this message. This property indicates how many (unsuccessful) previous attempts there have been to deliver this message. This property is read-only. ## Data Type **int64** # ReceivedMessageDurable Property ([AMQP](#amqp-component) Component) Whether this message is durable. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageDurable() (bool, error) ``` ## Default Value false ## Remarks Whether this message is durable. This property specifies whether this message is durable or not. If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message. This property is read-only. ## Data Type **bool** # ReceivedMessageFirstAcquirer Property ([AMQP](#amqp-component) Component) Whether this message may have been acquired by other links previously. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageFirstAcquirer() (bool, error) ``` ## Default Value false ## Remarks Whether this message may have been acquired by other links previously. This property specifies whether this message might have previously been acquired by other links. This property is read-only. ## Data Type **bool** # ReceivedMessageGroupId Property ([AMQP](#amqp-component) Component) The Id of the group this message belongs to. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageGroupId() (string, error) ``` ## Default Value "" ## Remarks The Id of the group this message belongs to. This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group. This property is read-only. ## Data Type **string** # ReceivedMessageGroupSequence Property ([AMQP](#amqp-component) Component) The position of this message within its group. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageGroupSequence() (int64, error) ``` ## Default Value 0 ## Remarks The position of this message within its group. This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group. This property is read-only. ## Data Type **int64** # ReceivedMessageLinkName Property ([AMQP](#amqp-component) Component) The name of the link this message is associated with. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageLinkName() (string, error) ``` ## Default Value "" ## Remarks The name of the link this message is associated with. This property holds the name of the link which this message is being sent/was received on. This property is read-only. ## Data Type **string** # ReceivedMessageId Property ([AMQP](#amqp-component) Component) The unique Id of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageId() (string, error) ``` ## Default Value "" ## Remarks The unique Id of this message. This property holds the unique Id of this message. It may be empty if this message does not have a unique Id. This property is read-only. ## Data Type **string** # ReceivedMessagePriority Property ([AMQP](#amqp-component) Component) The priority of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessagePriority() (int32, error) ``` ## Default Value 4 ## Remarks The priority of this message. This property holds the priority of this message; the default is 4 (as defined by the AMQP specification). This property is read-only. ## Data Type **int32** # ReceivedMessageReplyTo Property ([AMQP](#amqp-component) Component) The address of the node to send replies to for this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageReplyTo() (string, error) ``` ## Default Value "" ## Remarks The address of the node to send replies to for this message. This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address. This property is read-only. ## Data Type **string** # ReceivedMessageReplyToGroupId Property ([AMQP](#amqp-component) Component) The Id of the group to send replies to for this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageReplyToGroupId() (string, error) ``` ## Default Value "" ## Remarks The Id of the group to send replies to for this message. This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message. This property is read-only. ## Data Type **string** # ReceivedMessageSettled Property ([AMQP](#amqp-component) Component) Whether this message is settled. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageSettled() (bool, error) ``` ## Default Value true ## Remarks Whether this message is settled. This property specifies whether this message is settled or not. Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not *Mixed (2)*. This property is read-only. ## Data Type **bool** # ReceivedMessageSubject Property ([AMQP](#amqp-component) Component) The subject of this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageSubject() (string, error) ``` ## Default Value "" ## Remarks The subject of this message. This property specifies the subject of this message. It may be empty if this message does not have a subject set. This property is read-only. ## Data Type **string** # ReceivedMessageTo Property ([AMQP](#amqp-component) Component) The address of the node which this message is intended for. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageTo() (string, error) ``` ## Default Value "" ## Remarks The address of the node which this message is intended for. This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node. This property is read-only. ## Data Type **string** # ReceivedMessageTTL Property ([AMQP](#amqp-component) Component) The time-to-live value for this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageTTL() (int64, error) ``` ## Default Value -1 ## Remarks The time-to-live value for this message. This property specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL. This property is read-only. ## Data Type **int64** # ReceivedMessageUserId Property ([AMQP](#amqp-component) Component) The identity of the user responsible for producing this message. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageUserId() (string, error) ``` ## Default Value "" ## Remarks The identity of the user responsible for producing this message. This property specifies the identity of the user responsible for producing this message. It may be empty if no specific user was responsible for creating this message. A message's user Id *may* be used for verification or authentication by intermediates and/or the final receiver. This property is read-only. ## Data Type **string** # ReceivedMessageValue Property ([AMQP](#amqp-component) Component) This message's value. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageValue() (string, error) ``` ## Default Value "" ## Remarks This message's value. This property specifies the value to send in this message. The [ReceivedMessageValueType](#receivedmessagevaluetype-property-amqp-component) property should be used to specify the data type of the value. This property is read-only. ## Data Type **string** # ReceivedMessageValueType Property ([AMQP](#amqp-component) Component) This message's value data type. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceivedMessageValueType() (int32, error) ``` ## Possible Values ```text 0 // Null1 // Boolean2 // Ubyte3 // Ushort4 // Uint5 // Ulong6 // Byte7 // Short8 // Int9 // Long10 // Float11 // Double12 // Decimal13 // Char14 // Timestamp15 // Uuid16 // Binary17 // String18 // Symbol19 // Json20 // Data ``` ## Default Value 0 ## Remarks This message's value data type. This property specifies the data type of this message's [ReceivedMessageValue](#receivedmessagevalue-property-amqp-component). The table below shows the possible value types, their descriptions, and how to format the data assigned to [ReceivedMessageValue](#receivedmessagevalue-property-amqp-component). All numeric value types should use their standard string formatting (except for the *mvtDecimal (12)* type, which should be specified as hex-encoded bytes). | Type | Description | Value Format | | --- | --- | --- | | mvtNull (0 - default) | Null | N/A ([ReceivedMessageValue](#receivedmessagevalue-property-amqp-component) is ignored) | | mvtBoolean (1) | Boolean | "True" or "False" | | mvtUbyte (2) | Unsigned byte | 0 to 255 | | mvtUshort (3) | Unsigned short | 0 to 65535 | | mvtUint (4) | Unsigned integer | 0 to 4294967295 | | mvtUlong (5) | Unsigned long | 0 to 18446744073709551615 | | mvtByte (6) | Byte | -128 to 127 | | mvtShort (7) | Short | -32768 to 32767 | | mvtInt (8) | Integer | -2147483648 to 2147483647 | | mvtLong (9) | Long | -9223372036854775808 to 9223372036854775807 | | mvtFloat (10) | Float | IEEE 754 32-bit floating point number | | mvtDouble (11) | Double | IEEE 754 64-bit floating point number | | mvtDecimal (12) | Decimal | Hex-encoded byte string | | mvtChar (13) | Char | Single character | | mvtTimestamp (14) | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). | | mvtUuid (15) | UUID | Hex-encoded UUID in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX (hyphens optional, case-insensitive) | | mvtBinary (16) | Binary data | Hex-encoded byte string | | mvtString (17) | String | String | | mvtSymbol (18) | Symbolic value | ASCII string | | mvtJson (19) | Composite data | Composite data JSON structured according to the schema shown in the [SendMessage](#sendmessage-method-amqp-component) method's documentation | | mvtData (20) | Opaque binary data | Hex-encoded byte string or utf-8 string | This property is read-only. ## Data Type **int32** # ReceiveMode Property ([AMQP](#amqp-component) Component) Controls what mode new receiver links are created with. ## Syntax *Go Syntax* ```text func (obj *AMQP) ReceiveMode() (int32, error)func (obj *AMQP) SetReceiveMode(value int32) error ``` ## Possible Values ```text 0 // Automatic1 // Retrieve ``` ## Default Value 0 ## Remarks This property controls which receive mode newly created receiver links should use to receive messages from the sender. Valid values are: - rmAutomatic (0 - default) - rmRetrieve (1) ### Receiving Messages Automatically A receiver link operating in *rmAutomatic (0)* mode strives to ensure that the sender always has sufficient credit so that messages are received as soon as they are available, thus simulating a "subscription-based"/"push-based" messaging model. In this mode, receiver links will be created with the amount of credit, and the credit threshold, specified by the [DefaultCredit](#DefaultCredit) and [DefaultCreditThreshold](#DefaultCreditThreshold) configuration settings. Anytime the link's credit reaches the credit threshold, the struct will automatically set it back to its initial value. ### Retrieving Messages On-Demand A receiver link operating in *rmRetrieve (1)* mode requires the [RetrieveMessage](#retrievemessage-method-amqp-component) method to be called in order for a message to be received, thus simulating a "polling"/"pull-based" messaging model. In this mode, receiver links will be created with no credit (regardless of what [DefaultCredit](#DefaultCredit) is set to). When [RetrieveMessage](#retrievemessage-method-amqp-component) is called, the struct will supply the sender with a single credit and then block until a message is received (if the [RetrieveTimeout](#retrievetimeout-property-amqp-component) property is set to zero). If [RetrieveTimeout](#retrievetimeout-property-amqp-component) is non-zero, the struct will only block for the specified number of seconds; once that time expires, it will instruct the sender to consume the credit. If the sender chooses to consume the credit by incrementing the value of the **LinkDeliveryCount** property rather than by sending a message, then the struct will throw an error indicating a timeout. Refer to [RetrieveMessage](#retrievemessage-method-amqp-component) and [RetrieveTimeout](#retrievetimeout-property-amqp-component) for more information. ```text amqp.ReceiveMode = AmqpReceiveModes.rmRetrieve; amqp.CreateReceiverLink("SessionID", "ReceiverLinkName", "SomeTarget"); ``` ## Data Type **int32** # RemoteHost Property ([AMQP](#amqp-component) Component) This property includes the address of the remote host. Domain names are resolved to IP addresses. ## Syntax *Go Syntax* ```text func (obj *AMQP) RemoteHost() (string, error)func (obj *AMQP) SetRemoteHost(value string) error ``` ## Default Value "" ## Remarks This property specifies the IP address (IP number in dotted internet format) or the domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established. If this property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned. If the struct is configured to use a *SOCKS* firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution. **Example. Connecting:** ```text TCPClientControl.RemoteHost = "MyHostNameOrIP" TCPClientControl.RemotePort = 777 TCPClientControl.Connected = true ``` ## Data Type **string** # RemotePort Property ([AMQP](#amqp-component) Component) The port of the AMQP server (default is 5672). The default port for SSL is 5671. ## Syntax *Go Syntax* ```text func (obj *AMQP) RemotePort() (int32, error)func (obj *AMQP) SetRemotePort(value int32) error ``` ## Default Value 5672 ## Remarks This property specifies a service port on the remote host to connect to. A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error. ## Data Type **int32** # RetrieveTimeout Property ([AMQP](#amqp-component) Component) How long the class should wait for a message to be received after RetrieveMessage is called. ## Syntax *Go Syntax* ```text func (obj *AMQP) RetrieveTimeout() (int32, error)func (obj *AMQP) SetRetrieveTimeout(value int32) error ``` ## Default Value 60 ## Remarks This property controls how long, in seconds, the struct will wait for a message to be received after [RetrieveMessage](#retrievemessage-method-amqp-component) is called before timing out the request. If set to zero, the struct will wait indefinitely. Refer to [RetrieveMessage](#retrievemessage-method-amqp-component) for more information. ## Data Type **int32** # SessionCount Property ([AMQP](#amqp-component) Component) The number of records in the Session arrays. ## Syntax *Go Syntax* ```text func (obj *AMQP) SessionCount() (int32, error) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [SessionIncomingWindow](#sessionincomingwindow-property-amqp-component) - [SessionName](#sessionname-property-amqp-component) - [SessionOutgoingWindow](#sessionoutgoingwindow-property-amqp-component) The array indices start at *0* and end at *SessionCount - 1*. This property is read-only. ## Data Type **int32** # SessionIncomingWindow Property ([AMQP](#amqp-component) Component) The incoming window size of this session. ## Syntax *Go Syntax* ```text func (obj *AMQP) SessionIncomingWindow(SessionIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks The incoming window size of this session. This property holds the incoming window size (in frames) of this session. The *SessionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SessionCount](#sessioncount-property-amqp-component) property. This property is read-only. ## Data Type **int64** # SessionName Property ([AMQP](#amqp-component) Component) The name of this session. ## Syntax *Go Syntax* ```text func (obj *AMQP) SessionName(SessionIndex int32) (string, error) ``` ## Default Value "" ## Remarks The name of this session. This property holds the name of this session. The *SessionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SessionCount](#sessioncount-property-amqp-component) property. This property is read-only. ## Data Type **string** # SessionOutgoingWindow Property ([AMQP](#amqp-component) Component) The outgoing window size of this session. ## Syntax *Go Syntax* ```text func (obj *AMQP) SessionOutgoingWindow(SessionIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks The outgoing window size of this session. This property holds the outgoing window size (in frames) of this session. The *SessionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SessionCount](#sessioncount-property-amqp-component) property. This property is read-only. ## Data Type **int64** # SSLAcceptServerCertEffectiveDate Property ([AMQP](#amqp-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertEffectiveDate() (string, error) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type **string** # SSLAcceptServerCertExpirationDate Property ([AMQP](#amqp-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertExpirationDate() (string, error) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type **string** # SSLAcceptServerCertExtendedKeyUsage Property ([AMQP](#amqp-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertExtendedKeyUsage() (string, error) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type **string** # SSLAcceptServerCertFingerprint Property ([AMQP](#amqp-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertFingerprint() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type **string** # SSLAcceptServerCertFingerprintSHA1 Property ([AMQP](#amqp-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertFingerprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type **string** # SSLAcceptServerCertFingerprintSHA256 Property ([AMQP](#amqp-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertFingerprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type **string** # SSLAcceptServerCertIssuer Property ([AMQP](#amqp-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertIssuer() (string, error) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPrivateKey Property ([AMQP](#amqp-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertPrivateKey() (string, error) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-amqp-component) may be available but not exportable. In this case, [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-amqp-component) returns an empty string. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPrivateKeyAvailable Property ([AMQP](#amqp-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-amqp-component) is available for the selected certificate. If [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-amqp-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type **bool** # SSLAcceptServerCertPrivateKeyContainer Property ([AMQP](#amqp-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-amqp-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPublicKey Property ([AMQP](#amqp-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertPublicKey() (string, error) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPublicKeyAlgorithm Property ([AMQP](#amqp-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertPublicKeyAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPublicKeyLength Property ([AMQP](#amqp-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertPublicKeyLength() (int32, error) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type **int32** # SSLAcceptServerCertSerialNumber Property ([AMQP](#amqp-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertSerialNumber() (string, error) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type **string** # SSLAcceptServerCertSignatureAlgorithm Property ([AMQP](#amqp-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertSignatureAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLAcceptServerCertStore Property ([AMQP](#amqp-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertStore() ([]byte, error)func (obj *AMQP) SetSSLAcceptServerCertStore(value []byte) error ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-amqp-component) property denotes the type of the certificate store specified by [SSLAcceptServerCertStore](#sslacceptservercertstore-property-amqp-component). If the store is password-protected, specify the password in [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-amqp-component). [SSLAcceptServerCertStore](#sslacceptservercertstore-property-amqp-component) is used in conjunction with the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-amqp-component) property to specify client certificates. If [SSLAcceptServerCertStore](#sslacceptservercertstore-property-amqp-component) has a value, and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-amqp-component) or [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-amqp-component) is set, a search for a certificate is initiated. Please see the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-amqp-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). ## Data Type **[]byte** # SSLAcceptServerCertStorePassword Property ([AMQP](#amqp-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertStorePassword() (string, error)func (obj *AMQP) SetSSLAcceptServerCertStorePassword(value string) error ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type **string** # SSLAcceptServerCertStoreType Property ([AMQP](#amqp-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertStoreType() (int32, error)func (obj *AMQP) SetSSLAcceptServerCertStoreType(value int32) error ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-amqp-component), the full path of the PKCS#11 DLL as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-amqp-component), and the PIN as the [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-amqp-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-amqp-component) and set [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-amqp-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type **int32** # SSLAcceptServerCertSubjectAltNames Property ([AMQP](#amqp-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertSubjectAltNames() (string, error) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type **string** # SSLAcceptServerCertThumbprintMD5 Property ([AMQP](#amqp-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertThumbprintMD5() (string, error) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLAcceptServerCertThumbprintSHA1 Property ([AMQP](#amqp-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertThumbprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLAcceptServerCertThumbprintSHA256 Property ([AMQP](#amqp-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertThumbprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLAcceptServerCertUsage Property ([AMQP](#amqp-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-amqp-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type **string** # SSLAcceptServerCertUsageFlags Property ([AMQP](#amqp-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-amqp-component) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-amqp-component) property for a text representation of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-amqp-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLAcceptServerCertVersion Property ([AMQP](#amqp-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertVersion() (string, error) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type **string** # SSLAcceptServerCertSubject Property ([AMQP](#amqp-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertSubject() (string, error)func (obj *AMQP) SetSSLAcceptServerCertSubject(value string) error ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type **string** # SSLAcceptServerCertEncoded Property ([AMQP](#amqp-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLAcceptServerCertEncoded() ([]byte, error)func (obj *AMQP) SetSSLAcceptServerCertEncoded(value []byte) error ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLAcceptServerCertStore](#sslacceptservercertstore-property-amqp-component) and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-amqp-component) properties also may be used to specify a certificate. When [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-amqp-component) is set, a search is initiated in the current [SSLAcceptServerCertStore](#sslacceptservercertstore-property-amqp-component) for the private key of the certificate. If the key is found, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-amqp-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-amqp-component) is set to an empty string. ## Data Type **[]byte** # SSLCertEffectiveDate Property ([AMQP](#amqp-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertEffectiveDate() (string, error) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type **string** # SSLCertExpirationDate Property ([AMQP](#amqp-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertExpirationDate() (string, error) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type **string** # SSLCertExtendedKeyUsage Property ([AMQP](#amqp-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertExtendedKeyUsage() (string, error) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type **string** # SSLCertFingerprint Property ([AMQP](#amqp-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertFingerprint() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type **string** # SSLCertFingerprintSHA1 Property ([AMQP](#amqp-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertFingerprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type **string** # SSLCertFingerprintSHA256 Property ([AMQP](#amqp-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertFingerprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type **string** # SSLCertIssuer Property ([AMQP](#amqp-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertIssuer() (string, error) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type **string** # SSLCertPrivateKey Property ([AMQP](#amqp-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertPrivateKey() (string, error) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLCertPrivateKey](#sslcertprivatekey-property-amqp-component) may be available but not exportable. In this case, [SSLCertPrivateKey](#sslcertprivatekey-property-amqp-component) returns an empty string. This property is read-only. ## Data Type **string** # SSLCertPrivateKeyAvailable Property ([AMQP](#amqp-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SSLCertPrivateKey](#sslcertprivatekey-property-amqp-component) is available for the selected certificate. If [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-amqp-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type **bool** # SSLCertPrivateKeyContainer Property ([AMQP](#amqp-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SSLCertPrivateKey](#sslcertprivatekey-property-amqp-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type **string** # SSLCertPublicKey Property ([AMQP](#amqp-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertPublicKey() (string, error) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type **string** # SSLCertPublicKeyAlgorithm Property ([AMQP](#amqp-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertPublicKeyAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLCertPublicKeyLength Property ([AMQP](#amqp-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertPublicKeyLength() (int32, error) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type **int32** # SSLCertSerialNumber Property ([AMQP](#amqp-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertSerialNumber() (string, error) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type **string** # SSLCertSignatureAlgorithm Property ([AMQP](#amqp-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertSignatureAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLCertStore Property ([AMQP](#amqp-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertStore() ([]byte, error)func (obj *AMQP) SetSSLCertStore(value []byte) error ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLCertStoreType](#sslcertstoretype-property-amqp-component) property denotes the type of the certificate store specified by [SSLCertStore](#sslcertstore-property-amqp-component). If the store is password-protected, specify the password in [SSLCertStorePassword](#sslcertstorepassword-property-amqp-component). [SSLCertStore](#sslcertstore-property-amqp-component) is used in conjunction with the [SSLCertSubject](#sslcertsubject-property-amqp-component) property to specify client certificates. If [SSLCertStore](#sslcertstore-property-amqp-component) has a value, and [SSLCertSubject](#sslcertsubject-property-amqp-component) or [SSLCertEncoded](#sslcertencoded-property-amqp-component) is set, a search for a certificate is initiated. Please see the [SSLCertSubject](#sslcertsubject-property-amqp-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). ## Data Type **[]byte** # SSLCertStorePassword Property ([AMQP](#amqp-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertStorePassword() (string, error)func (obj *AMQP) SetSSLCertStorePassword(value string) error ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type **string** # SSLCertStoreType Property ([AMQP](#amqp-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertStoreType() (int32, error)func (obj *AMQP) SetSSLCertStoreType(value int32) error ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLCertStoreType](#sslcertstoretype-property-amqp-component), the full path of the PKCS#11 DLL as the [SSLCertStore](#sslcertstore-property-amqp-component), and the PIN as the [SSLCertStorePassword](#sslcertstorepassword-property-amqp-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLCertStore](#sslcertstore-property-amqp-component) and set [SSLCertStorePassword](#sslcertstorepassword-property-amqp-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type **int32** # SSLCertSubjectAltNames Property ([AMQP](#amqp-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertSubjectAltNames() (string, error) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type **string** # SSLCertThumbprintMD5 Property ([AMQP](#amqp-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertThumbprintMD5() (string, error) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLCertThumbprintSHA1 Property ([AMQP](#amqp-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertThumbprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLCertThumbprintSHA256 Property ([AMQP](#amqp-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertThumbprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLCertUsage Property ([AMQP](#amqp-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLCertUsageFlags](#sslcertusageflags-property-amqp-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type **string** # SSLCertUsageFlags Property ([AMQP](#amqp-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLCertUsageFlags](#sslcertusageflags-property-amqp-component) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [SSLCertUsage](#sslcertusage-property-amqp-component) property for a text representation of [SSLCertUsageFlags](#sslcertusageflags-property-amqp-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLCertVersion Property ([AMQP](#amqp-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertVersion() (string, error) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type **string** # SSLCertSubject Property ([AMQP](#amqp-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertSubject() (string, error)func (obj *AMQP) SetSSLCertSubject(value string) error ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type **string** # SSLCertEncoded Property ([AMQP](#amqp-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLCertEncoded() ([]byte, error)func (obj *AMQP) SetSSLCertEncoded(value []byte) error ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLCertStore](#sslcertstore-property-amqp-component) and [SSLCertSubject](#sslcertsubject-property-amqp-component) properties also may be used to specify a certificate. When [SSLCertEncoded](#sslcertencoded-property-amqp-component) is set, a search is initiated in the current [SSLCertStore](#sslcertstore-property-amqp-component) for the private key of the certificate. If the key is found, [SSLCertSubject](#sslcertsubject-property-amqp-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLCertSubject](#sslcertsubject-property-amqp-component) is set to an empty string. ## Data Type **[]byte** # SSLEnabled Property ([AMQP](#amqp-component) Component) This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLEnabled() (bool, error)func (obj *AMQP) SetSSLEnabled(value bool) error ``` ## Default Value false ## Remarks This property specifies whether TLS/SSL is enabled in the struct. When False (default), the struct operates in plaintext mode. When True, TLS/SSL is enabled. TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value. If the default port (5672) is selected when SSLEnabled is set to true, the port will automatically be changed to the default port for AMQP with SSL (5671). Likewise, if port 5671 is selected when SSLEnabled is set to false, the port will automatically be changed to the default port. If the port has been set to any value other than the default values, it will remain the same when the value of SSLEnabled changes. ## Data Type **bool** # SSLProvider Property ([AMQP](#amqp-component) Component) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLProvider() (int32, error)func (obj *AMQP) SetSSLProvider(value int32) error ``` ## Possible Values ```text 0 // Automatic1 // Platform2 // Internal ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform. When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. ## Data Type **int32** # SSLServerCertEffectiveDate Property ([AMQP](#amqp-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertEffectiveDate() (string, error) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type **string** # SSLServerCertExpirationDate Property ([AMQP](#amqp-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertExpirationDate() (string, error) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type **string** # SSLServerCertExtendedKeyUsage Property ([AMQP](#amqp-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertExtendedKeyUsage() (string, error) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type **string** # SSLServerCertFingerprint Property ([AMQP](#amqp-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertFingerprint() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type **string** # SSLServerCertFingerprintSHA1 Property ([AMQP](#amqp-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertFingerprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type **string** # SSLServerCertFingerprintSHA256 Property ([AMQP](#amqp-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertFingerprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type **string** # SSLServerCertIssuer Property ([AMQP](#amqp-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertIssuer() (string, error) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type **string** # SSLServerCertPrivateKey Property ([AMQP](#amqp-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertPrivateKey() (string, error) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLServerCertPrivateKey](#sslservercertprivatekey-property-amqp-component) may be available but not exportable. In this case, [SSLServerCertPrivateKey](#sslservercertprivatekey-property-amqp-component) returns an empty string. This property is read-only. ## Data Type **string** # SSLServerCertPrivateKeyAvailable Property ([AMQP](#amqp-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SSLServerCertPrivateKey](#sslservercertprivatekey-property-amqp-component) is available for the selected certificate. If [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-amqp-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type **bool** # SSLServerCertPrivateKeyContainer Property ([AMQP](#amqp-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SSLServerCertPrivateKey](#sslservercertprivatekey-property-amqp-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type **string** # SSLServerCertPublicKey Property ([AMQP](#amqp-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertPublicKey() (string, error) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type **string** # SSLServerCertPublicKeyAlgorithm Property ([AMQP](#amqp-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertPublicKeyAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLServerCertPublicKeyLength Property ([AMQP](#amqp-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertPublicKeyLength() (int32, error) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type **int32** # SSLServerCertSerialNumber Property ([AMQP](#amqp-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertSerialNumber() (string, error) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type **string** # SSLServerCertSignatureAlgorithm Property ([AMQP](#amqp-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertSignatureAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLServerCertStore Property ([AMQP](#amqp-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertStore() ([]byte, error) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLServerCertStoreType](#sslservercertstoretype-property-amqp-component) property denotes the type of the certificate store specified by [SSLServerCertStore](#sslservercertstore-property-amqp-component). If the store is password-protected, specify the password in [SSLServerCertStorePassword](#sslservercertstorepassword-property-amqp-component). [SSLServerCertStore](#sslservercertstore-property-amqp-component) is used in conjunction with the [SSLServerCertSubject](#sslservercertsubject-property-amqp-component) property to specify client certificates. If [SSLServerCertStore](#sslservercertstore-property-amqp-component) has a value, and [SSLServerCertSubject](#sslservercertsubject-property-amqp-component) or [SSLServerCertEncoded](#sslservercertencoded-property-amqp-component) is set, a search for a certificate is initiated. Please see the [SSLServerCertSubject](#sslservercertsubject-property-amqp-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). This property is read-only. ## Data Type **[]byte** # SSLServerCertStorePassword Property ([AMQP](#amqp-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertStorePassword() (string, error) ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. This property is read-only. ## Data Type **string** # SSLServerCertStoreType Property ([AMQP](#amqp-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertStoreType() (int32, error) ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLServerCertStoreType](#sslservercertstoretype-property-amqp-component), the full path of the PKCS#11 DLL as the [SSLServerCertStore](#sslservercertstore-property-amqp-component), and the PIN as the [SSLServerCertStorePassword](#sslservercertstorepassword-property-amqp-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLServerCertStore](#sslservercertstore-property-amqp-component) and set [SSLServerCertStorePassword](#sslservercertstorepassword-property-amqp-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | This property is read-only. ## Data Type **int32** # SSLServerCertSubjectAltNames Property ([AMQP](#amqp-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertSubjectAltNames() (string, error) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type **string** # SSLServerCertThumbprintMD5 Property ([AMQP](#amqp-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertThumbprintMD5() (string, error) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLServerCertThumbprintSHA1 Property ([AMQP](#amqp-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertThumbprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLServerCertThumbprintSHA256 Property ([AMQP](#amqp-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertThumbprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLServerCertUsage Property ([AMQP](#amqp-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLServerCertUsageFlags](#sslservercertusageflags-property-amqp-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type **string** # SSLServerCertUsageFlags Property ([AMQP](#amqp-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLServerCertUsageFlags](#sslservercertusageflags-property-amqp-component) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [SSLServerCertUsage](#sslservercertusage-property-amqp-component) property for a text representation of [SSLServerCertUsageFlags](#sslservercertusageflags-property-amqp-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLServerCertVersion Property ([AMQP](#amqp-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertVersion() (string, error) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type **string** # SSLServerCertSubject Property ([AMQP](#amqp-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertSubject() (string, error) ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. This property is read-only. ## Data Type **string** # SSLServerCertEncoded Property ([AMQP](#amqp-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *AMQP) SSLServerCertEncoded() ([]byte, error) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLServerCertStore](#sslservercertstore-property-amqp-component) and [SSLServerCertSubject](#sslservercertsubject-property-amqp-component) properties also may be used to specify a certificate. When [SSLServerCertEncoded](#sslservercertencoded-property-amqp-component) is set, a search is initiated in the current [SSLServerCertStore](#sslservercertstore-property-amqp-component) for the private key of the certificate. If the key is found, [SSLServerCertSubject](#sslservercertsubject-property-amqp-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLServerCertSubject](#sslservercertsubject-property-amqp-component) is set to an empty string. This property is read-only. ## Data Type **[]byte** # Timeout Property ([AMQP](#amqp-component) Component) This property includes the timeout for the class. ## Syntax *Go Syntax* ```text func (obj *AMQP) Timeout() (int32, error)func (obj *AMQP) SetTimeout(value int32) error ``` ## Default Value 60 ## Remarks If the Timeout property is set to 0, all operations return immediately, potentially failing with a *WOULDBLOCK* error if data cannot be sent immediately. If Timeout is set to a positive value, data is sent in a blocking manner and the struct will wait for the operation to complete before returning control. The struct will handle any potential *WOULDBLOCK* errors internally and automatically retry the operation for a maximum of Timeout seconds. The struct will use [DoEvents](#doevents-method-amqp-component) to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive. If Timeout expires, and the operation is not yet complete, the struct fails with an error. NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the Timeout property is 60 seconds. ## Data Type **int32** # User Property ([AMQP](#amqp-component) Component) A username to use for SASL authentication. ## Syntax *Go Syntax* ```text func (obj *AMQP) User() (string, error)func (obj *AMQP) SetUser(value string) error ``` ## Default Value "" ## Remarks This property contains a username to use for SASL authentication. ## Data Type **string** # CloseLink Method ([AMQP](#amqp-component) Component) Closes a link. ## Syntax *Go Syntax* ```text func (obj *AMQP) CloseLink(Name string) error ``` ## Remarks This method closes the link named *Name* and removes it from the Links properties. If no link with the given *Name* exists, an error will be thrown. # CloseSession Method ([AMQP](#amqp-component) Component) Closes a session. ## Syntax *Go Syntax* ```text func (obj *AMQP) CloseSession(Name string) error ``` ## Remarks This method closes the session named *Name* and removes it from the Sessions properties. If no session with the given *Name* exists, an error will be thrown. Any links open on the specified session when this method is called will be automatically closed and removed from the Links properties. # Config Method ([AMQP](#amqp-component) Component) Sets or retrieves a configuration setting. ## Syntax *Go Syntax* ```text func (obj *AMQP) Config(ConfigurationString string) (string, error) ``` ## Remarks Config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-amqp-component) for the struct. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-amqp-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # Connect Method ([AMQP](#amqp-component) Component) This method connects to a remote host. ## Syntax *Go Syntax* ```text func (obj *AMQP) Connect() error ``` ## Remarks This method connects to the remote host specified by [RemoteHost](#remotehost-property-amqp-component) and [RemotePort](#remoteport-property-amqp-component). For instance: ```text component.RemoteHost = "MyHostNameOrIP"; component.RemotePort = 7777; component.Connect(); ``` # ConnectTo Method ([AMQP](#amqp-component) Component) This method connects to a remote host. ## Syntax *Go Syntax* ```text func (obj *AMQP) ConnectTo(Host string, Port int32) error ``` ## Remarks This method connects to the remote host specified by the *Host* and *Port* parameters. For instance: ```text component.ConnectTo("MyHostNameOrIP", 777) ``` # CreateReceiverLink Method ([AMQP](#amqp-component) Component) Creates a new receiver link with the given name on the specified session. ## Syntax *Go Syntax* ```text func (obj *AMQP) CreateReceiverLink(SessionName string, Name string, Source string) error ``` ## Remarks This method creates a new receiver link with the given *Name* on the session specified by *SessionName* and adds it to the Links properties. If a link (sender or receiver) with the given *Name* already exists, or if no session with the given *SessionName* exists, an error will be thrown. *Source* may be set to specify the address of the node at the remote host which should act as the sender. This may not be necessary in all environments, in which case an empty string will suffice. Receiver links can operate in one of two receive modes: automatic, where the struct will work to ensure that messages are received as soon as they are available; and retrieve-based, where the struct will only "retrieve" a new message when explicitly instructed to. The [ReceiveMode](#receivemode-property-amqp-component) property controls which receive mode newly-created receiver links will use; refer to its documentation for more information. AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions. ```text amqp.ReceiveMode = AmqpReceiveModes.rmRetrieve; amqp.CreateReceiverLink("SessionID", "ReceiverLinkName", "SomeTarget"); ``` # CreateSenderLink Method ([AMQP](#amqp-component) Component) Creates a new sender link with the given name on the specified session. ## Syntax *Go Syntax* ```text func (obj *AMQP) CreateSenderLink(SessionName string, Name string, Target string) error ``` ## Remarks This method creates a new sender link with the given *Name* on the session specified by *SessionName* and adds it to the Links properties. If a link (sender or receiver) with the given *Name* already exists, or if no session with the given *SessionName* exists, an error will be thrown. *Target* may be set to specify the address of the node at the remote host which should act as the receiver. This may not be necessary in all environments, in which case an empty string will suffice. The [LinkReadyToSend](#linkreadytosend-event-amqp-component) event will fire when a newly-created sender link is ready to send. Sender links are created using the *Mixed* settle mode by default, letting the value of the [MessageSettled](#messagesettled-property-amqp-component) property control whether each message is settled (the default) or unsettled when it is sent. The [DefaultSenderSettleMode](#DefaultSenderSettleMode) configuration setting can be used to control the settle mode that new sender links are created with. Refer to [SendMessage](#sendmessage-method-amqp-component) for more information on message settlement in general. AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions. # CreateSession Method ([AMQP](#amqp-component) Component) Creates a new session with the given name. ## Syntax *Go Syntax* ```text func (obj *AMQP) CreateSession(Name string) error ``` ## Remarks This method creates a new session with the given *Name* and adds it to the Sessions properties. If a session with the given *Name* already exists, an error will be thrown. AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions. # Disconnect Method ([AMQP](#amqp-component) Component) This method disconnects from the remote host. ## Syntax *Go Syntax* ```text func (obj *AMQP) Disconnect() error ``` ## Remarks This method disconnects from the remote host. # DoEvents Method ([AMQP](#amqp-component) Component) This method processes events from the internal message queue. ## Syntax *Go Syntax* ```text func (obj *AMQP) DoEvents() error ``` ## Remarks When DoEvents is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns. # Interrupt Method ([AMQP](#amqp-component) Component) This method interrupts the current action. ## Syntax *Go Syntax* ```text func (obj *AMQP) Interrupt() error ``` ## Remarks This method interrupts the current action. If you use SendFile to upload a file, the struct will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the host. # Reset Method ([AMQP](#amqp-component) Component) This method will reset the class. ## Syntax *Go Syntax* ```text func (obj *AMQP) Reset() error ``` ## Remarks This method will reset the struct's properties to their default values. # ResetMessage Method ([AMQP](#amqp-component) Component) Resets the Message properties. ## Syntax *Go Syntax* ```text func (obj *AMQP) ResetMessage() error ``` ## Remarks This method resets the Message property. # RetrieveMessage Method ([AMQP](#amqp-component) Component) Retrieves a single message over the specified receiver link. ## Syntax *Go Syntax* ```text func (obj *AMQP) RetrieveMessage(LinkName string) error ``` ## Remarks When RetrieveMessage is called, the struct will supply the sender with a single credit and then block until a message is received (if the [RetrieveTimeout](#retrievetimeout-property-amqp-component) property is set to zero). If [RetrieveTimeout](#retrievetimeout-property-amqp-component) is non-zero, the struct will only block for the specified number of seconds; once that time expires, it will instruct the sender to consume the credit. If the sender chooses to consume the credit by incrementing the value of the **LinkDeliveryCount** property rather than by sending a message, then the struct will throw an error indicating a timeout. *LinkName* specifies the receiver link which should retrieve a message; if there is no such link, if the specified link is not a receiver link, or if the specified receiver link is not operating in *rmSyncGet (1)* mode, an error is thrown. Refer to [ReceiveMode](#receivemode-property-amqp-component) and [RetrieveTimeout](#retrievetimeout-property-amqp-component) for more information. # SendMessage Method ([AMQP](#amqp-component) Component) Sends a message on the specified link. ## Syntax *Go Syntax* ```text func (obj *AMQP) SendMessage(LinkName string) error ``` ## Remarks This method sends a message on the link specified by *LinkName*. The Message property holds an AMQPMessage object whose properties are used to construct the message to send. At minimum, specify a and a . ```text amqp.Message.ValueType = AMQPValueTypes.mvtString; amqp.Message.Value = "Hello World!"; amqp.SendMessage("SenderLinkName"); ``` ### Message Settlement AMQP provides the ability to negotiate delivery guarantees through the system of "message settlement". When a link is created, both the sender and the receiver negotiate a settle mode (one for each role) to use. Senders will operate in one of these modes: - *Settled* - All messages will be sent in a settled state. - *Unsettled* - All messages will be sent in an unsettled state. - *Mixed* - Messages may be sent either settled or unsettled. and receivers will operate in one of these modes: - *First* - Incoming messages will be settled immediately (and the sender will be notified that the message has been received, if the message was not already settled when sent). - *Second* - Incoming messages will be settled after the sender has settled them (and the sender will be notified when a message has been received, if the message was not already settled when sent). Together, the sender's and receiver's settle modes can form the following delivery guarantees: | Sender's Settle Mode | Receiver's Settle Mode | Effective Delivery Guarantee | | --- | --- | --- | | Settled | (Any) | At most once | | Unsettled | First | At least once | | Unsettled | Second | Exactly once | *(Note that, if the sender's settle mode is *Mixed*, the values in the "Sender's Settle Mode" column apply for each individual message.)* It is important to note that the message settlement system has a big caveat: Whichever party opens the link can only *request* that the other end use a specific settle mode. For example, if the struct opens a sender link, it has control over the sender settle mode it will use, but it can only request that the remote host use a specific receiver settle mode; so if the struct requests that the receiver use *Second*, the receiver can instead choose to use *First* (if, e.g., it doesn't support *Second*). The struct currently only ever requests (and itself only supports) the *First* receiver settle mode since no other AMQP implementations appear to support the *Second* receiver settle mode at this time. The struct requests (and uses) the *Mixed* sender settle mode by default, but supports all of the sender settle modes (the default can be changed using the [DefaultSenderSettleMode](#DefaultSenderSettleMode) configuration setting). Sender links created with the *Mixed* sender use the value of the [MessageSettled](#messagesettled-property-amqp-component) property to determine whether to send messages as settled or unsettled. ### Sending Composite Data The AMQP 1.0 protocol's data model includes the concept of "composite data". Composite data is comprised of one or more type-value pairs (including data structure types), plus a descriptor that describes what the overall data represents. **Composite Data JSON Schema** The struct uses JSON with a well-defined schema to represent composite data. The composite data JSON schema consists almost entirely of "type-value" objects, which hold an AMQP typename and a value. The syntax for a type-value object is: ```text { "type": "typename", "value": value } ``` The following table provides a complete list of valid typenames, and describes how the associated values should be represented: | Typename | Description | Value Format | | --- | --- | --- | | null | Null | null | | boolean | Boolean | true or false | | ubyte | Unsigned byte | 0 to 255 | | ushort | Unsigned short | 0 to 65535 | | uint | Unsigned integer | 0 to 4294967295 | | ulong | Unsigned long | 0 to 18446744073709551615 | | byte | Byte | -128 to 127 | | short | Short | -32768 to 32767 | | int | Integer | -2147483648 to 2147483647 | | long | Long | -9223372036854775808 to 9223372036854775807 | | float | Float | [IEEE 754 32-bit floating point number] | | double | Double | [IEEE 754 64-bit floating point number] | | decimal | Decimal | Hex-encoded byte string like "0A1B2C3D" | | char | Char | "c" | | timestamp | Timestamp | [Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC)] | | uuid | UUID | Hex-encoded UUID string like "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" (hyphens optional, case-insensitive) | | binary | Binary data | Hex-encoded byte string like "0A1B2C3D" | | string | String | "UTF-8 string (correctly escaped for JSON)" | | symbol | Symbolic value | "ASCII string" | | array | AMQP array | JSON array with zero or more type-value objects of the same type | | list | AMQP list | JSON array with zero or more type-value objects | | map | AMQP map | JSON array with even number of type-value objects representing keys and values; no duplicate keys allowed | *Note that typenames *must* be lowercase in order to be parsed correctly.* **Arrays, Lists, and Maps** The AMQP data model defines three data structure types: *array*, *list*, and *map*. In the composite data JSON schema, their value is always a JSON array that contains zero or more type-value objects. Data structure types may be nested arbitrarily to any depth. Note that the *array* and *map* data structures each have restrictions on their content: - The elements in an *array* must all be of the same type (e.g., their typenames must match). - The elements in a *map* represent keys (odd-numbered elements) and values (even-numbered elements). There must be an even number of elements (or none), and the values of the "key" elements must be unique. ```text { "type": "map", "value": [ { "type": "symbol", "value": "key1" }, { "type": "string", "value": "value1" }, { "type": "symbol", "value": "key2" }, { "type": "int", "value": 100 } ] } ``` **Described Types** As noted above, AMQP's data model includes the idea of "described types", which is simply a normal AMQP type annotated by a descriptor. The descriptor defines what the data it is associated with represents as a whole. In the composite data JSON schema, a described type object is just a normal type-value object with an extra *"descriptor"* property on it (and the *"descriptor"* property's value is itself a normal type-value object). The syntax for a described type object is: ```text { "descriptor": { "type": "typename", "value": value }, "type": "typename", "value": value } ``` Described type objects can be used anywhere that normal type-value objects can be, *except* as the value of the *"descriptor"* property for another described type object, which *must* be a normal type-value object. Note that, according to the AMQP specification, the type of the descriptor itself *ulong* or *symbol*, but the struct does not enforce this. **Abbreviated Value Syntax** For brevity, it is possible to abbreviate both normal type-value objects and described type objects when their value type is *null*, *boolean*, or *string*. For normal type-value objects, instead of using the standard syntax (e.g., *{ "type": "string", "value": "Hello, world!" }*), just use the raw value itself (e.g., *"Hello, world!"*). Keep in mind that the abbreviated value must still be valid JSON; notably, strings must still be surrounded by quotes (e.g., *"value"*, not *value*). The abbreviated syntax for a described type object is a bit different; the *"descriptor"* property still needs to be associated with the value using a JSON object. To abbreviate a described type object, just exclude the *"type"* property, like so: ```text { "descriptor": { "type": "typename", "value": value }, "value": value } ``` The abbreviated value syntax can be used anywhere that an unabbreviated type-value object or described type object would normally be used. The struct defaults to using the abbreviated syntax when returning composite data JSON. This can be configured using the [SimplifiedJSONFormat](#SimplifiedJSONFormat) configuration setting. **Composite Data JSON Example** ```text { "descriptor": { "type": "symbol", "value": "nsoftware:compositeDataExample" }, "type": "list", "value": [ "Shorthand string value", null, true, { "type": "uuid", "value": "12345678-0000-1000-8000-00805F9B34FB" }, { "type": "array", "value": [ { "type": "uint", "value": 23 }, { "type": "uint", "value": 52 }, { "type": "uint", "value": 153325 } ] }, { "type": "map", "value": [ { "type": "symbol", "value": "name" }, "Freezer temperature", { "type": "symbol", "value": "unit" }, "Fahrenheit", { "type": "symbol", "value": "value" }, { "type": "int", "value": -2 } ] }, { "descriptor": { "type": "symbol", "value": "nsoftware:utf8Bytes" }, "type": "binary", "value": "48656C6C6F2C20776F726C6421" } ] } ``` # Connected Event ([AMQP](#amqp-component) Component) Fired immediately after a connection completes (or fails). ## Syntax *Go Syntax* ```text // AMQPConnectedEventArgs carries the AMQP Connected event's parameters. type AMQPConnectedEventArgs struct {...} func (args *AMQPConnectedEventArgs) StatusCode() int32 func (args *AMQPConnectedEventArgs) Description() string // AMQPConnectedEvent defines the signature of the AMQP Connected event's handler function. type AMQPConnectedEvent func(sender *AMQP, args *AMQPConnectedEventArgs) func (obj *AMQP) GetOnConnectedHandler() AMQPConnectedEvent func (obj *AMQP) SetOnConnectedHandler(handlerFunc AMQPConnectedEvent) ``` ## Remarks If the connection is made normally, *StatusCode* is 0 and *Description* is "OK". If the connection fails, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error. Please refer to the [Error Codes](#trappable-errors-amqp-component) section for more information. # ConnectionStatus Event ([AMQP](#amqp-component) Component) Fired to indicate changes in the connection state. ## Syntax *Go Syntax* ```text // AMQPConnectionStatusEventArgs carries the AMQP ConnectionStatus event's parameters. type AMQPConnectionStatusEventArgs struct {...} func (args *AMQPConnectionStatusEventArgs) ConnectionEvent() string func (args *AMQPConnectionStatusEventArgs) StatusCode() int32 func (args *AMQPConnectionStatusEventArgs) Description() string // AMQPConnectionStatusEvent defines the signature of the AMQP ConnectionStatus event's handler function. type AMQPConnectionStatusEvent func(sender *AMQP, args *AMQPConnectionStatusEventArgs) func (obj *AMQP) GetOnConnectionStatusHandler() AMQPConnectionStatusEvent func (obj *AMQP) SetOnConnectionStatusHandler(handlerFunc AMQPConnectionStatusEvent) ``` ## Remarks This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake. The *ConnectionEvent* parameter indicates the type of connection event. Values may include the following: | | | | --- | --- | | | Firewall connection complete. | | | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | | | Remote host connection complete. | | | Remote host disconnected. | | | SSL or S/Shell connection broken. | | | Firewall host disconnected. | *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error. # Disconnected Event ([AMQP](#amqp-component) Component) Fired when a connection is closed. ## Syntax *Go Syntax* ```text // AMQPDisconnectedEventArgs carries the AMQP Disconnected event's parameters. type AMQPDisconnectedEventArgs struct {...} func (args *AMQPDisconnectedEventArgs) StatusCode() int32 func (args *AMQPDisconnectedEventArgs) Description() string // AMQPDisconnectedEvent defines the signature of the AMQP Disconnected event's handler function. type AMQPDisconnectedEvent func(sender *AMQP, args *AMQPDisconnectedEventArgs) func (obj *AMQP) GetOnDisconnectedHandler() AMQPDisconnectedEvent func (obj *AMQP) SetOnDisconnectedHandler(handlerFunc AMQPDisconnectedEvent) ``` ## Remarks If the connection is broken normally, *StatusCode* is 0 and *Description* is "OK". If the connection is broken for any other reason, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the TCP/IP error. Please refer to the [Error Codes](#trappable-errors-amqp-component) section for more information. # Error Event ([AMQP](#amqp-component) Component) Fired when information is available about errors during data delivery. ## Syntax *Go Syntax* ```text // AMQPErrorEventArgs carries the AMQP Error event's parameters. type AMQPErrorEventArgs struct {...} func (args *AMQPErrorEventArgs) ErrorCode() int32 func (args *AMQPErrorEventArgs) Description() string // AMQPErrorEvent defines the signature of the AMQP Error event's handler function. type AMQPErrorEvent func(sender *AMQP, args *AMQPErrorEventArgs) func (obj *AMQP) GetOnErrorHandler() AMQPErrorEvent func (obj *AMQP) SetOnErrorHandler(handlerFunc AMQPErrorEvent) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error. The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-amqp-component) section. # LinkReadyToSend Event ([AMQP](#amqp-component) Component) Fires when a sender link is ready to send messages. ## Syntax *Go Syntax* ```text // AMQPLinkReadyToSendEventArgs carries the AMQP LinkReadyToSend event's parameters. type AMQPLinkReadyToSendEventArgs struct {...} func (args *AMQPLinkReadyToSendEventArgs) LinkName() string func (args *AMQPLinkReadyToSendEventArgs) LinkIndex() int32 // AMQPLinkReadyToSendEvent defines the signature of the AMQP LinkReadyToSend event's handler function. type AMQPLinkReadyToSendEvent func(sender *AMQP, args *AMQPLinkReadyToSendEventArgs) func (obj *AMQP) GetOnLinkReadyToSendHandler() AMQPLinkReadyToSendEvent func (obj *AMQP) SetOnLinkReadyToSendHandler(handlerFunc AMQPLinkReadyToSendEvent) ``` ## Remarks This event fires when a sender link is ready to send messages. *LinkName* is the name of the sender link. *LinkIndex* is the index of the sender link in the Links properties. # Log Event ([AMQP](#amqp-component) Component) Fires once for each log message. ## Syntax *Go Syntax* ```text // AMQPLogEventArgs carries the AMQP Log event's parameters. type AMQPLogEventArgs struct {...} func (args *AMQPLogEventArgs) LogLevel() int32 func (args *AMQPLogEventArgs) Message() string func (args *AMQPLogEventArgs) LogType() string // AMQPLogEvent defines the signature of the AMQP Log event's handler function. type AMQPLogEvent func(sender *AMQP, args *AMQPLogEventArgs) func (obj *AMQP) GetOnLogHandler() AMQPLogEvent func (obj *AMQP) SetOnLogHandler(handlerFunc AMQPLogEvent) ``` ## Remarks This event fires once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the level of the *Message*. Possible values are: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data is logged. | | 3 (Debug) | Debug data is logged. | *LogType* identifies the type of log entry. Possible values are: - Info: General information about the struct. - Session: Session status messages. - Frame: Frame status messages. # MessageIn Event ([AMQP](#amqp-component) Component) Fires when the class receives a message. ## Syntax *Go Syntax* ```text // AMQPMessageInEventArgs carries the AMQP MessageIn event's parameters. type AMQPMessageInEventArgs struct {...} func (args *AMQPMessageInEventArgs) SessionName() string func (args *AMQPMessageInEventArgs) SessionIndex() int32 func (args *AMQPMessageInEventArgs) LinkName() string func (args *AMQPMessageInEventArgs) LinkIndex() int32 func (args *AMQPMessageInEventArgs) MessageId() string func (args *AMQPMessageInEventArgs) State() int32 func (args *AMQPMessageInEventArgs) SetState(value int32) // AMQPMessageInEvent defines the signature of the AMQP MessageIn event's handler function. type AMQPMessageInEvent func(sender *AMQP, args *AMQPMessageInEventArgs) func (obj *AMQP) GetOnMessageInHandler() AMQPMessageInEvent func (obj *AMQP) SetOnMessageInHandler(handlerFunc AMQPMessageInEvent) ``` ## Remarks This event fires whenever the struct receives a message. The message itself is automatically stored in the ReceivedMessage property. ### Specifying a Delivery Outcome The *State* parameter can be set to one of the following values to specify what delivery outcome the struct should report to the sender (the default is *Accepted (0)*): - **0**: Accepted - The message has been processed successfully. - **1**: Rejected - The message failed to process successfully. Includes an error describing why. - **2**: Released - The message has not been (and will not be) processed. - **3**: Modified - Same as "Released", but with additional metadata for the sender. When *State* is set to *Rejected (1)*, the struct will include error metadata when it informs the sender of the outcome. Set the [RejectErrorCondition](#RejectErrorCondition) and [RejectErrorDescription](#RejectErrorDescription) configuration settings before the event handler finishes to specify this error information. When *State* is set to *Modified (3)*, the struct can include additional metadata when it informs the sender of the outcome. Set zero or more of the [ModifiedDeliveryFailed](#ModifiedDeliveryFailed), [ModifiedMessageAnnotations](#ModifiedMessageAnnotations), and [ModifiedUndeliverableHere](#ModifiedUndeliverableHere) configuration settings before the event handler finishes to specify this additional metadata. ### Other Parameters *SessionName* is the name of the session the message was transmitted on. *SessionIndex* is the index of the session in the Sessions collection property. *LinkName* is the name of the link the message was transmitted on. *LinkIndex* is the index of the link in the Links collection property. *MessageId* is the Id of the message; it may be empty if a message Id was not set. # MessageOut Event ([AMQP](#amqp-component) Component) Fires when the class sends a message. ## Syntax *Go Syntax* ```text // AMQPMessageOutEventArgs carries the AMQP MessageOut event's parameters. type AMQPMessageOutEventArgs struct {...} func (args *AMQPMessageOutEventArgs) SessionName() string func (args *AMQPMessageOutEventArgs) SessionIndex() int32 func (args *AMQPMessageOutEventArgs) LinkName() string func (args *AMQPMessageOutEventArgs) LinkIndex() int32 func (args *AMQPMessageOutEventArgs) MessageId() string // AMQPMessageOutEvent defines the signature of the AMQP MessageOut event's handler function. type AMQPMessageOutEvent func(sender *AMQP, args *AMQPMessageOutEventArgs) func (obj *AMQP) GetOnMessageOutHandler() AMQPMessageOutEvent func (obj *AMQP) SetOnMessageOutHandler(handlerFunc AMQPMessageOutEvent) ``` ## Remarks This event fires whenever the struct sends a message. *SessionName* is the name of the session the message was transmitted on. *SessionIndex* is the index of the session in the Sessions collection property. *LinkName* is the name of the link the message was transmitted on. *LinkIndex* is the index of the link in the Links collection property. *MessageId* is the Id of the message; it may be empty if a message Id was not set. # MessageOutcome Event ([AMQP](#amqp-component) Component) Fires when a message's outcome is available. ## Syntax *Go Syntax* ```text // AMQPMessageOutcomeEventArgs carries the AMQP MessageOutcome event's parameters. type AMQPMessageOutcomeEventArgs struct {...} func (args *AMQPMessageOutcomeEventArgs) SessionName() string func (args *AMQPMessageOutcomeEventArgs) SessionIndex() int32 func (args *AMQPMessageOutcomeEventArgs) LinkName() string func (args *AMQPMessageOutcomeEventArgs) LinkIndex() int32 func (args *AMQPMessageOutcomeEventArgs) MessageId() string func (args *AMQPMessageOutcomeEventArgs) Direction() int32 func (args *AMQPMessageOutcomeEventArgs) State() int32 // AMQPMessageOutcomeEvent defines the signature of the AMQP MessageOutcome event's handler function. type AMQPMessageOutcomeEvent func(sender *AMQP, args *AMQPMessageOutcomeEventArgs) func (obj *AMQP) GetOnMessageOutcomeHandler() AMQPMessageOutcomeEvent func (obj *AMQP) SetOnMessageOutcomeHandler(handlerFunc AMQPMessageOutcomeEvent) ``` ## Remarks This event fires whenever the outcome for a message (incoming or outgoing) is available. *SessionName* is the name of the session the message was transmitted on. *SessionIndex* is the index of the session in the Sessions collection property. *LinkName* is the name of the link the message was transmitted on. *LinkIndex* is the index of the link in the Links collection property. *MessageId* is the Id of the message; it may be empty if a message Id was not set. *Direction* indicates whether this outcome was sent (0) or received (1). *State* indicates the actual message outcome. Possible values are: - **0**: Accepted - The message has been processed successfully. - **1**: Rejected - The message failed to process successfully. Includes an error describing why. - **2**: Released - The message has not been (and will not be) processed. - **3**: Modified - Same as "Released", but with additional metadata for the sender. When *State* is *Rejected (1)*, the [RejectErrorCondition](#RejectErrorCondition) and [RejectErrorDescription](#RejectErrorDescription) configuration settings can be queried before the event handler finishes to retrieve the error information. When *State* is *Modified (3)*, the [ModifiedDeliveryFailed](#ModifiedDeliveryFailed), [ModifiedMessageAnnotations](#ModifiedMessageAnnotations), and [ModifiedUndeliverableHere](#ModifiedUndeliverableHere) configuration settings can be queried before the event handler finishes to retrieve the additional metadata. # SSLServerAuthentication Event ([AMQP](#amqp-component) Component) Fired after the server presents its certificate to the client. ## Syntax *Go Syntax* ```text // AMQPSSLServerAuthenticationEventArgs carries the AMQP SSLServerAuthentication event's parameters. type AMQPSSLServerAuthenticationEventArgs struct {...} func (args *AMQPSSLServerAuthenticationEventArgs) CertEncoded() []byte func (args *AMQPSSLServerAuthenticationEventArgs) CertSubject() string func (args *AMQPSSLServerAuthenticationEventArgs) CertIssuer() string func (args *AMQPSSLServerAuthenticationEventArgs) Status() string func (args *AMQPSSLServerAuthenticationEventArgs) Accept() bool func (args *AMQPSSLServerAuthenticationEventArgs) SetAccept(value bool) // AMQPSSLServerAuthenticationEvent defines the signature of the AMQP SSLServerAuthentication event's handler function. type AMQPSSLServerAuthenticationEvent func(sender *AMQP, args *AMQPSSLServerAuthenticationEventArgs) func (obj *AMQP) GetOnSSLServerAuthenticationHandler() AMQPSSLServerAuthenticationEvent func (obj *AMQP) SetOnSSLServerAuthenticationHandler(handlerFunc AMQPSSLServerAuthenticationEvent) ``` ## Remarks During this event, the client can decide whether or not to continue with the connection process. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue. When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *Accept* parameter to True. # SSLStatus Event ([AMQP](#amqp-component) Component) Fired when secure connection progress messages are available. ## Syntax *Go Syntax* ```text // AMQPSSLStatusEventArgs carries the AMQP SSLStatus event's parameters. type AMQPSSLStatusEventArgs struct {...} func (args *AMQPSSLStatusEventArgs) Message() string // AMQPSSLStatusEvent defines the signature of the AMQP SSLStatus event's handler function. type AMQPSSLStatusEvent func(sender *AMQP, args *AMQPSSLStatusEventArgs) func (obj *AMQP) GetOnSSLStatusHandler() AMQPSSLStatusEvent func (obj *AMQP) SetOnSSLStatusHandler(handlerFunc AMQPSSLStatusEvent) ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # Config Settings ([AMQP](#amqp-component) Component) The struct accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the [Config](#config-method-amqp-component) method. ### AMQP Config Settings **AuthorizationIdentity**: The value to use as the authorization identity when SASL authentication is used.When [AuthScheme](#authscheme-property-amqp-component) is set to smSASLPlain you may use this setting to specify an authorization identity to be used when authenticating. **AzureSessionFilter**: Sets a session id for Azure Service Bus sessions.This is required when consuming from an Azure Service Bus topic or queue that has sessions enabled. The value used will act as a filter to consume only messages with the same id. **BinaryMessageEncoding**: Sets the expected message encoding to use for decoding binary messages.This is only valid if DecodeBinaryMessage is *true* AND no content-type was detected. In all other cases it is ignored. Supports "utf8" (default) or "8bit". **DecodeBinaryMessage**: Decodes binary message payloads.If set to *true* the struct attempts to read the incoming message's content-type, and if the content-type and charset are present they are used to decode. If an unsupported charset is detected (currently supports utf8 and 8bit) an error is thrown and the message payload is left as hex-encoded byte string. If content-type is not present, then the BinaryMessageEncoding value is used to decode. Default is *false*. **DefaultCredit**: The amount of credit to create new receiver links with.This setting controls the amount of credit that new receiver links are created with. The default is 1024. **DefaultCreditThreshold**: The credit threshold to create new receiver links with.The setting controls the credit threshold that new receiver links are created with. When a link's credit reaches the credit threshold, the struct will automatically set it back to the amount of credit the link initially had. The default is 256. **DefaultIncomingWindow**: The incoming window size to create new sessions with.This setting controls the incoming window size (in frames) that new sessions are created with. The default is 2014. **DefaultOutgoingWindow**: The outgoing window size to create new sessions with.This setting controls the outgoing window size (in frames) that new sessions are created with. The default is 2014. **DefaultReceiverSettleMode**: The receiver settle mode to create new links with.This setting controls the receiver settle mode that new links (both sender and receiver) are created with. Possible values are: - 0 (First - default): The receiver will settle all incoming messages. - 1 (Second): The receiver will only settle messages after returning the message disposition and receiving the disposition from the sender indicating it has been settled. Note: This setting can be used with Azure Service Bus to indicate the settlement mode. For example, "Peek-Lock" can be enabled by setting DefaultSenderSettleMode to 0 and DefaultReceiverSettleMode to 1. **DefaultSenderSettleMode**: The sender settle mode to create new links with.This setting controls the sender settle mode that new links (both sender and receiver) are created with. Possible values are: - 0 (Unsettled): The sender will send messages to the receiver in an unsettled state. - 1 (Settled): The sender will send messages to the receiver in a settled state. - 2 (Mixed - default): The sender may send messages to the receiver in either a settled or an unsettled state. **GenerateMessageId**: Whether a unique message Id should be automatically generated when sending a message.This setting controls whether the struct will automatically generate a [MessageId](#messageid-property-amqp-component) value (overwriting any existing value in the process) when [SendMessage](#sendmessage-method-amqp-component) is called. The default is False. **LogLevel**: The level of detail that is logged.This setting controls the level of detail that is logged through the [Log](#log-event-amqp-component) event. Possible values are: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data is logged. | | 3 (Debug) | Debug data is logged. | **MaxFrameSize**: The maximum frame size.This setting controls the maximum frame size (in bytes) that the struct will accept. This setting cannot be changed while connected. The default is 4294967295 (0xFFFFFFFF), which is the maximum value allowed. **MaxLinkCountPerSession**: The maximum number of links to restrict new sessions to.This setting controls the maximum number of links which newly created sessions will be restricted to. The default is 4294967295 (0xFFFFFFFF), which is the maximum value allowed. **MaxMessageSize**: The maximum message size to restrict new links to.This setting controls the maximum message size (in bytes) which newly created links will be restricted to. The default value is 1073741824 (0x40000000). **MaxSessionCount**: The maximum number of sessions.This setting controls the maximum number of sessions which can be opened. The default is 65535 (0xFFFF). **ModifiedDeliveryFailed**: Whether the sender should treat this transfer as an unsuccessful delivery attempt.This setting specifies whether the sender should increment the "delivery count" value of the message that the associated "Modified" delivery outcome applies to (thus treating the transfer as an unsuccessful delivery attempt). This setting is only valid while inside one of the [MessageIn](#messagein-event-amqp-component) or [MessageOutcome](#messageoutcome-event-amqp-component) event handlers, and can only be set while inside the [MessageIn](#messagein-event-amqp-component) event handler. **ModifiedMessageAnnotations**: The message annotations that the sender should merge into those already on the message.This setting specifies a set of message annotations that the sender should merge into the existing ones for the message that the associated "Modified" delivery outcome applies to. If not empty, this setting's value must be specified as valid composite data JSON containing a single AMQP map. The JSON must be structured according to the composite data JSON schema detailed in the [SendMessage](#sendmessage-method-amqp-component) method's documentation. For example: ```text { "type": "map", "value": [ { "type": "symbol", "value": "key1" }, { "type": "string", "value": "test" }, { "type": "symbol", "value": "key2" }, { "type": "int", "value": 100 } ] } ``` This setting is only valid while inside one of the [MessageIn](#messagein-event-amqp-component) or [MessageOutcome](#messageoutcome-event-amqp-component) event handlers, and can only be set while inside the [MessageIn](#messagein-event-amqp-component) event handler. **ModifiedUndeliverableHere**: Whether the receiver has indicated that the sender should not attempt to redeliver the message.This setting specifies whether the receiver has indicated that the sender should not attempt to redeliver the message that the associated "Modified" delivery outcome applies to. (Note that the sender is free to try and deliver the message to *another* receiver if it so chooses.) This setting is only valid while inside one of the [MessageIn](#messagein-event-amqp-component) or [MessageOutcome](#messageoutcome-event-amqp-component) event handlers, and can only be set while inside the [MessageIn](#messagein-event-amqp-component) event handler. **ProtocolVersion**: The AMQP protocol version to conform to.This setting can be queried to determine what AMQP protocol version the struct conforms to. Note: Currently this setting will always return "1.0", and cannot be changed. The [AMQPClassic](AMQPClassic.md#AMQPClassic) struct may be used instead of this one if AMQP 0.9.1 support is needed. **RejectErrorCondition**: The error condition included with a 'Rejected' delivery outcome.This setting specifies the error condition included with a "Rejected" delivery outcome. Possible values are: | | | | --- | --- | | amqp:internal-error | An internal error occurred. | | amqp:not-found | A peer attempted to work with a remote entity that does not exists. | | amqp:unauthorized-access | A peer attempted to work with a remote entity it does not have access to. | | amqp:decode-error | Data could not be decoded. | | amqp:resource-limited-exceeded | A peer exceeded its resource allocation. | | amqp:not-allowed | A peer tried to use a frame in a manner inconsistent with the AMQP specification. | | amqp:invalid-field | An invalid field was supplied in a frame body. | | amqp:not-implemented | A peer tried to use functionality that its partner does not implement. | | amqp:resource-locked | A peer tried to access a resource which is currently in use. | | amqp:precondition-failed | A peer made a request that was denied because a precondition failed. | | amqp:resource-deleted | A peer tried to work with a deleted resource. | | amqp:illegal-state | A peer sent a frame that is not permitted given the current state. | | amqp:frame-size-too-small | A peer attempted to send a frame larger than the negotiated maximum frame size. | This setting is only valid while inside one of the [MessageIn](#messagein-event-amqp-component) or [MessageOutcome](#messageoutcome-event-amqp-component) event handlers, and can only be set while inside the [MessageIn](#messagein-event-amqp-component) event handler. **RejectErrorDescription**: The error description included with a 'Rejected' delivery outcome.This setting specifies a description of the error included with a "Rejected" delivery outcome. It may be empty. This setting is only valid while inside one of the [MessageIn](#messagein-event-amqp-component) or [MessageOutcome](#messageoutcome-event-amqp-component) event handlers, and can only be set while inside the [MessageIn](#messagein-event-amqp-component) event handler. **SenderSettleMode[LinkName]**: Retrieves the negotiated sender settle mode for the specified link.This setting can be queried to obtain the negotiated sender settle mode for an existing link specified by "LinkName". **SimplifiedJSONFormat**: Whether to output simplified JSON where possible.This setting controls whether the struct should output JSON using the abbreviated value syntax where possible. Refer to the composite data JSON schema detail in the documentation of the [SendMessage](#sendmessage-method-amqp-component) method for more information. The default is true. ### TCPClient Config Settings **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the struct will use [Timeout](#timeout-property-amqp-component) for establishing a connection and transmitting/receiving data. **EnableFallback**: Whether to try the other addresses the remote host resolves to when a connection attempt fails.When set to True and [RemoteHost](#remotehost-property-amqp-component) resolves to more than one address, the struct will try the remaining addresses in turn if the connection to the first one fails, and only fails with an error once every address has been tried. The error reported is the one from the last attempt. Use [FallbackTimeout](#FallbackTimeout) to limit the total time spent. NOTE: Only addresses of the same IP version as the first one are tried, this setting does not fall back from IPv6 to IPv4. Selecting between IPv6 and IPv4 is done by [UseIPv6](#UseIPv6) when the host is resolved. This setting must be set before the connection is established. The default value for this setting is False. **FallbackTimeout**: The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled.This setting limits the total time that the struct will spend on all of the connection attempts made when [EnableFallback](#EnableFallback) is enabled. The default value is 0, in which case each attempt uses the operating system's own connection timeout. NOTE: This setting only applies when [EnableFallback](#EnableFallback) is True. It is unrelated to [ConnectionTimeout](#ConnectionTimeout), which is specified in seconds and applies to the [Connected](#connected-property-amqp-component) operation as a whole. **FirewallAutoDetect**: Tells the struct whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the struct returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-amqp-component) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. If the struct is connected, the [LocalHost](#localhost-property-amqp-component) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by [LocalPort](#localport-property-amqp-component) after the connection is established. [LocalPort](#localport-property-amqp-component) cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the struct will use IPv4 exclusively. When set to *1*, the struct will use IPv6 exclusively. To instruct the struct to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-amqp-component) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-amqp-component) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-amqp-component) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the struct will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the struct is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-amqp-component) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the struct will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the struct will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The struct will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the struct fails with an error. When set to 0 (default), the CRL check will not be performed by the struct. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the struct will use OCSP to check the validity of the server certificate. If set to 1 or 2, the struct will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The struct will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the struct fails with an error. When set to 0 (default), the struct will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-amqp-component) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the struct will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when [SSLProvider](#sslprovider-property-amqp-component) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [SSLProvider](#sslprovider-property-amqp-component) is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when [SSLProvider](#sslprovider-property-amqp-component) is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [SSLProvider](#sslprovider-property-amqp-component) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the struct will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-amqp-component) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-amqp-component) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the struct when the [SSLProvider](#sslprovider-property-amqp-component) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-amqp-component) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension. This configuration setting is applicable only when [SSLProvider](#sslprovider-property-amqp-component) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-amqp-component) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-amqp-component) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-amqp-component) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the struct will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the struct will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-amqp-component) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-amqp-component) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the struct will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the struct fails with an error. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#sslprovider-property-amqp-component) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-amqp-component) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # Trappable Errors ([AMQP](#amqp-component) Component) ### AMQP Errors | | | | --- | --- | | 600 | AMQP protocol error. Refer to the error message for more information. | | 601 | Malformed frame. | | 602 | SASL authentication failed. | | 603 | Cannot open another session or link. | | 604 | Invalid data format. | | 605 | Cannot modify message data. | | 606 | Cannot modify configuration setting. | ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the [RemotePort](#remoteport-property-amqp-component) at this time. A connection is in progress. | | 101 | You cannot change the [RemoteHost](#remotehost-property-amqp-component) (Server) at this time. A connection is in progress. | | 102 | The [RemoteHost](#remotehost-property-amqp-component) address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the [LocalPort](#localport-property-amqp-component) at this time. A connection is in progress. | | 107 | You cannot change the [LocalHost](#localhost-property-amqp-component) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | [RemotePort](#remoteport-property-amqp-component) cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the struct is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |