AmazonSQS Module
Properties Methods Events Config Settings Errors
The AmazonSQS Module provides an easy interface to Amazon's Simple Queue Service (SQS).
Syntax
IPWorksMQ.Amazonsqs
Remarks
The AmazonSQS Class allows you to access Amazon's Simple Queue Service (SQS). SQS allows you to create globally accessible queues on Amazon's servers. These queues can be used by developers to transfer data between distributed application components, without losing messages or requiring each component to always be available. A brief synopsis follows but please refer to Amazon SQS documentation for details.
You will first need to sign up for the SQS service and obtain the AccessKey and SecretKey from Amazon. Then you can start creating queues in your account using CreateQueue. You can then start adding message's to the queue using CreateMessage and retrieve the same using ListMessages.
There are other methods such as ListQueues, DeleteQueue, DeleteMessage etc. that further enable you to manage your SQS queues.
Property List
The following is the full list of the properties of the module with short descriptions. Click on the links for further details.
AccessKey | The Access Key Id for the Amazon Web Services account. |
Attributes | A list of attributes for a queue. |
Firewall | A set of properties related to firewall access. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
MaxMessages | The maximum number of messages retrieved from the queue. |
Messages | The messages retrieved as a result of calling ListMessages . |
OtherHeaders | This property includes other headers as determined by the user (optional). |
Proxy | A set of properties related to proxy access. |
QueuePrefix | QueuePrefix can be used to filter the queues listed. |
Queues | The queues retrieved as a result of calling ListMessages . |
Referer | This property includes the referer URL/document (optional). |
SecretKey | The Secret Access Key for the Amazon Web Services account. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
StatusLine | This property is the first line of the last server response. |
Timeout | A timeout for the module. |
UseSSL | Use SSL when accessing the service. |
VisibilityTimeout | The visibility duration for messages in the queue. |
Method List
The following is the full list of the methods of the module with short descriptions. Click on the links for further details.
AddPermission | Adds a permission to a queue for a specific account, which allows for sharing access to the queue. |
ChangeMessageVisibility | Changes the visibility timeout of a message. |
Config | Sets or retrieves a configuration setting. |
CreateMessage | Adds a message to a queue. |
CreateQueue | Creates an SQS queue. |
DeleteMessage | Deletes the message specified. |
DeleteQueue | Deletes a queue. |
DoEvents | Processes events from the internal message queue. |
GetQueueAttributes | Returns all attributes of a queue. |
GetXValue | Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest . |
Interrupt | Interrupt the current method. |
ListMessages | Gets messages from the queue. |
ListQueues | Lists the queues under the current account. |
RemovePermission | The RemovePermission action revokes any permissions in the queue policy that matches the UserLabel parameter. |
Reset | Resets request-related properties. |
ResetHeaders | Resets all HTTP headers, cookies, and LocalFile. |
SendCustomRequest | Allows the sending of a custom request to an Amazon web service. |
SetQueueAttribute | Sets an attribute of a queue. |
Event List
The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.
Connected | This event is fired immediately after a connection completes (or fails). |
Disconnected | This event is fired when a connection is closed. |
EndTransfer | This event is fired when a document finishes transferring. |
Error | Fired when information is available about errors during data delivery. |
Header | This event is fired every time a header line comes in. |
Message | Fired for each message retrieved from the queue. |
Queue | Fired for each queue of the user. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event is fired when a document starts transferring (after the headers). |
Status | This event is fired when the HTTP status line is received from the server. |
Transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the module with short descriptions. Click on the links for further details.
APIVersion | Service's API version. |
HTTPMethod | Specifies the HTTP method to use when sending a custom request. |
MessageAttributeCount | The number of message attributes. |
MessageAttributeDataType[i] | The data type of the message attribute. |
MessageAttributeName[i] | The name of the message attribute. |
MessageAttributeValue[i] | The value of the message attribute. |
MessageDeduplicationId | The message deduplication ID for the message being created. |
MessageGroupId | The ID of the message group to which the message belongs. |
PurgeQueue | Deletes all messages in a queue specified by the QueueId. |
SignatureVersion | The version of signature used. |
SignCustomRequest | Tells the module to sign the outgoing request. |
TransferredData | Returns the entire XML response received from the server. |
URL | If set, the default URL will be overridden by this value. |
UseEC2RoleCredentials | If set, authenticate requests with credentials obtained from the specified IAM role attached to the EC2 instance. |
UseFIFOQueues | Whether queues should always be created as FIFO queues. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the module. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the module will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the module. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the module. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the module 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 module 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. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
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. |
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 certificate 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. |
AccessKey Property (AmazonSQS Module)
The Access Key Id for the Amazon Web Services account.
Syntax
public var accessKey: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=accessKey,setter=setAccessKey:) NSString* accessKey; - (NSString*)accessKey; - (void)setAccessKey :(NSString*)newAccessKey;
Default Value
""
Remarks
This is the username for the Amazon Web Services account. No two accounts may have the same Access Key. This is used along with the SecretKey to authenticate with Amazon servers.
Attributes Property (AmazonSQS Module)
A list of attributes for a queue.
Syntax
public var attributes: Array<SQSAttribute> { get {...} }
@property (nonatomic,readonly,assign,getter=attributesCount) int attributesCount; - (int)attributesCount; - (NSString*)attributesName:(int)attributesIndex; - (NSString*)attributesValue:(int)attributesIndex;
Default Value
-1
Remarks
After a call to GetQueueAttributes, Attributes will contain the attributes of the queue specified in the GetQueueAttributes request.
Firewall Property (AmazonSQS Module)
A set of properties related to firewall access.
Syntax
public var firewall: Firewall { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect; - (BOOL)firewallAutoDetect; - (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect; @property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType; - (int)firewallType; - (void)setFirewallType :(int)newFirewallType; @property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost; - (NSString*)firewallHost; - (void)setFirewallHost :(NSString*)newFirewallHost; @property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword; - (NSString*)firewallPassword; - (void)setFirewallPassword :(NSString*)newFirewallPassword; @property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort; - (int)firewallPort; - (void)setFirewallPort :(int)newFirewallPort; @property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser; - (NSString*)firewallUser; - (void)setFirewallUser :(NSString*)newFirewallUser;
Default Value
-1
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.
LocalHost Property (AmazonSQS Module)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
public var localHost: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost; - (NSString*)localHost; - (void)setLocalHost :(NSString*)newLocalHost;
Default Value
""
Remarks
The LocalHost 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 multi-homed 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 LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.
MaxMessages Property (AmazonSQS Module)
The maximum number of messages retrieved from the queue.
Syntax
public var maxMessages: Int32 { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=maxMessages,setter=setMaxMessages:) int maxMessages; - (int)maxMessages; - (void)setMaxMessages :(int)newMaxMessages;
Default Value
1
Remarks
The maximum number of messages retrieved by ListMessages. This is not the number of messages that will be returned, but just the maximum number that will be returned.
Amazon's SQS service dictates that this parameter should be between 1 to 10, all other values are illegal.
Messages Property (AmazonSQS Module)
The messages retrieved as a result of calling ListMessages .
Syntax
public var messages: Array<SqsMessage> { get {...} }
@property (nonatomic,readonly,assign,getter=messagesCount) int messagesCount; - (int)messagesCount; - (NSString*)messagesBody:(int)messagesIndex; - (NSString*)messagesId:(int)messagesIndex; - (NSString*)messagesMD5:(int)messagesIndex; - (NSString*)messagesReceiptHandle:(int)messagesIndex;
Default Value
-1
Remarks
This property will be populated with a list of messages after a call to ListMessages.
OtherHeaders Property (AmazonSQS Module)
This property includes other headers as determined by the user (optional).
Syntax
public var otherHeaders: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=otherHeaders,setter=setOtherHeaders:) NSString* otherHeaders; - (NSString*)otherHeaders; - (void)setOtherHeaders :(NSString*)newOtherHeaders;
Default Value
""
Remarks
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.
The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the class beyond what is provided.
Proxy Property (AmazonSQS Module)
A set of properties related to proxy access.
Syntax
public var proxy: Proxy { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme; - (int)proxyAuthScheme; - (void)setProxyAuthScheme :(int)newProxyAuthScheme; @property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect; - (BOOL)proxyAutoDetect; - (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect; @property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword; - (NSString*)proxyPassword; - (void)setProxyPassword :(NSString*)newProxyPassword; @property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort; - (int)proxyPort; - (void)setProxyPort :(int)newProxyPort; @property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer; - (NSString*)proxyServer; - (void)setProxyServer :(NSString*)newProxyServer; @property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL; - (int)proxySSL; - (void)setProxySSL :(int)newProxySSL; @property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser; - (NSString*)proxyUser; - (void)setProxyUser :(NSString*)newProxyUser;
Default Value
-1
Remarks
This property contains fields describing the proxy through which the class will attempt to connect.
QueuePrefix Property (AmazonSQS Module)
QueuePrefix can be used to filter the queues listed.
Syntax
public var queuePrefix: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=queuePrefix,setter=setQueuePrefix:) NSString* queuePrefix; - (NSString*)queuePrefix; - (void)setQueuePrefix :(NSString*)newQueuePrefix;
Default Value
""
Remarks
Only the queues whose names start with the specified QueuePrefix are listed when ListQueues is called.
Queues Property (AmazonSQS Module)
The queues retrieved as a result of calling ListMessages .
Syntax
public var queues: Array<SqsQueue> { get {...} }
@property (nonatomic,readonly,assign,getter=queuesCount) int queuesCount; - (int)queuesCount; - (NSString*)queuesId:(int)queuesIndex; - (NSString*)queuesUrl:(int)queuesIndex;
Default Value
-1
Remarks
This property will be populated with a list of queues after a call to ListQueues.
Referer Property (AmazonSQS Module)
This property includes the referer URL/document (optional).
Syntax
public var referer: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=referer,setter=setReferer:) NSString* referer; - (NSString*)referer; - (void)setReferer :(NSString*)newReferer;
Default Value
""
Remarks
If this property contains a nonempty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.
SecretKey Property (AmazonSQS Module)
The Secret Access Key for the Amazon Web Services account.
Syntax
public var secretKey: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=secretKey,setter=setSecretKey:) NSString* secretKey; - (NSString*)secretKey; - (void)setSecretKey :(NSString*)newSecretKey;
Default Value
""
Remarks
This property describes the secret key to the Amazon account. It should not be shared with others. The SecretKey is used along with the AccessKey in the authentication process with Amazon servers.
SSLAcceptServerCertEncoded Property (AmazonSQS Module)
This is the certificate (PEM/Base64 encoded).
Syntax
public var sslAcceptServerCertEncoded: String { get {...} set {...} }
public var sslAcceptServerCertEncodedB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded; - (NSString*)SSLAcceptServerCertEncoded; - (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB; - (NSData*)SSLAcceptServerCertEncodedB; - (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws
SSLCertEncoded Property (AmazonSQS Module)
This is the certificate (PEM/Base64 encoded).
Syntax
public var sslCertEncoded: String { get {...} set {...} }
public var sslCertEncodedB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded; - (NSString*)SSLCertEncoded; - (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded; @property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB; - (NSData*)SSLCertEncodedB; - (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setSSLCertEncodedB(sslCertEncoded: Data) throws public func setSSLCertEncoded(sslCertEncoded: String) throws
SSLCertStore Property (AmazonSQS Module)
This is the name of the certificate store for the client certificate.
Syntax
public var sslCertStore: String { get {...} set {...} }
public var sslCertStoreB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore; - (NSString*)SSLCertStore; - (void)setSSLCertStore :(NSString*)newSSLCertStore; @property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB; - (NSData*)SSLCertStoreB; - (void)setSSLCertStoreB :(NSData*)newSSLCertStore;
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
SSLCertStorePassword Property (AmazonSQS Module)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
public var sslCertStorePassword: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword; - (NSString*)SSLCertStorePassword; - (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;
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.
SSLCertStoreType Property (AmazonSQS Module)
This is the type of certificate store for this certificate.
Syntax
public var sslCertStoreType: AmazonsqsSSLCertStoreTypes { get {...} set {...} }
public enum AmazonsqsSSLCertStoreTypes: Int32 { case cstUser = 0 case cstMachine = 1 case cstPFXFile = 2 case cstPFXBlob = 3 case cstJKSFile = 4 case cstJKSBlob = 5 case cstPEMKeyFile = 6 case cstPEMKeyBlob = 7 case cstPublicKeyFile = 8 case cstPublicKeyBlob = 9 case cstSSHPublicKeyBlob = 10 case cstP7BFile = 11 case cstP7BBlob = 12 case cstSSHPublicKeyFile = 13 case cstPPKFile = 14 case cstPPKBlob = 15 case cstXMLFile = 16 case cstXMLBlob = 17 case cstJWKFile = 18 case cstJWKBlob = 19 case cstSecurityKey = 20 case cstBCFKSFile = 21 case cstBCFKSBlob = 22 case cstPKCS11 = 23 case cstAuto = 99 }
@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType; - (int)SSLCertStoreType; - (void)setSSLCertStoreType :(int)newSSLCertStoreType;
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 ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword 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. |
SSLCertSubject Property (AmazonSQS Module)
This is the subject of the certificate used for client authentication.
Syntax
public var sslCertSubject: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject; - (NSString*)SSLCertSubject; - (void)setSSLCertSubject :(NSString*)newSSLCertSubject;
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.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setSSLCertSubject(sslCertSubject: String) throws
SSLProvider Property (AmazonSQS Module)
This specifies the SSL/TLS implementation to use.
Syntax
public var sslProvider: AmazonsqsSSLProviders { get {...} set {...} }
public enum AmazonsqsSSLProviders: Int32 { case sslpAutomatic = 0 case sslpPlatform = 1 case sslpInternal = 2 }
@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider; - (int)SSLProvider; - (void)setSSLProvider :(int)newSSLProvider;
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:
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 the platform implementation will be used by default in all cases in the macOS edition.
SSLServerCertEncoded Property (AmazonSQS Module)
This is the certificate (PEM/Base64 encoded).
Syntax
public var sslServerCertEncoded: String { get {...} }
public var sslServerCertEncodedB: Data { get {...} }
@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded; - (NSString*)SSLServerCertEncoded; @property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB; - (NSData*)SSLServerCertEncodedB;
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws
StatusLine Property (AmazonSQS Module)
This property is the first line of the last server response.
Syntax
public var statusLine: String { get {...} }
@property (nonatomic,readonly,assign,getter=statusLine) NSString* statusLine; - (NSString*)statusLine;
Default Value
""
Remarks
This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the class, the error string is the same as the StatusLine property.
The HTTP protocol specifies the structure of the StatusLine as follows: [HTTP version] [Result Code] [Description].
This property is read-only.
Timeout Property (AmazonSQS Module)
A timeout for the module.
Syntax
public var timeout: Int32 { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout; - (int)timeout; - (void)setTimeout :(int)newTimeout;
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class will use DoEvents 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 .
Please note that by default, all timeouts are inactivity timeouts, i.e. 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.
UseSSL Property (AmazonSQS Module)
Use SSL when accessing the service.
Syntax
public var useSSL: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=useSSL,setter=setUseSSL:) BOOL useSSL; - (BOOL)useSSL; - (void)setUseSSL :(BOOL)newUseSSL;
Default Value
True
Remarks
Use this property to specify whether the class should use SSL when connecting to the service.
VisibilityTimeout Property (AmazonSQS Module)
The visibility duration for messages in the queue.
Syntax
public var visibilityTimeout: Int32 { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=visibilityTimeout,setter=setVisibilityTimeout:) int visibilityTimeout; - (int)visibilityTimeout; - (void)setVisibilityTimeout :(int)newVisibilityTimeout;
Default Value
-1
Remarks
Visibility timeout is used to guard against multiple delivery. Successive calls to ListMessages on a queue will not return any message again until the timeout expires, after which the message may reappear unless deleted with DeleteMessage.
A default visibility timeout is configured when a queue is created using CreateQueue, it can also be altered when a message is added using CreateMessage or when they are retrieved using ListMessages.
The default value for VisibilityTimeout is -1, which notifies the component that you would like to use the default behavior for the current Queue.
Note: Unlike messages received from standard queues, messages received from FIFO queues can only be deleted within their VisibilityTimeout. Attempting to call DeleteMessage for a message received from a FIFO queue after its VisibilityTimeout has expired will cause the server to return an error. Keep this in mind when picking a VisibilityTimeout value to create a FIFO queue and/or retrieve messages with.
AddPermission Method (AmazonSQS Module)
Adds a permission to a queue for a specific account, which allows for sharing access to the queue.
Syntax
public func addPermission(queueId: String, userLabel: String, amazonAccount: String, permissionName: String) throws -> String
- (NSString*)addPermission:(NSString*)queueId :(NSString*)userLabel :(NSString*)amazonAccount :(NSString*)permissionName;
Remarks
This method adds a permission to the queue specified by QueueId for the user account specified by AmazonAccount. UserLabel is the unique identification of the permission you're granting, and is used when deleting the permission via the RemovePermission method. The current list of values you may pass in the PermissionName parameter are listed below:
- SendMessage
- ReceiveMessage
- DeleteMessage
- ChangeMessageVisibility
- GetQueueAttributes
Note that when you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue.
AddPermission writes an SQS-generated policy. If you want to write your own policy, use SetQueueAttribute to upload your policy.
This method returns the RequestId contained in the Amazon response.
ChangeMessageVisibility Method (AmazonSQS Module)
Changes the visibility timeout of a message.
Syntax
public func changeMessageVisibility(queueId: String, receiptHandle: String, visiblityTimeout: Int32) throws -> String
- (NSString*)changeMessageVisibility:(NSString*)queueId :(NSString*)receiptHandle :(int)visiblityTimeout;
Remarks
Changes the visibility of the message specified by ReceiptHandle in the queue specified by QueueId. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours.
This method returns the RequestId contained in the Amazon response.
Config Method (AmazonSQS Module)
Sets or retrieves a configuration setting.
Syntax
- (NSString*)config:(NSString*)configurationString;
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.
CreateMessage Method (AmazonSQS Module)
Adds a message to a queue.
Syntax
- (NSString*)createMessage:(NSString*)queueId :(NSString*)message;
Remarks
Adds a message to the queue specified. If VisibilityTimeout is specified it is updated for all the messages in the queue.
CreateMessage returns a message id assigned to the message that is added to a queue. This can then be used to ListMessages or DeleteMessage.
Note: When adding a message to a FIFO queue, the MessageGroupId configuration setting must be populated before calling this method.
CreateQueue Method (AmazonSQS Module)
Creates an SQS queue.
Syntax
- (NSString*)createQueue:(NSString*)queueName;
Remarks
A queue with the specified name is created.
CreateQueue returns a queue id assigned to the queue. This can then be used to CreateMessage or DeleteQueue.
If the QueueName ends with .fifo, the queue will be created as a FIFO queue. Alternatively, if the UseFIFOQueues configuration setting is enabled, the class will always attempt to create FIFO queues, appending .fifo to the given QueueName if necessary (all FIFO queues' names must have that suffix).
DeleteMessage Method (AmazonSQS Module)
Deletes the message specified.
Syntax
- (void)deleteMessage:(NSString*)queueId :(NSString*)receiptHandle;
Remarks
Deletes the message specified by ReceiptHandle from the queue specified by QueueId.
Note: Unlike messages received from standard queues, messages received from FIFO queues can only be deleted within their VisibilityTimeout. Attempting to call DeleteMessage for a message received from a FIFO queue after its VisibilityTimeout has expired will cause the server to return an error.
DeleteQueue Method (AmazonSQS Module)
Deletes a queue.
Syntax
Remarks
Deletes the queue specified by QueueId.
DoEvents Method (AmazonSQS Module)
Processes events from the internal message queue.
Syntax
public func doEvents() throws -> Void
- (void)doEvents;
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
GetQueueAttributes Method (AmazonSQS Module)
Returns all attributes of a queue.
Syntax
- (NSString*)getQueueAttributes:(NSString*)queueId;
Remarks
This method retrieves all of the attributes of the queue specified by QueueId, and stores them in the Attributes collection. Queues currently have five attributes that may be returned:
- ApproximateNumberOfMessages
- VisibilityTimeout (for more information, see Visibility Timeout)
- CreatedTimestamp
- LastModifiedTimestamp
- Policy
This method returns the RequestId contained in the Amazon response.
GetXValue Method (AmazonSQS Module)
Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest .
Syntax
Remarks
This method allows a user to retrieve a valid XPath expression from the HTTP response after calling SendCustomRequest.
Interrupt Method (AmazonSQS Module)
Interrupt the current method.
Syntax
public func interrupt() throws -> Void
- (void)interrupt;
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListMessages Method (AmazonSQS Module)
Gets messages from the queue.
Syntax
Remarks
This method retrieves messages from the queue specified by QueueId, and fires a Message event for each message it receives. The messages may also be accessed using the property Messages.
If VisibilityTimeout greater than -1 it is applied to the messages, otherwise the default timeout of the queue used. Only one message is retrieved by default; this behavior may be modified by changing MaxMessages.
Note: Unlike messages received from standard queues, messages received from FIFO queues can only be deleted within their VisibilityTimeout. Attempting to call DeleteMessage for a message received from a FIFO queue after its VisibilityTimeout has expired will cause the server to return an error.
ListQueues Method (AmazonSQS Module)
Lists the queues under the current account.
Syntax
public func listQueues() throws -> Void
- (void)listQueues;
Remarks
This method will fire a Queue event for each queue available for the Amazon SQS account specified by AccessKey. The listing may be filtered using QueuePrefix.
RemovePermission Method (AmazonSQS Module)
The RemovePermission action revokes any permissions in the queue policy that matches the UserLabel parameter.
Syntax
- (NSString*)removePermission:(NSString*)queueId :(NSString*)userLabel;
Remarks
Note that only the owner of the queue may revoke previously added permissions.
This method returns the RequestId contained in the Amazon response.
Reset Method (AmazonSQS Module)
Resets request-related properties.
Syntax
public func reset() throws -> Void
- (void)reset;
Remarks
Calling this method will reset the component to the original state.
ResetHeaders Method (AmazonSQS Module)
Resets all HTTP headers, cookies, and LocalFile.
Syntax
public func resetHeaders() throws -> Void
- (void)resetHeaders;
Remarks
Resets all the HTTP headers as well as LocalFile to "" (empty string).
Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next one.
SendCustomRequest Method (AmazonSQS Module)
Allows the sending of a custom request to an Amazon web service.
Syntax
public func sendCustomRequest(url: String, requestData: String, otherHeaders: String) throws -> String
- (NSString*)sendCustomRequest:(NSString*)url :(NSString*)requestData :(NSString*)otherHeaders;
Remarks
Allows the sending of a custom request to the Amazon web service. The URL parameter describes the endpoint that is being targeted. The RequestData is set to any data required for the request. The OtherHeaders parameter is used to set any additional headers that should be set for the request.
SetQueueAttribute Method (AmazonSQS Module)
Sets an attribute of a queue.
Syntax
public func setQueueAttribute(queueId: String, attributeName: String, attributeValue: String) throws -> String
- (NSString*)setQueueAttribute:(NSString*)queueId :(NSString*)attributeName :(NSString*)attributeValue;
Remarks
This method sets attributes of the queue specified by QueueId. When you change a queue's attributes, the change can take up to 60 seconds to propagate throughout the SQS system.
This method returns the RequestId contained in the Amazon response.
Connected Event (AmazonSQS Module)
This event is fired immediately after a connection completes (or fails).
Syntax
- (void)onConnected:(int)statusCode :(NSString*)description;
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.
Disconnected Event (AmazonSQS Module)
This event is fired when a connection is closed.
Syntax
- (void)onDisconnected:(int)statusCode :(NSString*)description;
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.
EndTransfer Event (AmazonSQS Module)
This event is fired when a document finishes transferring.
Syntax
func onEndTransfer(direction: Int32)
- (void)onEndTransfer:(int)direction;
Remarks
The EndTransfer event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Error Event (AmazonSQS Module)
Fired when information is available about errors during data delivery.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class .
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.
Header Event (AmazonSQS Module)
This event is fired every time a header line comes in.
Syntax
Remarks
The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
Message Event (AmazonSQS Module)
Fired for each message retrieved from the queue.
Syntax
- (void)onMessage:(NSString*)messageId :(NSString*)receiptHandle :(NSString*)messageData :(NSString*)MD5;
Remarks
When ListMessages is invoked the class fires Message for each message retrieved. The number of messages retrieved are specified using MaxMessages. OtherData is reserved for future use.
Queue Event (AmazonSQS Module)
Fired for each queue of the user.
Syntax
Remarks
When ListQueues is invoked the class fires Queue for each queue.
SSLServerAuthentication Event (AmazonSQS Module)
Fired after the server presents its certificate to the client.
Syntax
func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)
- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (AmazonSQS Module)
Fired when secure connection progress messages are available.
Syntax
func onSSLStatus(message: String)
- (void)onSSLStatus:(NSString*)message;
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (AmazonSQS Module)
This event is fired when a document starts transferring (after the headers).
Syntax
func onStartTransfer(direction: Int32)
- (void)onStartTransfer:(int)direction;
Remarks
The StartTransfer event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Status Event (AmazonSQS Module)
This event is fired when the HTTP status line is received from the server.
Syntax
- (void)onStatus:(NSString*)HTTPVersion :(int)statusCode :(NSString*)description;
Remarks
HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").
StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").
Transfer Event (AmazonSQS Module)
This event is fired while a document transfers (delivers document).
Syntax
- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)text;
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Firewall Type
The firewall the component will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .
Fields
autoDetect
Bool
Default Value: False
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewallType
FirewallTypes
Default Value: 0
This property determines the type of firewall to connect through. The applicable values are as follows:
host
String
Default Value: ""
This property contains the name or IP address of firewall (optional). If a 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 .
password
String
Default Value: ""
This property contains a password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .
port
Int32
Default Value: 0
This property contains the transmission control protocol (TCP) port for the firewall . See the description of the property for details.
Note: This property is set automatically when is set to a valid value. See the description of the property for details.
user
String
Default Value: ""
This property contains a user name if authentication is to be used connecting through a firewall. If the is specified, this property and properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class .
Constructors
public init()
Proxy Type
The proxy the component will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .
Fields
authScheme
ProxyAuthSchemes
Default Value: 0
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the and properties are set.
should be set to authNone (3) when no authentication is expected.
By default, is authBasic (0), and if the and properties are set, the component will attempt basic authentication.
If is set to authDigest (1), digest authentication will be attempted instead.
If is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.
If is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of and .
autoDetect
Bool
Default Value: False
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is .
password
String
Default Value: ""
This property contains a password if authentication is to be used for the proxy.
If is set to Basic Authentication, the and are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.
If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.
port
Int32
Default Value: 80
This property contains the Transmission Control Protocol (TCP) port for the proxy (default 80). See the description of the property for details.
server
String
Default Value: ""
If a proxy is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, an error is returned.
ssl
ProxySSLTypes
Default Value: 0
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. |
psAlways (1) | The connection is always SSL enabled. |
psNever (2) | The connection is not SSL enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
user
String
Default Value: ""
This property contains a username if authentication is to be used for the proxy.
If is set to Basic Authentication, the and properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.
If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.
Constructors
public init()
public init(server: , port: )
public init(server: , port: , user: , password: )
SQSAttribute Type
This type represents a single SQS attribute.
Remarks
This type represents a single SQS attribute.
Fields
name
String (read-only)
Default Value: ""
The name of the attribute.
value
String (read-only)
Default Value: ""
The value of the attribute.
Constructors
public init()
SqsMessage Type
An object representing a single SQS Message.
Remarks
An object representing a single SQS Message.
Fields
body
String (read-only)
Default Value: ""
The body of the SQS message.
id
String (read-only)
Default Value: ""
The ID of the SQS message.
md5
String (read-only)
Default Value: ""
The MD5 of the SQS message.
receiptHandle
String (read-only)
Default Value: ""
The Receipt handle of the SQS message.
Constructors
public init()
public init(id: , receiptHandle: , body: , mD5: )
SqsQueue Type
An object representing a single SQS queue.
Remarks
An object representing a single SQS queue.
Fields
id
String (read-only)
Default Value: ""
The ID of the SQS queue.
url
String (read-only)
Default Value: ""
The URL of the SQS queue.
Constructors
public init()
public init(id: , url: )
Config Settings (AmazonSQS Module)
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.AmazonSQS Config Settings
Amazon defines each version as the date it was released. An example is: "2009-07-15".
Possible values are:
- 0 (string - default)
- 1 (number)
- 2 (binary)
Valid array indices are from 0 to MessageAttributeCount - 1.
Valid array indices are from 0 to MessageAttributeCount - 1.
Valid array indices are from 0 to MessageAttributeCount - 1.
- Messages sent with identical message bodies that Amazon SQS must treat as unique.
- Messages sent with identical content but different message attributes that Amazon SQS must treat as unique.
- Messages sent with different content (for example, retry counts included in the message body) that Amazon SQS must treat as duplicates.
When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling PurgeQueue will be deleted; messages sent to the queue while it is being purged may be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue was called may be received, but will be deleted within the next minute.
sqs.Config("URL=https://myregion.custom-sqs-server.com");
sqs.ListMessages("MyQueue");
In order for the class to be able to auto-obtain authentication credentials, the EC2 instance must have an "instance profile" with an appropriate IAM role attached to it. Refer to the "Using an IAM Role to Grant Permissions to Applications Running on Amazon EC2 Instances" page in the Amazon IAM documentation for more information.
By default, this setting is empty. When populated with an IAM role name, the class will do the following before each request:
- Make a request against the EC2 instance to obtain temporary security credentials for the IAM role associated with the current instance profile.
- Parse the response, automatically populating the AccessKey and SecretKey properties.
- Execute the original request using the temporary security credentials that were acquired.
When enabled, the class will always append the .fifo suffix (if necessary) to the desired QueueName when CreateQueue is called. (Note that queue names can be no longer than 80 characters, including the .fifo suffix.)
HTTP Config Settings
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
The default value is False.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class .
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the class instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is .
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the class beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
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 multi-homed 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 LocalHost 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 multi-homed 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 LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This; setting is useful when trying to connect to services that require a trusted port in 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 DataIn 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 DataIn 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 config 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 SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if SSLProvider 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 etc). OpenSSL recommends to use 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
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please 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.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. 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 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 only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported 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 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 only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this 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 config setting.
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 SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include:
- 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_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
- 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_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- 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 value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which are designed to run on Windows SSLProvider 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 only supported 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 only available 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 the above 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 SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This setting is only applicable when SSLProvider is set to Internal.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication 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 traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection 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 not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class .
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 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.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this 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 SSLProvider 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 setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified 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 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.
Trappable Errors (AmazonSQS Module)
AmazonSQS Errors
601 An error returned from Amazon SQS. Please refer to the error message for explanation. |
HTTP Errors
118 Firewall Error. Error description contains detailed message. | |
143 Busy executing current method. | |
151 HTTP protocol error. The error message has the server response. | |
152 No server specified in URL | |
153 Specified URLScheme is invalid. | |
155 Range operation is not supported by server. | |
156 Invalid cookie index (out of range). | |
301 Interrupted. | |
302 Can't open AttachedFile. |
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort 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 non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't 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] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory 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 not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |