AMQP Class
Properties Methods Events Config Settings Errors
An easy-to-use AMQP 1.0 client implementation.
Syntax
class ipworksiot.AMQP
Remarks
The AMQP class provides an easy-to-use AMQP 1.0 client implementation. The class 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 class implements all three layers of the AMQP 1.0 transport protocol, so the first step is to initiate the overall connection. Set the container_id property and call the connect_to 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 create_session method. The class allows creating any number of sessions, up to the limit specified by the MaxSessionCount configuration setting.
Connecting and Creating a Session
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 class 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 class is implemented as an AMQP 1.0 client, it must be the one to open links (said another way, the class cannot accept any link requests made by other peers).
As with sessions, the class allows creating any number of links for each session, up to the limit specified by the MaxLinkCountPerSession configuration setting.
Creating Sender Links
To create a sender link, call the create_sender_link 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 on_link_ready_to_send event will fire when the newly created sender link is ready to send messages.
Creating a Sender Link
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 message_value and message_value_type properties must be set. All other properties are optional, though specifying a unique value for message_id is recommended. (If the GenerateMessageId configuration setting is enabled, the class will generate one automatically when the message is sent.)
Once the message property's properties have be assigned as desired, call the send_message method, passing it the name of an existing sender link on which the message should be sent.
The on_message_out event will be fired when the message has been sent (and acknowledged, if message_settled was set to false). The on_message_outcome event may also fire, if necessary, once the receiver reports the outcome of the message.
Refer to send_message, on_message_out, and on_message_outcome for more information.
Sending a Message
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 reset_message 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 class supports sending composite AMQP data in a message through the use of JSON with a well-defined schema. Refer to the send_message method's documentation for more information and examples.
Creating Receiver Links
Receiver links can operate in one of two receive modes: automatic, where the class will work to ensure that messages are received as soon as they are available; and retrieve-based, where the class will only "retrieve" a new message when explicitly instructed to.The receive_mode property controls which receive mode newly-created receiver links will use; refer to its documentation for more information.
After ensuring that receive_mode is set as desired, call create_receiver_link, 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
// 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 class will attempt to "retrieve" a message each time the retrieve_message method is called (optionally timing out after a time, if retrieve_timeout is non-zero). When calling retrieve_message, 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 class to fire the on_message_in event and update the received_message property's properties.
When the on_message_in event fires, its State event parameter can be used to specify the outcome of the message, which the class will then transmit back to the sender (as well as self-report by firing the on_message_outcome event). Refer to on_message_in for more information.
Receiving a Message
// 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 class with short descriptions. Click on the links for further details.
auth_scheme | The authentication scheme to use when connecting. |
connected | This property indicates whether the class is connected. |
container_id | The container Id the class should advertise when connecting. |
firewall_auto_detect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
firewall_type | This property determines the type of firewall to connect through. |
firewall_host | This property contains the name or IP address of the firewall (optional). |
firewall_password | This property contains a password if authentication is to be used when connecting through the firewall. |
firewall_port | This property contains the Transmission Control Protocol (TCP) port for the firewall Host . |
firewall_user | This property contains a username if authentication is to be used when connecting through a firewall. |
idle_timeout | The maximum period of inactivity the class will allow before disconnecting. |
incoming_message_count | The number of records in the IncomingMessage arrays. |
incoming_message_absolute_expiry_time | The absolute time at which this message should be considered expired. |
incoming_message_content_encoding | The content encoding of this message's data. |
incoming_message_content_type | The content type of this message's data. |
incoming_message_correlation_id | The correlation Id of this message. |
incoming_message_creation_time | The creation time of this message. |
incoming_message_delivery_count | How many previous attempts there have been to deliver this message. |
incoming_message_durable | Whether this message is durable. |
incoming_message_first_acquirer | Whether this message may have been acquired by other links previously. |
incoming_message_group_id | The Id of the group this message belongs to. |
incoming_message_group_sequence | The position of this message within its group. |
incoming_message_link_name | The name of the link this message is associated with. |
incoming_message_id | The unique Id of this message. |
incoming_message_priority | The priority of this message. |
incoming_message_reply_to | The address of the node to send replies to for this message. |
incoming_message_reply_to_group_id | The Id of the group to send replies to for this message. |
incoming_message_settled | Whether this message is settled. |
incoming_message_subject | The subject of this message. |
incoming_message_to | The address of the node which this message is intended for. |
incoming_message_ttl | The time-to-live value for this message. |
incoming_message_user_id | The identity of the user responsible for producing this message. |
incoming_message_value | This message's value. |
incoming_message_value_type | This message's value data type. |
link_count | The number of records in the Link arrays. |
link_available | The number of messages which this link's sender could send if it had credit for them. |
link_channel_name | The channel name this link is using. |
link_credit | The amount of credit currently available to this link's sender. |
link_delivery_count | The current delivery count value for this link. |
link_name | This link's name. |
link_ready_to_send | Whether this link is ready to send a message. |
link_receive_mode | The receive mode this link is operating in. |
link_role | The class's role on this link. |
local_host | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
local_port | The TCP port in the local host where the class binds. |
message_absolute_expiry_time | The absolute time at which this message should be considered expired. |
message_content_encoding | The content encoding of this message's data. |
message_content_type | The content type of this message's data. |
message_correlation_id | The correlation Id of this message. |
message_creation_time | The creation time of this message. |
message_delivery_count | How many previous attempts there have been to deliver this message. |
message_durable | Whether this message is durable. |
message_first_acquirer | Whether this message may have been acquired by other links previously. |
message_group_id | The Id of the group this message belongs to. |
message_group_sequence | The position of this message within its group. |
message_link_name | The name of the link this message is associated with. |
message_id | The unique Id of this message. |
message_priority | The priority of this message. |
message_reply_to | The address of the node to send replies to for this message. |
message_reply_to_group_id | The Id of the group to send replies to for this message. |
message_settled | Whether this message is settled. |
message_subject | The subject of this message. |
message_to | The address of the node which this message is intended for. |
message_ttl | The time-to-live value for this message. |
message_user_id | The identity of the user responsible for producing this message. |
message_value | This message's value. |
message_value_type | This message's value data type. |
outgoing_message_count | The number of records in the OutgoingMessage arrays. |
outgoing_message_absolute_expiry_time | The absolute time at which this message should be considered expired. |
outgoing_message_content_encoding | The content encoding of this message's data. |
outgoing_message_content_type | The content type of this message's data. |
outgoing_message_correlation_id | The correlation Id of this message. |
outgoing_message_creation_time | The creation time of this message. |
outgoing_message_delivery_count | How many previous attempts there have been to deliver this message. |
outgoing_message_durable | Whether this message is durable. |
outgoing_message_first_acquirer | Whether this message may have been acquired by other links previously. |
outgoing_message_group_id | The Id of the group this message belongs to. |
outgoing_message_group_sequence | The position of this message within its group. |
outgoing_message_link_name | The name of the link this message is associated with. |
outgoing_message_id | The unique Id of this message. |
outgoing_message_priority | The priority of this message. |
outgoing_message_reply_to | The address of the node to send replies to for this message. |
outgoing_message_reply_to_group_id | The Id of the group to send replies to for this message. |
outgoing_message_settled | Whether this message is settled. |
outgoing_message_subject | The subject of this message. |
outgoing_message_to | The address of the node which this message is intended for. |
outgoing_message_ttl | The time-to-live value for this message. |
outgoing_message_user_id | The identity of the user responsible for producing this message. |
outgoing_message_value | This message's value. |
outgoing_message_value_type | This message's value data type. |
password | A password to use for SASL authentication. |
ready_to_send | Indicates whether the class is ready to send data. |
received_message_absolute_expiry_time | The absolute time at which this message should be considered expired. |
received_message_content_encoding | The content encoding of this message's data. |
received_message_content_type | The content type of this message's data. |
received_message_correlation_id | The correlation Id of this message. |
received_message_creation_time | The creation time of this message. |
received_message_delivery_count | How many previous attempts there have been to deliver this message. |
received_message_durable | Whether this message is durable. |
received_message_first_acquirer | Whether this message may have been acquired by other links previously. |
received_message_group_id | The Id of the group this message belongs to. |
received_message_group_sequence | The position of this message within its group. |
received_message_link_name | The name of the link this message is associated with. |
received_message_id | The unique Id of this message. |
received_message_priority | The priority of this message. |
received_message_reply_to | The address of the node to send replies to for this message. |
received_message_reply_to_group_id | The Id of the group to send replies to for this message. |
received_message_settled | Whether this message is settled. |
received_message_subject | The subject of this message. |
received_message_to | The address of the node which this message is intended for. |
received_message_ttl | The time-to-live value for this message. |
received_message_user_id | The identity of the user responsible for producing this message. |
received_message_value | This message's value. |
received_message_value_type | This message's value data type. |
receive_mode | Controls what mode new receiver links are created with. |
remote_host | This property includes the address of the remote host. Domain names are resolved to IP addresses. |
remote_port | The port of the AQMP server (default is 5672). The default port for SSL is 5671. |
retrieve_timeout | How long the class should wait for a message to be received after RetrieveMessage is called. |
session_count | The number of records in the Session arrays. |
session_incoming_window | The incoming window size of this session. |
session_name | The name of this session. |
session_outgoing_window | The outgoing window size of this session. |
ssl_accept_server_cert_effective_date | This is the date on which this certificate becomes valid. |
ssl_accept_server_cert_expiration_date | This is the date the certificate expires. |
ssl_accept_server_cert_extended_key_usage | This is a comma-delimited list of extended key usage identifiers. |
ssl_accept_server_cert_fingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_accept_server_cert_fingerprint_sha1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_accept_server_cert_fingerprint_sha256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_accept_server_cert_issuer | This is the issuer of the certificate. |
ssl_accept_server_cert_private_key | This is the private key of the certificate (if available). |
ssl_accept_server_cert_private_key_available | This property shows whether a PrivateKey is available for the selected certificate. |
ssl_accept_server_cert_private_key_container | This is the name of the PrivateKey container for the certificate (if available). |
ssl_accept_server_cert_public_key | This is the public key of the certificate. |
ssl_accept_server_cert_public_key_algorithm | This property contains the textual description of the certificate's public key algorithm. |
ssl_accept_server_cert_public_key_length | This is the length of the certificate's public key (in bits). |
ssl_accept_server_cert_serial_number | This is the serial number of the certificate encoded as a string. |
ssl_accept_server_cert_signature_algorithm | The property contains the text description of the certificate's signature algorithm. |
ssl_accept_server_cert_store | This is the name of the certificate store for the client certificate. |
ssl_accept_server_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssl_accept_server_cert_store_type | This is the type of certificate store for this certificate. |
ssl_accept_server_cert_subject_alt_names | This property contains comma-separated lists of alternative subject names for the certificate. |
ssl_accept_server_cert_thumbprint_md5 | This property contains the MD5 hash of the certificate. |
ssl_accept_server_cert_thumbprint_sha1 | This property contains the SHA-1 hash of the certificate. |
ssl_accept_server_cert_thumbprint_sha256 | This property contains the SHA-256 hash of the certificate. |
ssl_accept_server_cert_usage | This property contains the text description of UsageFlags . |
ssl_accept_server_cert_usage_flags | This property contains the flags that show intended use for the certificate. |
ssl_accept_server_cert_version | This property contains the certificate's version number. |
ssl_accept_server_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_accept_server_cert_encoded | This is the certificate (PEM/Base64 encoded). |
ssl_cert_effective_date | This is the date on which this certificate becomes valid. |
ssl_cert_expiration_date | This is the date the certificate expires. |
ssl_cert_extended_key_usage | This is a comma-delimited list of extended key usage identifiers. |
ssl_cert_fingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_cert_fingerprint_sha1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_cert_fingerprint_sha256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_cert_issuer | This is the issuer of the certificate. |
ssl_cert_private_key | This is the private key of the certificate (if available). |
ssl_cert_private_key_available | This property shows whether a PrivateKey is available for the selected certificate. |
ssl_cert_private_key_container | This is the name of the PrivateKey container for the certificate (if available). |
ssl_cert_public_key | This is the public key of the certificate. |
ssl_cert_public_key_algorithm | This property contains the textual description of the certificate's public key algorithm. |
ssl_cert_public_key_length | This is the length of the certificate's public key (in bits). |
ssl_cert_serial_number | This is the serial number of the certificate encoded as a string. |
ssl_cert_signature_algorithm | The property contains the text description of the certificate's signature algorithm. |
ssl_cert_store | This is the name of the certificate store for the client certificate. |
ssl_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssl_cert_store_type | This is the type of certificate store for this certificate. |
ssl_cert_subject_alt_names | This property contains comma-separated lists of alternative subject names for the certificate. |
ssl_cert_thumbprint_md5 | This property contains the MD5 hash of the certificate. |
ssl_cert_thumbprint_sha1 | This property contains the SHA-1 hash of the certificate. |
ssl_cert_thumbprint_sha256 | This property contains the SHA-256 hash of the certificate. |
ssl_cert_usage | This property contains the text description of UsageFlags . |
ssl_cert_usage_flags | This property contains the flags that show intended use for the certificate. |
ssl_cert_version | This property contains the certificate's version number. |
ssl_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_cert_encoded | This is the certificate (PEM/Base64 encoded). |
ssl_enabled | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. |
ssl_provider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
ssl_server_cert_effective_date | This is the date on which this certificate becomes valid. |
ssl_server_cert_expiration_date | This is the date the certificate expires. |
ssl_server_cert_extended_key_usage | This is a comma-delimited list of extended key usage identifiers. |
ssl_server_cert_fingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_server_cert_fingerprint_sha1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_server_cert_fingerprint_sha256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_server_cert_issuer | This is the issuer of the certificate. |
ssl_server_cert_private_key | This is the private key of the certificate (if available). |
ssl_server_cert_private_key_available | This property shows whether a PrivateKey is available for the selected certificate. |
ssl_server_cert_private_key_container | This is the name of the PrivateKey container for the certificate (if available). |
ssl_server_cert_public_key | This is the public key of the certificate. |
ssl_server_cert_public_key_algorithm | This property contains the textual description of the certificate's public key algorithm. |
ssl_server_cert_public_key_length | This is the length of the certificate's public key (in bits). |
ssl_server_cert_serial_number | This is the serial number of the certificate encoded as a string. |
ssl_server_cert_signature_algorithm | The property contains the text description of the certificate's signature algorithm. |
ssl_server_cert_store | This is the name of the certificate store for the client certificate. |
ssl_server_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssl_server_cert_store_type | This is the type of certificate store for this certificate. |
ssl_server_cert_subject_alt_names | This property contains comma-separated lists of alternative subject names for the certificate. |
ssl_server_cert_thumbprint_md5 | This property contains the MD5 hash of the certificate. |
ssl_server_cert_thumbprint_sha1 | This property contains the SHA-1 hash of the certificate. |
ssl_server_cert_thumbprint_sha256 | This property contains the SHA-256 hash of the certificate. |
ssl_server_cert_usage | This property contains the text description of UsageFlags . |
ssl_server_cert_usage_flags | This property contains the flags that show intended use for the certificate. |
ssl_server_cert_version | This property contains the certificate's version number. |
ssl_server_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_server_cert_encoded | This is the certificate (PEM/Base64 encoded). |
timeout | This property includes the timeout for the class. |
user | A username to use for SASL authentication. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
close_link | Closes a link. |
close_session | Closes a session. |
config | Sets or retrieves a configuration setting. |
connect | This method connects to a remote host. |
connect_to | This method connects to a remote host. |
create_receiver_link | Creates a new receiver link with the given name on the specified session. |
create_sender_link | Creates a new sender link with the given name on the specified session. |
create_session | Creates a new session with the given name. |
disconnect | This method disconnects from the remote host. |
do_events | This method processes events from the internal message queue. |
interrupt | This method interrupts the current action. |
reset | This method will reset the class. |
reset_message | Resets the Message properties. |
retrieve_message | Retrieves a single message over the specified receiver link. |
send_message | Sends a message on the specified link. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
on_connected | This event is fired immediately after a connection completes (or fails). |
on_connection_status | This event is fired to indicate changes in the connection state. |
on_disconnected | This event is fired when a connection is closed. |
on_error | Fired when information is available about errors during data delivery. |
on_link_ready_to_send | Fires when a sender link is ready to send messages. |
on_log | Fires once for each log message. |
on_message_in | Fires when the class receives a message. |
on_message_out | Fires when the class sends a message. |
on_message_outcome | Fires when a message's outcome is available. |
on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
on_ssl_status | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AuthorizationIdentity | The value to use as the authorization identity when SASL authentication is used. |
DefaultCredit | The amount of credit to create new receiver links with. |
DefaultCreditThreshold | The credit threshold to create new receiver links with. |
DefaultIncomingWindow | The incoming window size to create new sessions with. |
DefaultOutgoingWindow | The outgoing window size to create new sessions with. |
DefaultSenderSettleMode | The sender settle mode to create new links with. |
GenerateMessageId | Whether a unique message Id should be automatically generated when sending a message. |
LogLevel | The level of detail that is logged. |
MaxFrameSize | The maximum frame size. |
MaxLinkCountPerSession | The maximum number of links to restrict new sessions to. |
MaxMessageSize | The maximum message size to restrict new links to. |
MaxSessionCount | The maximum number of sessions. |
ModifiedDeliveryFailed | Whether the sender should treat this transfer as an unsuccessful delivery attempt. |
ModifiedMessageAnnotations | The message annotations that the sender should merge into those already on the message. |
ModifiedUndeliverableHere | Whether the receiver has indicated that the sender should not attempt to redeliver the message. |
ProtocolVersion | The AMQP protocol version to conform to. |
RejectErrorCondition | The error condition included with a 'Rejected' delivery outcome. |
RejectErrorDescription | The error description included with a 'Rejected' delivery outcome. |
SenderSettleMode[LinkName] | Retrieves the negotiated sender settle mode for the specified link. |
SimplifiedJSONFormat | Whether to output simplified JSON where possible. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
auth_scheme Property
The authentication scheme to use when connecting.
Syntax
def get_auth_scheme() -> int: ... def set_auth_scheme(value: int) -> None: ...
auth_scheme = property(get_auth_scheme, set_auth_scheme)
Default Value
2
Remarks
This property controls what authentication scheme the class should use when connecting to the remote host.
Valid values are:
- smNone (0)
- smSASLAnonymous (1)
- smSASLPlain (2) - Default
- smSASLExternal (3)
connected Property
This property indicates whether the class is connected.
Syntax
def get_connected() -> bool: ...
connected = property(get_connected, None)
Default Value
FALSE
Remarks
This property indicates whether the class is connected to the remote host. Use the connect and disconnect methods to manage the connection.
This property is read-only.
container_id Property
The container Id the class should advertise when connecting.
Syntax
def get_container_id() -> str: ... def set_container_id(value: str) -> None: ...
container_id = property(get_container_id, set_container_id)
Default Value
""
Remarks
This property specifies the container Id that the class 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 class 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.
firewall_auto_detect Property
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Syntax
def get_firewall_auto_detect() -> bool: ... def set_firewall_auto_detect(value: bool) -> None: ...
firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_type Property
This property determines the type of firewall to connect through.
Syntax
def get_firewall_type() -> int: ... def set_firewall_type(value: int) -> None: ...
firewall_type = property(get_firewall_type, set_firewall_type)
Default Value
0
Remarks
This property determines 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. firewall_port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. firewall_port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. firewall_port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. firewall_port is set to 1080. |
firewall_host Property
This property contains the name or IP address of the firewall (optional).
Syntax
def get_firewall_host() -> str: ... def set_firewall_host(value: str) -> None: ...
firewall_host = property(get_firewall_host, set_firewall_host)
Default Value
""
Remarks
This property contains the name or IP address of the firewall (optional). If a firewall_host 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 class fails with an error.
firewall_password Property
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
def get_firewall_password() -> str: ... def set_firewall_password(value: str) -> None: ...
firewall_password = property(get_firewall_password, set_firewall_password)
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
firewall_port Property
This property contains the Transmission Control Protocol (TCP) port for the firewall Host .
Syntax
def get_firewall_port() -> int: ... def set_firewall_port(value: int) -> None: ...
firewall_port = property(get_firewall_port, set_firewall_port)
Default Value
0
Remarks
This property contains the Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.
Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.
firewall_user Property
This property contains a username if authentication is to be used when connecting through a firewall.
Syntax
def get_firewall_user() -> str: ... def set_firewall_user(value: str) -> None: ...
firewall_user = property(get_firewall_user, set_firewall_user)
Default Value
""
Remarks
This property contains a username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
idle_timeout Property
The maximum period of inactivity the class will allow before disconnecting.
Syntax
def get_idle_timeout() -> int: ... def set_idle_timeout(value: int) -> None: ...
idle_timeout = property(get_idle_timeout, set_idle_timeout)
Default Value
0
Remarks
This property controls how long, in seconds, the class will allow the connection to sit idle before it disconnects from the remote host.
This property may be set to 0 to prevent the class from ever closing the connection due to inactivity.
Note: The idle timeout cannot be changed while connected.
incoming_message_count Property
The number of records in the IncomingMessage arrays.
Syntax
def get_incoming_message_count() -> int: ...
incoming_message_count = property(get_incoming_message_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- incoming_message_absolute_expiry_time
- incoming_message_content_encoding
- incoming_message_content_type
- incoming_message_correlation_id
- incoming_message_creation_time
- incoming_message_delivery_count
- incoming_message_durable
- incoming_message_first_acquirer
- incoming_message_group_id
- incoming_message_group_sequence
- incoming_message_id
- incoming_message_link_name
- incoming_message_priority
- incoming_message_reply_to
- incoming_message_reply_to_group_id
- incoming_message_settled
- incoming_message_subject
- incoming_message_to
- incoming_message_ttl
- incoming_message_user_id
- incoming_message_value
- incoming_message_value_type
This property is read-only.
incoming_message_absolute_expiry_time Property
The absolute time at which this message should be considered expired.
Syntax
def get_incoming_message_absolute_expiry_time(incoming_message_index: int) -> int: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_content_encoding Property
The content encoding of this message's data.
Syntax
def get_incoming_message_content_encoding(incoming_message_index: int) -> str: ...
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 incoming_message_value_type is not set to mvtBinary (16).
The incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_content_type Property
The content type of this message's data.
Syntax
def get_incoming_message_content_type(incoming_message_index: int) -> str: ...
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 incoming_message_value_type is not set to mvtBinary (16).
The incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_correlation_id Property
The correlation Id of this message.
Syntax
def get_incoming_message_correlation_id(incoming_message_index: int) -> str: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_creation_time Property
The creation time of this message.
Syntax
def get_incoming_message_creation_time(incoming_message_index: int) -> int: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_delivery_count Property
How many previous attempts there have been to deliver this message.
Syntax
def get_incoming_message_delivery_count(incoming_message_index: int) -> int: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_durable Property
Whether this message is durable.
Syntax
def get_incoming_message_durable(incoming_message_index: int) -> bool: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_first_acquirer Property
Whether this message may have been acquired by other links previously.
Syntax
def get_incoming_message_first_acquirer(incoming_message_index: int) -> bool: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_group_id Property
The Id of the group this message belongs to.
Syntax
def get_incoming_message_group_id(incoming_message_index: int) -> str: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_group_sequence Property
The position of this message within its group.
Syntax
def get_incoming_message_group_sequence(incoming_message_index: int) -> int: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_link_name Property
The name of the link this message is associated with.
Syntax
def get_incoming_message_link_name(incoming_message_index: int) -> str: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_id Property
The unique Id of this message.
Syntax
def get_incoming_message_id(incoming_message_index: int) -> str: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_priority Property
The priority of this message.
Syntax
def get_incoming_message_priority(incoming_message_index: int) -> int: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_reply_to Property
The address of the node to send replies to for this message.
Syntax
def get_incoming_message_reply_to(incoming_message_index: int) -> str: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_reply_to_group_id Property
The Id of the group to send replies to for this message.
Syntax
def get_incoming_message_reply_to_group_id(incoming_message_index: int) -> str: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_settled Property
Whether this message is settled.
Syntax
def get_incoming_message_settled(incoming_message_index: int) -> bool: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_subject Property
The subject of this message.
Syntax
def get_incoming_message_subject(incoming_message_index: int) -> str: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_to Property
The address of the node which this message is intended for.
Syntax
def get_incoming_message_to(incoming_message_index: int) -> str: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_ttl Property
The time-to-live value for this message.
Syntax
def get_incoming_message_ttl(incoming_message_index: int) -> int: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_user_id Property
The identity of the user responsible for producing this message.
Syntax
def get_incoming_message_user_id(incoming_message_index: int) -> str: ...
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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_value Property
This message's value.
Syntax
def get_incoming_message_value(incoming_message_index: int) -> str: ...
Default Value
""
Remarks
This message's value.
This property specifies the value to send in this message. The incoming_message_value_type property should be used to specify the data type of the value.
The incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
incoming_message_value_type Property
This message's value data type.
Syntax
def get_incoming_message_value_type(incoming_message_index: int) -> int: ...
Default Value
0
Remarks
This message's value data type.
This property specifies the data type of this message's incoming_message_value.
The table below shows the possible value types, their descriptions, and how to format the data assigned to incoming_message_value. 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 (incoming_message_value 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 send_message method's documentation |
The incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.
This property is read-only.
link_count Property
The number of records in the Link arrays.
Syntax
def get_link_count() -> int: ...
link_count = property(get_link_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- link_available
- link_channel_name
- link_credit
- link_delivery_count
- link_name
- link_ready_to_send
- link_receive_mode
- link_role
This property is read-only.
link_available Property
The number of messages which this link's sender could send if it had credit for them.
Syntax
def get_link_available(link_index: int) -> int: ...
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 link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.
This property is read-only.
link_channel_name Property
The channel name this link is using.
Syntax
def get_link_channel_name(link_index: int) -> str: ...
Default Value
""
Remarks
The channel name this link is using.
This property holds the channel name this link is using.
The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.
This property is read-only.
link_credit Property
The amount of credit currently available to this link's sender.
Syntax
def get_link_credit(link_index: int) -> int: ...
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 link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.
This property is read-only.
link_delivery_count Property
The current delivery count value for this link.
Syntax
def get_link_delivery_count(link_index: int) -> int: ...
Default Value
0
Remarks
The current delivery count value for this link.
This property holds the current delivery count value for this link.
The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.
This property is read-only.
link_name Property
This link's name.
Syntax
def get_link_name(link_index: int) -> str: ...
Default Value
""
Remarks
This link's name.
This property holds this link's name.
The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.
This property is read-only.
link_ready_to_send Property
Whether this link is ready to send a message.
Syntax
def get_link_ready_to_send(link_index: int) -> bool: ...
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 link_role is lrReceiver (1).
The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.
This property is read-only.
link_receive_mode Property
The receive mode this link is operating in.
Syntax
def get_link_receive_mode(link_index: int) -> int: ...
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 receive_mode for more information.
The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.
This property is read-only.
link_role Property
The class's role on this link.
Syntax
def get_link_role(link_index: int) -> int: ...
Default Value
0
Remarks
The class's role on this link.
This property reflects which role the class is in for this link. Valid values are:
- lrSender (0)
- lrReceiver (1)
The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.
This property is read-only.
local_host Property
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
def get_local_host() -> str: ... def set_local_host(value: str) -> None: ...
local_host = property(get_local_host, set_local_host)
Default Value
""
Remarks
The local_host 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 class initiate connections (or accept in the case of server classs) 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 class is connected, the local_host 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: local_host is not persistent. You must always set it in code, and never in the property window.
local_port Property
The TCP port in the local host where the class binds.
Syntax
def get_local_port() -> int: ... def set_local_port(value: int) -> None: ...
local_port = property(get_local_port, set_local_port)
Default Value
0
Remarks
This property must be set before a connection is attempted. It instructs the class 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 local_port property after the connection is established.
local_port 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.
message_absolute_expiry_time Property
The absolute time at which this message should be considered expired.
Syntax
def get_message_absolute_expiry_time() -> int: ... def set_message_absolute_expiry_time(value: int) -> None: ...
message_absolute_expiry_time = property(get_message_absolute_expiry_time, set_message_absolute_expiry_time)
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).
message_content_encoding Property
The content encoding of this message's data.
Syntax
def get_message_content_encoding() -> str: ... def set_message_content_encoding(value: str) -> None: ...
message_content_encoding = property(get_message_content_encoding, set_message_content_encoding)
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 message_value_type is not set to mvtBinary (16).
message_content_type Property
The content type of this message's data.
Syntax
def get_message_content_type() -> str: ... def set_message_content_type(value: str) -> None: ...
message_content_type = property(get_message_content_type, set_message_content_type)
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 message_value_type is not set to mvtBinary (16).
message_correlation_id Property
The correlation Id of this message.
Syntax
def get_message_correlation_id() -> str: ... def set_message_correlation_id(value: str) -> None: ...
message_correlation_id = property(get_message_correlation_id, set_message_correlation_id)
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.
message_creation_time Property
The creation time of this message.
Syntax
def get_message_creation_time() -> int: ... def set_message_creation_time(value: int) -> None: ...
message_creation_time = property(get_message_creation_time, set_message_creation_time)
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).
message_delivery_count Property
How many previous attempts there have been to deliver this message.
Syntax
def get_message_delivery_count() -> int: ... def set_message_delivery_count(value: int) -> None: ...
message_delivery_count = property(get_message_delivery_count, set_message_delivery_count)
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.
message_durable Property
Whether this message is durable.
Syntax
def get_message_durable() -> bool: ... def set_message_durable(value: bool) -> None: ...
message_durable = property(get_message_durable, set_message_durable)
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.
message_first_acquirer Property
Whether this message may have been acquired by other links previously.
Syntax
def get_message_first_acquirer() -> bool: ... def set_message_first_acquirer(value: bool) -> None: ...
message_first_acquirer = property(get_message_first_acquirer, set_message_first_acquirer)
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.
message_group_id Property
The Id of the group this message belongs to.
Syntax
def get_message_group_id() -> str: ... def set_message_group_id(value: str) -> None: ...
message_group_id = property(get_message_group_id, set_message_group_id)
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.
message_group_sequence Property
The position of this message within its group.
Syntax
def get_message_group_sequence() -> int: ... def set_message_group_sequence(value: int) -> None: ...
message_group_sequence = property(get_message_group_sequence, set_message_group_sequence)
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.
message_link_name Property
The name of the link this message is associated with.
Syntax
def get_message_link_name() -> str: ...
message_link_name = property(get_message_link_name, None)
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.
message_id Property
The unique Id of this message.
Syntax
def get_message_id() -> str: ... def set_message_id(value: str) -> None: ...
message_id = property(get_message_id, set_message_id)
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.
message_priority Property
The priority of this message.
Syntax
def get_message_priority() -> int: ... def set_message_priority(value: int) -> None: ...
message_priority = property(get_message_priority, set_message_priority)
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).
message_reply_to Property
The address of the node to send replies to for this message.
Syntax
def get_message_reply_to() -> str: ... def set_message_reply_to(value: str) -> None: ...
message_reply_to = property(get_message_reply_to, set_message_reply_to)
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.
message_reply_to_group_id Property
The Id of the group to send replies to for this message.
Syntax
def get_message_reply_to_group_id() -> str: ... def set_message_reply_to_group_id(value: str) -> None: ...
message_reply_to_group_id = property(get_message_reply_to_group_id, set_message_reply_to_group_id)
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.
message_settled Property
Whether this message is settled.
Syntax
def get_message_settled() -> bool: ... def set_message_settled(value: bool) -> None: ...
message_settled = property(get_message_settled, set_message_settled)
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).
message_subject Property
The subject of this message.
Syntax
def get_message_subject() -> str: ... def set_message_subject(value: str) -> None: ...
message_subject = property(get_message_subject, set_message_subject)
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.
message_to Property
The address of the node which this message is intended for.
Syntax
def get_message_to() -> str: ... def set_message_to(value: str) -> None: ...
message_to = property(get_message_to, set_message_to)
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.
message_ttl Property
The time-to-live value for this message.
Syntax
def get_message_ttl() -> int: ... def set_message_ttl(value: int) -> None: ...
message_ttl = property(get_message_ttl, set_message_ttl)
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.
message_user_id Property
The identity of the user responsible for producing this message.
Syntax
def get_message_user_id() -> str: ... def set_message_user_id(value: str) -> None: ...
message_user_id = property(get_message_user_id, set_message_user_id)
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.
message_value Property
This message's value.
Syntax
def get_message_value() -> str: ... def set_message_value(value: str) -> None: ...
message_value = property(get_message_value, set_message_value)
Default Value
""
Remarks
This message's value.
This property specifies the value to send in this message. The message_value_type property should be used to specify the data type of the value.
message_value_type Property
This message's value data type.
Syntax
def get_message_value_type() -> int: ... def set_message_value_type(value: int) -> None: ...
message_value_type = property(get_message_value_type, set_message_value_type)
Default Value
0
Remarks
This message's value data type.
This property specifies the data type of this message's message_value.
The table below shows the possible value types, their descriptions, and how to format the data assigned to message_value. 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 (message_value 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 send_message method's documentation |
outgoing_message_count Property
The number of records in the OutgoingMessage arrays.
Syntax
def get_outgoing_message_count() -> int: ...
outgoing_message_count = property(get_outgoing_message_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- outgoing_message_absolute_expiry_time
- outgoing_message_content_encoding
- outgoing_message_content_type
- outgoing_message_correlation_id
- outgoing_message_creation_time
- outgoing_message_delivery_count
- outgoing_message_durable
- outgoing_message_first_acquirer
- outgoing_message_group_id
- outgoing_message_group_sequence
- outgoing_message_id
- outgoing_message_link_name
- outgoing_message_priority
- outgoing_message_reply_to
- outgoing_message_reply_to_group_id
- outgoing_message_settled
- outgoing_message_subject
- outgoing_message_to
- outgoing_message_ttl
- outgoing_message_user_id
- outgoing_message_value
- outgoing_message_value_type
This property is read-only.
outgoing_message_absolute_expiry_time Property
The absolute time at which this message should be considered expired.
Syntax
def get_outgoing_message_absolute_expiry_time(outgoing_message_index: int) -> int: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_content_encoding Property
The content encoding of this message's data.
Syntax
def get_outgoing_message_content_encoding(outgoing_message_index: int) -> str: ...
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 outgoing_message_value_type is not set to mvtBinary (16).
The outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_content_type Property
The content type of this message's data.
Syntax
def get_outgoing_message_content_type(outgoing_message_index: int) -> str: ...
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 outgoing_message_value_type is not set to mvtBinary (16).
The outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_correlation_id Property
The correlation Id of this message.
Syntax
def get_outgoing_message_correlation_id(outgoing_message_index: int) -> str: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_creation_time Property
The creation time of this message.
Syntax
def get_outgoing_message_creation_time(outgoing_message_index: int) -> int: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_delivery_count Property
How many previous attempts there have been to deliver this message.
Syntax
def get_outgoing_message_delivery_count(outgoing_message_index: int) -> int: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_durable Property
Whether this message is durable.
Syntax
def get_outgoing_message_durable(outgoing_message_index: int) -> bool: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_first_acquirer Property
Whether this message may have been acquired by other links previously.
Syntax
def get_outgoing_message_first_acquirer(outgoing_message_index: int) -> bool: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_group_id Property
The Id of the group this message belongs to.
Syntax
def get_outgoing_message_group_id(outgoing_message_index: int) -> str: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_group_sequence Property
The position of this message within its group.
Syntax
def get_outgoing_message_group_sequence(outgoing_message_index: int) -> int: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_link_name Property
The name of the link this message is associated with.
Syntax
def get_outgoing_message_link_name(outgoing_message_index: int) -> str: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_id Property
The unique Id of this message.
Syntax
def get_outgoing_message_id(outgoing_message_index: int) -> str: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_priority Property
The priority of this message.
Syntax
def get_outgoing_message_priority(outgoing_message_index: int) -> int: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_reply_to Property
The address of the node to send replies to for this message.
Syntax
def get_outgoing_message_reply_to(outgoing_message_index: int) -> str: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_reply_to_group_id Property
The Id of the group to send replies to for this message.
Syntax
def get_outgoing_message_reply_to_group_id(outgoing_message_index: int) -> str: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_settled Property
Whether this message is settled.
Syntax
def get_outgoing_message_settled(outgoing_message_index: int) -> bool: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_subject Property
The subject of this message.
Syntax
def get_outgoing_message_subject(outgoing_message_index: int) -> str: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_to Property
The address of the node which this message is intended for.
Syntax
def get_outgoing_message_to(outgoing_message_index: int) -> str: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_ttl Property
The time-to-live value for this message.
Syntax
def get_outgoing_message_ttl(outgoing_message_index: int) -> int: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_user_id Property
The identity of the user responsible for producing this message.
Syntax
def get_outgoing_message_user_id(outgoing_message_index: int) -> str: ...
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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_value Property
This message's value.
Syntax
def get_outgoing_message_value(outgoing_message_index: int) -> str: ...
Default Value
""
Remarks
This message's value.
This property specifies the value to send in this message. The outgoing_message_value_type property should be used to specify the data type of the value.
The outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
outgoing_message_value_type Property
This message's value data type.
Syntax
def get_outgoing_message_value_type(outgoing_message_index: int) -> int: ...
Default Value
0
Remarks
This message's value data type.
This property specifies the data type of this message's outgoing_message_value.
The table below shows the possible value types, their descriptions, and how to format the data assigned to outgoing_message_value. 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 (outgoing_message_value 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 send_message method's documentation |
The outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.
This property is read-only.
password Property
A password to use for SASL authentication.
Syntax
def get_password() -> str: ... def set_password(value: str) -> None: ...
password = property(get_password, set_password)
Default Value
""
Remarks
This property contains a password to use for SASL authentication.
ready_to_send Property
Indicates whether the class is ready to send data.
Syntax
def get_ready_to_send() -> bool: ...
ready_to_send = property(get_ready_to_send, None)
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 send_message fails due to a WOULDBLOCK condition.
Once data can be sent again, the on_ready_to_send event will fire and this property will be True.
If a WOULDBLOCK error occurs while sending a message the class will automatically complete the transmission when sending is possible. No action needs to be taken to re-send the message. on_ready_to_send will fire after the class completes any partially sent messages.
This property is read-only.
received_message_absolute_expiry_time Property
The absolute time at which this message should be considered expired.
Syntax
def get_received_message_absolute_expiry_time() -> int: ...
received_message_absolute_expiry_time = property(get_received_message_absolute_expiry_time, None)
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.
received_message_content_encoding Property
The content encoding of this message's data.
Syntax
def get_received_message_content_encoding() -> str: ...
received_message_content_encoding = property(get_received_message_content_encoding, None)
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 received_message_value_type is not set to mvtBinary (16).
This property is read-only.
received_message_content_type Property
The content type of this message's data.
Syntax
def get_received_message_content_type() -> str: ...
received_message_content_type = property(get_received_message_content_type, None)
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 received_message_value_type is not set to mvtBinary (16).
This property is read-only.
received_message_correlation_id Property
The correlation Id of this message.
Syntax
def get_received_message_correlation_id() -> str: ...
received_message_correlation_id = property(get_received_message_correlation_id, None)
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.
received_message_creation_time Property
The creation time of this message.
Syntax
def get_received_message_creation_time() -> int: ...
received_message_creation_time = property(get_received_message_creation_time, None)
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.
received_message_delivery_count Property
How many previous attempts there have been to deliver this message.
Syntax
def get_received_message_delivery_count() -> int: ...
received_message_delivery_count = property(get_received_message_delivery_count, None)
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.
received_message_durable Property
Whether this message is durable.
Syntax
def get_received_message_durable() -> bool: ...
received_message_durable = property(get_received_message_durable, None)
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.
received_message_first_acquirer Property
Whether this message may have been acquired by other links previously.
Syntax
def get_received_message_first_acquirer() -> bool: ...
received_message_first_acquirer = property(get_received_message_first_acquirer, None)
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.
received_message_group_id Property
The Id of the group this message belongs to.
Syntax
def get_received_message_group_id() -> str: ...
received_message_group_id = property(get_received_message_group_id, None)
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.
received_message_group_sequence Property
The position of this message within its group.
Syntax
def get_received_message_group_sequence() -> int: ...
received_message_group_sequence = property(get_received_message_group_sequence, None)
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.
received_message_link_name Property
The name of the link this message is associated with.
Syntax
def get_received_message_link_name() -> str: ...
received_message_link_name = property(get_received_message_link_name, None)
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.
received_message_id Property
The unique Id of this message.
Syntax
def get_received_message_id() -> str: ...
received_message_id = property(get_received_message_id, None)
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.
received_message_priority Property
The priority of this message.
Syntax
def get_received_message_priority() -> int: ...
received_message_priority = property(get_received_message_priority, None)
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.
received_message_reply_to Property
The address of the node to send replies to for this message.
Syntax
def get_received_message_reply_to() -> str: ...
received_message_reply_to = property(get_received_message_reply_to, None)
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.
received_message_reply_to_group_id Property
The Id of the group to send replies to for this message.
Syntax
def get_received_message_reply_to_group_id() -> str: ...
received_message_reply_to_group_id = property(get_received_message_reply_to_group_id, None)
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.
received_message_settled Property
Whether this message is settled.
Syntax
def get_received_message_settled() -> bool: ...
received_message_settled = property(get_received_message_settled, None)
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.
received_message_subject Property
The subject of this message.
Syntax
def get_received_message_subject() -> str: ...
received_message_subject = property(get_received_message_subject, None)
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.
received_message_to Property
The address of the node which this message is intended for.
Syntax
def get_received_message_to() -> str: ...
received_message_to = property(get_received_message_to, None)
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.
received_message_ttl Property
The time-to-live value for this message.
Syntax
def get_received_message_ttl() -> int: ...
received_message_ttl = property(get_received_message_ttl, None)
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.
received_message_user_id Property
The identity of the user responsible for producing this message.
Syntax
def get_received_message_user_id() -> str: ...
received_message_user_id = property(get_received_message_user_id, None)
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.
received_message_value Property
This message's value.
Syntax
def get_received_message_value() -> str: ...
received_message_value = property(get_received_message_value, None)
Default Value
""
Remarks
This message's value.
This property specifies the value to send in this message. The received_message_value_type property should be used to specify the data type of the value.
This property is read-only.
received_message_value_type Property
This message's value data type.
Syntax
def get_received_message_value_type() -> int: ...
received_message_value_type = property(get_received_message_value_type, None)
Default Value
0
Remarks
This message's value data type.
This property specifies the data type of this message's received_message_value.
The table below shows the possible value types, their descriptions, and how to format the data assigned to received_message_value. 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 (received_message_value 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 send_message method's documentation |
This property is read-only.
receive_mode Property
Controls what mode new receiver links are created with.
Syntax
def get_receive_mode() -> int: ... def set_receive_mode(value: int) -> None: ...
receive_mode = property(get_receive_mode, set_receive_mode)
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 and DefaultCreditThreshold configuration settings. Anytime the link's credit reaches the credit threshold, the class will automatically set it back to its initial value.
Retrieving Messages On-Demand
A receiver link operating in rmRetrieve (1) mode requires the retrieve_message 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 is set to). When retrieve_message is called, the class will supply the sender with a single credit and then block until a message is received (if the retrieve_timeout property is set to zero).
If retrieve_timeout is non-zero, the class 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 class will throw an error indicating a timeout.
Refer to retrieve_message and retrieve_timeout for more information.
amqp.ReceiveMode = AmqpReceiveModes.rmRetrieve;
amqp.CreateReceiverLink("SessionID", "ReceiverLinkName", "SomeTarget");
remote_host Property
This property includes the address of the remote host. Domain names are resolved to IP addresses.
Syntax
def get_remote_host() -> str: ... def set_remote_host(value: str) -> None: ...
remote_host = property(get_remote_host, set_remote_host)
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 class 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:
TCPClientControl.RemoteHost = "MyHostNameOrIP"
TCPClientControl.RemotePort = 777
TCPClientControl.Connected = true
remote_port Property
The port of the AQMP server (default is 5672). The default port for SSL is 5671.
Syntax
def get_remote_port() -> int: ... def set_remote_port(value: int) -> None: ...
remote_port = property(get_remote_port, set_remote_port)
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.
retrieve_timeout Property
How long the class should wait for a message to be received after RetrieveMessage is called.
Syntax
def get_retrieve_timeout() -> int: ... def set_retrieve_timeout(value: int) -> None: ...
retrieve_timeout = property(get_retrieve_timeout, set_retrieve_timeout)
Default Value
60
Remarks
This property controls how long, in seconds, the class will wait for a message to be received after retrieve_message is called before timing out the request. If set to zero, the class will wait indefinitely.
Refer to retrieve_message for more information.
session_count Property
The number of records in the Session arrays.
Syntax
def get_session_count() -> int: ...
session_count = property(get_session_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at session_count - 1.This property is read-only.
session_incoming_window Property
The incoming window size of this session.
Syntax
def get_session_incoming_window(session_index: int) -> int: ...
Default Value
0
Remarks
The incoming window size of this session.
This property holds the incoming window size (in frames) of this session.
The session_index parameter specifies the index of the item in the array. The size of the array is controlled by the session_count property.
This property is read-only.
session_name Property
The name of this session.
Syntax
def get_session_name(session_index: int) -> str: ...
Default Value
""
Remarks
The name of this session.
This property holds the name of this session.
The session_index parameter specifies the index of the item in the array. The size of the array is controlled by the session_count property.
This property is read-only.
session_outgoing_window Property
The outgoing window size of this session.
Syntax
def get_session_outgoing_window(session_index: int) -> int: ...
Default Value
0
Remarks
The outgoing window size of this session.
This property holds the outgoing window size (in frames) of this session.
The session_index parameter specifies the index of the item in the array. The size of the array is controlled by the session_count property.
This property is read-only.
ssl_accept_server_cert_effective_date Property
This is the date on which this certificate becomes valid.
Syntax
def get_ssl_accept_server_cert_effective_date() -> str: ...
ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)
Default Value
""
Remarks
This is 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.
ssl_accept_server_cert_expiration_date Property
This is the date the certificate expires.
Syntax
def get_ssl_accept_server_cert_expiration_date() -> str: ...
ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)
Default Value
""
Remarks
This is the date 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.
ssl_accept_server_cert_extended_key_usage Property
This is a comma-delimited list of extended key usage identifiers.
Syntax
def get_ssl_accept_server_cert_extended_key_usage() -> str: ...
ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
ssl_accept_server_cert_fingerprint Property
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssl_accept_server_cert_fingerprint() -> str: ...
ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)
Default Value
""
Remarks
This is 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.
ssl_accept_server_cert_fingerprint_sha1 Property
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...
ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)
Default Value
""
Remarks
This is 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.
ssl_accept_server_cert_fingerprint_sha256 Property
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...
ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)
Default Value
""
Remarks
This is 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.
ssl_accept_server_cert_issuer Property
This is the issuer of the certificate.
Syntax
def get_ssl_accept_server_cert_issuer() -> str: ...
ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)
Default Value
""
Remarks
This is 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.
ssl_accept_server_cert_private_key Property
This is the private key of the certificate (if available).
Syntax
def get_ssl_accept_server_cert_private_key() -> str: ...
ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.
This property is read-only.
ssl_accept_server_cert_private_key_available Property
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssl_accept_server_cert_private_key_available() -> bool: ...
ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)
Default Value
FALSE
Remarks
This property shows whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssl_accept_server_cert_private_key_container Property
This is the name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssl_accept_server_cert_private_key_container() -> str: ...
ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)
Default Value
""
Remarks
This is the name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssl_accept_server_cert_public_key Property
This is the public key of the certificate.
Syntax
def get_ssl_accept_server_cert_public_key() -> str: ...
ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssl_accept_server_cert_public_key_algorithm Property
This property contains the textual description of the certificate's public key algorithm.
Syntax
def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...
ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)
Default Value
""
Remarks
This property contains 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.
ssl_accept_server_cert_public_key_length Property
This is the length of the certificate's public key (in bits).
Syntax
def get_ssl_accept_server_cert_public_key_length() -> int: ...
ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
ssl_accept_server_cert_serial_number Property
This is the serial number of the certificate encoded as a string.
Syntax
def get_ssl_accept_server_cert_serial_number() -> str: ...
ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)
Default Value
""
Remarks
This is 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.
ssl_accept_server_cert_signature_algorithm Property
The property contains the text description of the certificate's signature algorithm.
Syntax
def get_ssl_accept_server_cert_signature_algorithm() -> str: ...
ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)
Default Value
""
Remarks
The property contains 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.
ssl_accept_server_cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_ssl_accept_server_cert_store() -> bytes: ... def set_ssl_accept_server_cert_store(value: bytes) -> None: ...
ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password protected, specify the password in ssl_accept_server_cert_store_password.
ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject 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).
ssl_accept_server_cert_store_password Property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
def get_ssl_accept_server_cert_store_password() -> str: ... def set_ssl_accept_server_cert_store_password(value: str) -> None: ...
ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password)
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.
ssl_accept_server_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_ssl_accept_server_cert_store_type() -> int: ... def set_ssl_accept_server_cert_store_type(value: int) -> None: ...
ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_accept_server_cert_store and set ssl_accept_server_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
ssl_accept_server_cert_subject_alt_names Property
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssl_accept_server_cert_subject_alt_names() -> str: ...
ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_accept_server_cert_thumbprint_md5 Property
This property contains the MD5 hash of the certificate.
Syntax
def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...
ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)
Default Value
""
Remarks
This property contains 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.
ssl_accept_server_cert_thumbprint_sha1 Property
This property contains the SHA-1 hash of the certificate.
Syntax
def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...
ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)
Default Value
""
Remarks
This property contains 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.
ssl_accept_server_cert_thumbprint_sha256 Property
This property contains the SHA-256 hash of the certificate.
Syntax
def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...
ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)
Default Value
""
Remarks
This property contains 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.
ssl_accept_server_cert_usage Property
This property contains the text description of UsageFlags .
Syntax
def get_ssl_accept_server_cert_usage() -> str: ...
ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)
Default Value
""
Remarks
This property contains the text description of ssl_accept_server_cert_usage_flags.
This value will be of 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.
ssl_accept_server_cert_usage_flags Property
This property contains the flags that show intended use for the certificate.
Syntax
def get_ssl_accept_server_cert_usage_flags() -> int: ...
ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags 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 ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssl_accept_server_cert_version Property
This property contains the certificate's version number.
Syntax
def get_ssl_accept_server_cert_version() -> str: ...
ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssl_accept_server_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_ssl_accept_server_cert_subject() -> str: ... def set_ssl_accept_server_cert_subject(value: str) -> None: ...
ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)
Default Value
""
Remarks
This is 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=support@nsoftware.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.
ssl_accept_server_cert_encoded Property
This is the certificate (PEM/Base64 encoded).
Syntax
def get_ssl_accept_server_cert_encoded() -> bytes: ... def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...
ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.
When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.
ssl_cert_effective_date Property
This is the date on which this certificate becomes valid.
Syntax
def get_ssl_cert_effective_date() -> str: ...
ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)
Default Value
""
Remarks
This is 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.
ssl_cert_expiration_date Property
This is the date the certificate expires.
Syntax
def get_ssl_cert_expiration_date() -> str: ...
ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)
Default Value
""
Remarks
This is the date 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.
ssl_cert_extended_key_usage Property
This is a comma-delimited list of extended key usage identifiers.
Syntax
def get_ssl_cert_extended_key_usage() -> str: ...
ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
ssl_cert_fingerprint Property
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint() -> str: ...
ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)
Default Value
""
Remarks
This is 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.
ssl_cert_fingerprint_sha1 Property
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint_sha1() -> str: ...
ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)
Default Value
""
Remarks
This is 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.
ssl_cert_fingerprint_sha256 Property
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint_sha256() -> str: ...
ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)
Default Value
""
Remarks
This is 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.
ssl_cert_issuer Property
This is the issuer of the certificate.
Syntax
def get_ssl_cert_issuer() -> str: ...
ssl_cert_issuer = property(get_ssl_cert_issuer, None)
Default Value
""
Remarks
This is 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.
ssl_cert_private_key Property
This is the private key of the certificate (if available).
Syntax
def get_ssl_cert_private_key() -> str: ...
ssl_cert_private_key = property(get_ssl_cert_private_key, None)
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.
This property is read-only.
ssl_cert_private_key_available Property
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssl_cert_private_key_available() -> bool: ...
ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)
Default Value
FALSE
Remarks
This property shows whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssl_cert_private_key_container Property
This is the name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssl_cert_private_key_container() -> str: ...
ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)
Default Value
""
Remarks
This is the name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssl_cert_public_key Property
This is the public key of the certificate.
Syntax
def get_ssl_cert_public_key() -> str: ...
ssl_cert_public_key = property(get_ssl_cert_public_key, None)
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssl_cert_public_key_algorithm Property
This property contains the textual description of the certificate's public key algorithm.
Syntax
def get_ssl_cert_public_key_algorithm() -> str: ...
ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)
Default Value
""
Remarks
This property contains 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.
ssl_cert_public_key_length Property
This is the length of the certificate's public key (in bits).
Syntax
def get_ssl_cert_public_key_length() -> int: ...
ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
ssl_cert_serial_number Property
This is the serial number of the certificate encoded as a string.
Syntax
def get_ssl_cert_serial_number() -> str: ...
ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)
Default Value
""
Remarks
This is 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.
ssl_cert_signature_algorithm Property
The property contains the text description of the certificate's signature algorithm.
Syntax
def get_ssl_cert_signature_algorithm() -> str: ...
ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)
Default Value
""
Remarks
The property contains 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.
ssl_cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_ssl_cert_store() -> bytes: ... def set_ssl_cert_store(value: bytes) -> None: ...
ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.
ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject 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).
ssl_cert_store_password Property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
def get_ssl_cert_store_password() -> str: ... def set_ssl_cert_store_password(value: str) -> None: ...
ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)
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.
ssl_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_ssl_cert_store_type() -> int: ... def set_ssl_cert_store_type(value: int) -> None: ...
ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
ssl_cert_subject_alt_names Property
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssl_cert_subject_alt_names() -> str: ...
ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_cert_thumbprint_md5 Property
This property contains the MD5 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_md5() -> str: ...
ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)
Default Value
""
Remarks
This property contains 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.
ssl_cert_thumbprint_sha1 Property
This property contains the SHA-1 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_sha1() -> str: ...
ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)
Default Value
""
Remarks
This property contains 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.
ssl_cert_thumbprint_sha256 Property
This property contains the SHA-256 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_sha256() -> str: ...
ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)
Default Value
""
Remarks
This property contains 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.
ssl_cert_usage Property
This property contains the text description of UsageFlags .
Syntax
def get_ssl_cert_usage() -> str: ...
ssl_cert_usage = property(get_ssl_cert_usage, None)
Default Value
""
Remarks
This property contains the text description of ssl_cert_usage_flags.
This value will be of 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.
ssl_cert_usage_flags Property
This property contains the flags that show intended use for the certificate.
Syntax
def get_ssl_cert_usage_flags() -> int: ...
ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of ssl_cert_usage_flags 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 ssl_cert_usage property for a text representation of ssl_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssl_cert_version Property
This property contains the certificate's version number.
Syntax
def get_ssl_cert_version() -> str: ...
ssl_cert_version = property(get_ssl_cert_version, None)
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssl_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_ssl_cert_subject() -> str: ... def set_ssl_cert_subject(value: str) -> None: ...
ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)
Default Value
""
Remarks
This is 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=support@nsoftware.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.
ssl_cert_encoded Property
This is the certificate (PEM/Base64 encoded).
Syntax
def get_ssl_cert_encoded() -> bytes: ... def set_ssl_cert_encoded(value: bytes) -> None: ...
ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.
When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.
ssl_enabled Property
This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.
Syntax
def get_ssl_enabled() -> bool: ... def set_ssl_enabled(value: bool) -> None: ...
ssl_enabled = property(get_ssl_enabled, set_ssl_enabled)
Default Value
FALSE
Remarks
This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.
TLS/SSL may also be enabled by setting ssl_start_mode. Setting ssl_start_mode 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.
ssl_provider Property
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
def get_ssl_provider() -> int: ... def set_ssl_provider(value: int) -> None: ...
ssl_provider = property(get_ssl_provider, set_ssl_provider)
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 class 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. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.
ssl_server_cert_effective_date Property
This is the date on which this certificate becomes valid.
Syntax
def get_ssl_server_cert_effective_date() -> str: ...
ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)
Default Value
""
Remarks
This is 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.
ssl_server_cert_expiration_date Property
This is the date the certificate expires.
Syntax
def get_ssl_server_cert_expiration_date() -> str: ...
ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)
Default Value
""
Remarks
This is the date 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.
ssl_server_cert_extended_key_usage Property
This is a comma-delimited list of extended key usage identifiers.
Syntax
def get_ssl_server_cert_extended_key_usage() -> str: ...
ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
ssl_server_cert_fingerprint Property
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssl_server_cert_fingerprint() -> str: ...
ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)
Default Value
""
Remarks
This is 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.
ssl_server_cert_fingerprint_sha1 Property
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssl_server_cert_fingerprint_sha1() -> str: ...
ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)
Default Value
""
Remarks
This is 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.
ssl_server_cert_fingerprint_sha256 Property
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssl_server_cert_fingerprint_sha256() -> str: ...
ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)
Default Value
""
Remarks
This is 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.
ssl_server_cert_issuer Property
This is the issuer of the certificate.
Syntax
def get_ssl_server_cert_issuer() -> str: ...
ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)
Default Value
""
Remarks
This is 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.
ssl_server_cert_private_key Property
This is the private key of the certificate (if available).
Syntax
def get_ssl_server_cert_private_key() -> str: ...
ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.
This property is read-only.
ssl_server_cert_private_key_available Property
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssl_server_cert_private_key_available() -> bool: ...
ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)
Default Value
FALSE
Remarks
This property shows whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssl_server_cert_private_key_container Property
This is the name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssl_server_cert_private_key_container() -> str: ...
ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)
Default Value
""
Remarks
This is the name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssl_server_cert_public_key Property
This is the public key of the certificate.
Syntax
def get_ssl_server_cert_public_key() -> str: ...
ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssl_server_cert_public_key_algorithm Property
This property contains the textual description of the certificate's public key algorithm.
Syntax
def get_ssl_server_cert_public_key_algorithm() -> str: ...
ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)
Default Value
""
Remarks
This property contains 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.
ssl_server_cert_public_key_length Property
This is the length of the certificate's public key (in bits).
Syntax
def get_ssl_server_cert_public_key_length() -> int: ...
ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
ssl_server_cert_serial_number Property
This is the serial number of the certificate encoded as a string.
Syntax
def get_ssl_server_cert_serial_number() -> str: ...
ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)
Default Value
""
Remarks
This is 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.
ssl_server_cert_signature_algorithm Property
The property contains the text description of the certificate's signature algorithm.
Syntax
def get_ssl_server_cert_signature_algorithm() -> str: ...
ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)
Default Value
""
Remarks
The property contains 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.
ssl_server_cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_ssl_server_cert_store() -> bytes: ...
ssl_server_cert_store = property(get_ssl_server_cert_store, None)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password protected, specify the password in ssl_server_cert_store_password.
ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject 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.
ssl_server_cert_store_password Property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
def get_ssl_server_cert_store_password() -> str: ...
ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)
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.
ssl_server_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_ssl_server_cert_store_type() -> int: ...
ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_server_cert_store and set ssl_server_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
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.
ssl_server_cert_subject_alt_names Property
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssl_server_cert_subject_alt_names() -> str: ...
ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_server_cert_thumbprint_md5 Property
This property contains the MD5 hash of the certificate.
Syntax
def get_ssl_server_cert_thumbprint_md5() -> str: ...
ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)
Default Value
""
Remarks
This property contains 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.
ssl_server_cert_thumbprint_sha1 Property
This property contains the SHA-1 hash of the certificate.
Syntax
def get_ssl_server_cert_thumbprint_sha1() -> str: ...
ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)
Default Value
""
Remarks
This property contains 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.
ssl_server_cert_thumbprint_sha256 Property
This property contains the SHA-256 hash of the certificate.
Syntax
def get_ssl_server_cert_thumbprint_sha256() -> str: ...
ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)
Default Value
""
Remarks
This property contains 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.
ssl_server_cert_usage Property
This property contains the text description of UsageFlags .
Syntax
def get_ssl_server_cert_usage() -> str: ...
ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)
Default Value
""
Remarks
This property contains the text description of ssl_server_cert_usage_flags.
This value will be of 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.
ssl_server_cert_usage_flags Property
This property contains the flags that show intended use for the certificate.
Syntax
def get_ssl_server_cert_usage_flags() -> int: ...
ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags 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 ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssl_server_cert_version Property
This property contains the certificate's version number.
Syntax
def get_ssl_server_cert_version() -> str: ...
ssl_server_cert_version = property(get_ssl_server_cert_version, None)
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssl_server_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_ssl_server_cert_subject() -> str: ...
ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)
Default Value
""
Remarks
This is 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=support@nsoftware.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.
ssl_server_cert_encoded Property
This is the certificate (PEM/Base64 encoded).
Syntax
def get_ssl_server_cert_encoded() -> bytes: ...
ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.
When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.
This property is read-only.
timeout Property
This property includes the timeout for the class.
Syntax
def get_timeout() -> int: ... def set_timeout(value: int) -> None: ...
timeout = property(get_timeout, set_timeout)
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 class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of timeout seconds.
The class will use do_events 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 class 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.
user Property
A username to use for SASL authentication.
Syntax
def get_user() -> str: ... def set_user(value: str) -> None: ...
user = property(get_user, set_user)
Default Value
""
Remarks
This property contains a username to use for SASL authentication.
close_link Method
Closes a link.
Syntax
def close_link(name: str) -> None: ...
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.
close_session Method
Closes a session.
Syntax
def close_session(name: str) -> None: ...
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
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
Remarks
config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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, you must call Config("PROPERTY"). The value will be returned as a string.
connect Method
This method connects to a remote host.
Syntax
def connect() -> None: ...
Remarks
This method connects to the remote host specified by remote_host and remote_port.
For instance:
component.RemoteHost = "MyHostNameOrIP";
component.RemotePort = 7777;
component.Connect();
connect_to Method
This method connects to a remote host.
Syntax
def connect_to(host: str, port: int) -> None: ...
Remarks
This method connects to the remote host specified by the Host and Port parameters. For instance:
component.ConnectTo("MyHostNameOrIP", 777)
create_receiver_link Method
Creates a new receiver link with the given name on the specified session.
Syntax
def create_receiver_link(session_name: str, name: str, source: str) -> None: ...
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 class will work to ensure that messages are received as soon as they are available; and retrieve-based, where the class will only "retrieve" a new message when explicitly instructed to.
The receive_mode 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.
amqp.ReceiveMode = AmqpReceiveModes.rmRetrieve;
amqp.CreateReceiverLink("SessionID", "ReceiverLinkName", "SomeTarget");
create_sender_link Method
Creates a new sender link with the given name on the specified session.
Syntax
def create_sender_link(session_name: str, name: str, target: str) -> None: ...
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 on_link_ready_to_send 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 message_settled property control whether each message is settled (the default) or unsettled when it is sent. The DefaultSenderSettleMode configuration setting can be used to control the settle mode that new sender links are created with. Refer to send_message 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.
create_session Method
Creates a new session with the given name.
Syntax
def create_session(name: str) -> None: ...
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
This method disconnects from the remote host.
Syntax
def disconnect() -> None: ...
Remarks
This method disconnects from the remote host. Calling this method is equivalent to setting the connected property to False.
do_events Method
This method processes events from the internal message queue.
Syntax
def do_events() -> None: ...
Remarks
When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
interrupt Method
This method interrupts the current action.
Syntax
def interrupt() -> None: ...
Remarks
This method interrupts the current action. If you use send_file to upload a file, the class 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
This method will reset the class.
Syntax
def reset() -> None: ...
Remarks
This method will reset the class's properties to their default values.
reset_message Method
Resets the Message properties.
Syntax
def reset_message() -> None: ...
Remarks
This method resets the message property.
retrieve_message Method
Retrieves a single message over the specified receiver link.
Syntax
def retrieve_message(link_name: str) -> None: ...
Remarks
When retrieve_message is called, the class will supply the sender with a single credit and then block until a message is received (if the retrieve_timeout property is set to zero).
If retrieve_timeout is non-zero, the class 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 class 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 receive_mode and retrieve_timeout for more information.
send_message Method
Sends a message on the specified link.
Syntax
def send_message(link_name: str) -> None: ...
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 .
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.
- 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 |
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 class 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 class requests that the receiver use Second, the receiver can instead choose to use First (if, e.g., it doesn't support Second).
The class 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 class 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 configuration setting). Sender links created with the Mixed sender use the value of the message_settled 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 class 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:
{ "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 |
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.
{ "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:
{ "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 class 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:
{ "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 class defaults to using the abbreviated syntax when returning composite data JSON. This can be configured using the SimplifiedJSONFormat configuration setting.
Composite Data JSON Example
{ "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" } ] }
on_connected Event
This event is fired immediately after a connection completes (or fails).
Syntax
class AMQPConnectedEventParams(object): @property def status_code() -> int: ... @property def description() -> str: ... # In class AMQP: @property def on_connected() -> Callable[[AMQPConnectedEventParams], None]: ... @on_connected.setter def on_connected(event_hook: Callable[[AMQPConnectedEventParams], None]) -> None: ...
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 section for more information.
on_connection_status Event
This event is fired to indicate changes in the connection state.
Syntax
class AMQPConnectionStatusEventParams(object): @property def connection_event() -> str: ... @property def status_code() -> int: ... @property def description() -> str: ... # In class AMQP: @property def on_connection_status() -> Callable[[AMQPConnectionStatusEventParams], None]: ... @on_connection_status.setter def on_connection_status(event_hook: Callable[[AMQPConnectionStatusEventParams], None]) -> None: ...
Remarks
The on_connection_status 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. |
on_disconnected Event
This event is fired when a connection is closed.
Syntax
class AMQPDisconnectedEventParams(object): @property def status_code() -> int: ... @property def description() -> str: ... # In class AMQP: @property def on_disconnected() -> Callable[[AMQPDisconnectedEventParams], None]: ... @on_disconnected.setter def on_disconnected(event_hook: Callable[[AMQPDisconnectedEventParams], None]) -> None: ...
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 section for more information.
on_error Event
Fired when information is available about errors during data delivery.
Syntax
class AMQPErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class AMQP: @property def on_error() -> Callable[[AMQPErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[AMQPErrorEventParams], None]) -> None: ...
Remarks
The on_error event is fired in case of exceptional conditions during message processing. Normally the class 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 section.
on_link_ready_to_send Event
Fires when a sender link is ready to send messages.
Syntax
class AMQPLinkReadyToSendEventParams(object): @property def link_name() -> str: ... @property def link_index() -> int: ... # In class AMQP: @property def on_link_ready_to_send() -> Callable[[AMQPLinkReadyToSendEventParams], None]: ... @on_link_ready_to_send.setter def on_link_ready_to_send(event_hook: Callable[[AMQPLinkReadyToSendEventParams], None]) -> None: ...
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.
on_log Event
Fires once for each log message.
Syntax
class AMQPLogEventParams(object): @property def log_level() -> int: ... @property def message() -> str: ... @property def log_type() -> str: ... # In class AMQP: @property def on_log() -> Callable[[AMQPLogEventParams], None]: ... @on_log.setter def on_log(event_hook: Callable[[AMQPLogEventParams], None]) -> None: ...
Remarks
This event fires once for each log message generated by the class. The verbosity is controlled by the 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 class.
- Session: Session status messages.
- Frame: Frame status messages.
on_message_in Event
Fires when the class receives a message.
Syntax
class AMQPMessageInEventParams(object): @property def session_name() -> str: ... @property def session_index() -> int: ... @property def link_name() -> str: ... @property def link_index() -> int: ... @property def message_id() -> str: ... @property def state() -> int: ... @state.setter def state(value) -> None: ... # In class AMQP: @property def on_message_in() -> Callable[[AMQPMessageInEventParams], None]: ... @on_message_in.setter def on_message_in(event_hook: Callable[[AMQPMessageInEventParams], None]) -> None: ...
Remarks
This event fires whenever the class receives a message. The message itself is automatically stored in the received_message property.
Specifying a Delivery Outcome
The State parameter can be set to one of the following values to specify what delivery outcome the class 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 class will include error metadata when it informs the sender of the outcome. Set the RejectErrorCondition and RejectErrorDescription configuration settings before the event handler finishes to specify this error information.
When State is set to Modified (3), the class can include additional metadata when it informs the sender of the outcome. Set zero or more of the ModifiedDeliveryFailed, ModifiedMessageAnnotations, and 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.
on_message_out Event
Fires when the class sends a message.
Syntax
class AMQPMessageOutEventParams(object): @property def session_name() -> str: ... @property def session_index() -> int: ... @property def link_name() -> str: ... @property def link_index() -> int: ... @property def message_id() -> str: ... # In class AMQP: @property def on_message_out() -> Callable[[AMQPMessageOutEventParams], None]: ... @on_message_out.setter def on_message_out(event_hook: Callable[[AMQPMessageOutEventParams], None]) -> None: ...
Remarks
This event fires whenever the class 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.
on_message_outcome Event
Fires when a message's outcome is available.
Syntax
class AMQPMessageOutcomeEventParams(object): @property def session_name() -> str: ... @property def session_index() -> int: ... @property def link_name() -> str: ... @property def link_index() -> int: ... @property def message_id() -> str: ... @property def direction() -> int: ... @property def state() -> int: ... # In class AMQP: @property def on_message_outcome() -> Callable[[AMQPMessageOutcomeEventParams], None]: ... @on_message_outcome.setter def on_message_outcome(event_hook: Callable[[AMQPMessageOutcomeEventParams], None]) -> None: ...
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 and RejectErrorDescription configuration settings can be queried before the event handler finishes to retrieve the error information.
When State is Modified (3), the ModifiedDeliveryFailed, ModifiedMessageAnnotations, and ModifiedUndeliverableHere configuration settings can be queried before the event handler finishes to retrieve the additional metadata.
on_ssl_server_authentication Event
Fired after the server presents its certificate to the client.
Syntax
class AMQPSSLServerAuthenticationEventParams(object): @property def cert_encoded() -> bytes: ... @property def cert_subject() -> str: ... @property def cert_issuer() -> str: ... @property def status() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class AMQP: @property def on_ssl_server_authentication() -> Callable[[AMQPSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[AMQPSSLServerAuthenticationEventParams], None]) -> None: ...
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.
on_ssl_status Event
Fired when secure connection progress messages are available.
Syntax
class AMQPSSLStatusEventParams(object): @property def message() -> str: ... # In class AMQP: @property def on_ssl_status() -> Callable[[AMQPSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[AMQPSSLStatusEventParams], None]) -> None: ...
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
AMQP Config Settings
The class 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 class, access to these internal properties is provided through the config method.AMQP Config Settings
The default is 1024.
The default is 256.
The default is 2014.
The default is 2014.
- 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.
The default is False.
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. |
The default is 4294967295 (0xFFFFFFFF), which is the maximum value allowed.
The default is 4294967295 (0xFFFFFFFF), which is the maximum value allowed.
The default value is 1073741824 (0x40000000).
The default is 65535 (0xFFFF).
This setting is only valid while inside one of the on_message_in or on_message_outcome event handlers, and can only be set while inside the on_message_in event handler.
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 send_message method's documentation. For example:
{ "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 on_message_in or on_message_outcome event handlers, and can only be set while inside the on_message_in event handler.
This setting is only valid while inside one of the on_message_in or on_message_outcome event handlers, and can only be set while inside the on_message_in event handler.
Note: Currently this setting will always return "1.0", and cannot be changed. The AMQPClassic class may be used instead of this one if AMQP 0.9.1 support is needed.
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 on_message_in or on_message_outcome event handlers, and can only be set while inside the on_message_in event handler.
This setting is only valid while inside one of the on_message_in or on_message_outcome event handlers, and can only be set while inside the on_message_in event handler.
The default is true.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the 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 classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if 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 is a positive value, the system will attempt to send pending data until the specified 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 class 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.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the local_host 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).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.
local_port 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.
If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset.
If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if ssl_provider is set to Platform.
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.
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.
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".
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.
If set to True, the class 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 class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----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-----
When set to 0 (default), the CRL check will not be performed by the class. 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.
When set to 0 (default), the class 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.
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 on_ssl_status 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 is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If 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 ssl_provider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when ssl_provider 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
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 ssl_provider 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), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
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 class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions.
In editions that are designed to run on Windows, ssl_provider 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 and other similar SSL configuration settings are not supported.
- If 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 class when the ssl_provider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and ssl_provider needs to be set to platform.
This configuration setting is applicable only when ssl_provider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class 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 class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when ssl_provider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
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.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
When specified the class 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 class fails with an error.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
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.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and ssl_provider 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)
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"
- "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 ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
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)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class 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
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 |
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 |
- 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.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to True. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to True tells the class 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 section.
AMQP Errors
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 remote_port at this time. A connection is in progress. |
101 | You cannot change the remote_host (Server) at this time. A connection is in progress. |
102 | The remote_host 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 local_port at this time. A connection is in progress. |
107 | You cannot change the local_host at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | remote_port cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the class 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). |