AmazonSNS Component
Properties Methods Events Config Settings Errors
The AmazonSNS component provides a simple interface to Amazon's Simple Notification Service (SNS).
Syntax
nsoftware.IPWorksMQ.AmazonSNS
Remarks
The AmazonSNS component allows you to quickly and easily access Amazon's Simple Notification Service (SNS). SNS allows you to create topics and subscriptions for notification purposes.
Before using the component you must first have an AWS account and sign up for the SNS service. To use the component, first set AccessKey and SecretKey.
To create a topic, call CreateTopic. You may manage the topic and its properties with GetTopicAttributes, SetTopicAttributes, and DeleteTopic.
To subscribe to a topic, call Subscribe. To manage a subscription, use GetSubscriptionAttributes, SetSubscriptionAttributes, and Unsubscribe.
Use ListSubscriptions, ListTopicSubscriptions, and ListTopics to list existing topics and subscriptions.
Call Publish or PublishCustom to send a notification on a topic.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AccessKey | The Access Key Id for the Amazon Web Services account. |
Firewall | A set of properties related to firewall access. |
Idle | The current status of the component. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
Proxy | A set of properties related to proxy access. |
SecretKey | The Secret Access Key for the Amazon Web Services account. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLProvider | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | The server certificate for the last established connection. |
SubscriptionMarker | The token identifying the next page of results. |
Subscriptions | A collection of subscription details. |
Timeout | The timeout for the component. |
TopicMarker | The token identifying the next page of results. |
Topics | A collection of topic details. |
UseSSL | Determines if SSL is used when connecting to Amazon. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddPermission | Adds permissions to the topic's access control policy. |
Config | Sets or retrieves a configuration setting. |
ConfirmSubscription | Completes the subscription request. |
CreateTopic | Creates a new topic. |
DeleteTopic | Deletes the specified topic. |
DoEvents | This method processes events from the internal message queue. |
GetSubscriptionAttributes | Retrieves the subscription's attributes. |
GetTopicAttributes | Retrieves the topic's attributes. |
GetXValue | Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest . |
Interrupt | This method interrupts the current method. |
ListSubscriptions | Lists subscriptions for the current account. |
ListTopics | Lists all topics for the current account. |
ListTopicSubscriptions | Lists subscriptions to the specified topic. |
Publish | Publishes a message to the topic. |
PublishCustom | Publishes a message to the topic. |
RemovePermission | Removes permissions from a topic. |
Reset | Resets request-related properties. |
SendCustomRequest | Allows the sending of a custom request to an Amazon web service. |
SetSubscriptionAttributes | Sets attributes of the subscription. |
SetTopicAttributes | Sets attributes on the specified topic. |
Subscribe | Request a subscription to the specific topic. |
Unsubscribe | Unsubscribes from the topic. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
Error | Fired when information is available about errors during data delivery. |
Log | Fired once for each log message. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
SubscriptionList | Fires with information about the subscription. |
TopicList | Fires with information about the topic. |
Config Settings
The following is a list of config settings for the component 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. |
IsSubscriptionPaged | Whether or not all subscriptions were returned by the last listing. |
IsTopicPaged | Whether or not all topics were returned by the last listing. |
JSONMessage | A custom JSON message to be published. |
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. |
PhoneNumber | The phone number to which you want to deliver an SMS message. Use E.164 format. |
SignatureVersion | The version of signature used. |
SignCustomRequest | Tells the component to sign the outgoing request. |
TargetArn | The TargetArn when publishing a message. |
TransferredData | Returns the entire XML response received from the server. |
URL | If set, the default URL will be overridden by this value. |
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. |
AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
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 component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the component 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 component. |
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. |
MaxHeaders | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
MaxHTTPCookies | Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
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 component. |
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. |
UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallListener | If true, the component binds to a SOCKS firewall as a server (TCPClient only). |
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 component 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. |
UseNTLMv2 | Whether to use NTLM V2. |
CACertFilePaths | The paths to CA certificate files when using Mono on Unix/Linux. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
AccessKey Property (AmazonSNS Component)
The Access Key Id for the Amazon Web Services account.
Syntax
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.
Firewall Property (AmazonSNS Component)
A set of properties related to firewall access.
Syntax
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.
Please refer to the Firewall type for a complete list of fields.Idle Property (AmazonSNS Component)
The current status of the component.
Syntax
Default Value
True
Remarks
This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.
This property is read-only.
LocalHost Property (AmazonSNS Component)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
Default Value
""
Remarks
This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
Proxy Property (AmazonSNS Component)
A set of properties related to proxy access.
Syntax
Remarks
This property contains fields describing the proxy through which the component will attempt to connect.
Please refer to the Proxy type for a complete list of fields.SecretKey Property (AmazonSNS Component)
The Secret Access Key for the Amazon Web Services account.
Syntax
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.
SSLAcceptServerCert Property (AmazonSNS Component)
Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate SSLAcceptServerCert { get; set; }
Public Property SSLAcceptServerCert As Certificate
Remarks
If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Please refer to the Certificate type for a complete list of fields.SSLCert Property (AmazonSNS Component)
The certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
public Certificate SSLCert { get; set; }
Public Property SSLCert As Certificate
Remarks
This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Please refer to the Certificate type for a complete list of fields.SSLProvider Property (AmazonSNS Component)
The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
public AmazonSNSSSLProviders SSLProvider { get; set; }
enum AmazonSNSSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal }
Public Property SSLProvider As AmazonsnsSSLProviders
Enum AmazonSNSSSLProviders sslpAutomatic sslpPlatform sslpInternal End Enum
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 component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.
When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.
The .NET Standard library will always use the internal implementation on all platforms.
SSLServerCert Property (AmazonSNS Component)
The server certificate for the last established connection.
Syntax
public Certificate SSLServerCert { get; }
Public ReadOnly Property SSLServerCert As Certificate
Remarks
This property contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Please refer to the Certificate type for a complete list of fields.SubscriptionMarker Property (AmazonSNS Component)
The token identifying the next page of results.
Syntax
Default Value
""
Remarks
This token identifies the next set of results to retrieve. This is populated automatically when the results are paged. When the results are not paged, or the last page of results is retrieved, this is automatically set to empty string. See ListSubscriptions for more details.
This property is not available at design time.
Subscriptions Property (AmazonSNS Component)
A collection of subscription details.
Syntax
public SNSSubscriptionList Subscriptions { get; }
Public ReadOnly Property Subscriptions As SNSSubscriptionList
Remarks
This collection is populated after a call to ListSubscriptions, ListTopicSubscriptions, or GetSubscriptionAttributes and holds details about each of the subscriptions.
This property is read-only and not available at design time.
Please refer to the SNSSubscription type for a complete list of fields.Timeout Property (AmazonSNS Component)
The timeout for the component.
Syntax
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 component will wait for the operation to complete before returning control.
The component 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 component throws an exception.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
TopicMarker Property (AmazonSNS Component)
The token identifying the next page of results.
Syntax
Default Value
""
Remarks
This token identifies the next set of results to retrieve. This is populated automatically when the results are paged. When the results are not paged, or the last page of results is retrieved, this is automatically set to empty string. See ListTopics for more details.
This property is not available at design time.
Topics Property (AmazonSNS Component)
A collection of topic details.
Syntax
public SNSTopicList Topics { get; }
Public ReadOnly Property Topics As SNSTopicList
Remarks
This collection is populated after a call to ListTopics, or GetTopicAttributes and holds details about each of the topics.
This property is read-only and not available at design time.
Please refer to the SNSTopic type for a complete list of fields.UseSSL Property (AmazonSNS Component)
Determines if SSL is used when connecting to Amazon.
Syntax
Default Value
False
Remarks
Use this property to specify whether or not the component uses SSL to connect with Amazon SNS servers.
This property is not available at design time.
AddPermission Method (AmazonSNS Component)
Adds permissions to the topic's access control policy.
Syntax
public void AddPermission(string topicArn, string policyLabel, string AWSAccountIds, string actionNames); Async Version public async Task AddPermission(string topicArn, string policyLabel, string AWSAccountIds, string actionNames); public async Task AddPermission(string topicArn, string policyLabel, string AWSAccountIds, string actionNames, CancellationToken cancellationToken);
Public Sub AddPermission(ByVal TopicArn As String, ByVal PolicyLabel As String, ByVal AWSAccountIds As String, ByVal ActionNames As String) Async Version Public Sub AddPermission(ByVal TopicArn As String, ByVal PolicyLabel As String, ByVal AWSAccountIds As String, ByVal ActionNames As String) As Task Public Sub AddPermission(ByVal TopicArn As String, ByVal PolicyLabel As String, ByVal AWSAccountIds As String, ByVal ActionNames As String, cancellationToken As CancellationToken) As Task
Remarks
This method may be used to add a statement to the topic's access control policy.
TopicArn specifies the topic.
PolicyLabel should be set to a unique identifier for the new policy statement.
AWSAccountIds is a comma separated list of AWS account IDs of users who will be granted access to the specified actions. The users must have an AWS account, but do not need to be signed up for the SNS service.
ActionNames is a comma separated list of actions that corresponds to the AWS account IDs specified in AWSAccountIds. Possible values are:
- AddPermission
- CreateTopic
- DeleteTopic
- GetSubscriptionAttributes
- GetTopicAttributes
- ListSubscriptions
- ListSubscriptionsByTopic
- ListTopics
- Publish
- RemovePermission
- SetSubscriptionAttributes
- SetTopicAttributes
- Subscribe
- Unsubscribe
The AWSAccountIds and ActionNames parameters must have the same number of values. The actions correspond to the account IDs and only one action may be set for one account ID at a time. For instance:
component.AddPermission("myTopicArn", "myLabel", "1234567,7654321", "Publish,GetTopicAttributes");
Config Method (AmazonSNS Component)
Sets or retrieves a configuration setting.
Syntax
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.
ConfirmSubscription Method (AmazonSNS Component)
Completes the subscription request.
Syntax
public string ConfirmSubscription(string topicArn, string token); Async Version public async Task<string> ConfirmSubscription(string topicArn, string token); public async Task<string> ConfirmSubscription(string topicArn, string token, CancellationToken cancellationToken);
Public Function ConfirmSubscription(ByVal TopicArn As String, ByVal Token As String) As String Async Version Public Function ConfirmSubscription(ByVal TopicArn As String, ByVal Token As String) As Task(Of String) Public Function ConfirmSubscription(ByVal TopicArn As String, ByVal Token As String, cancellationToken As CancellationToken) As Task(Of String)
Remarks
This method completes the subscription request. After calling the Subscribe method this method must be used to complete the subscription request (if it could not be completed immediately when Subscribe was called).
Set Token to the confirmation token delivered to the endpoint specified in the call to Subscribe. The TopicArn parameter specifies the topic of the subscription.
This method returns the SubscriptionArn which may be used in further subscription related operation. SubscriptionArn may be used with the following methods:
CreateTopic Method (AmazonSNS Component)
Creates a new topic.
Syntax
Remarks
This method creates a new topic specified by the Name parameter. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
The TopicArn is returned by this method an identifier that is used in other operations on the topic. The TopicArn is required for these methods:
- DeleteTopic
- GetTopicAttributes
- ListTopicSubscriptions
- Publish
- PublishCustom
- RemovePermission
- SetTopicAttributes
- Subscribe
DeleteTopic Method (AmazonSNS Component)
Deletes the specified topic.
Syntax
public void DeleteTopic(string topicArn); Async Version public async Task DeleteTopic(string topicArn); public async Task DeleteTopic(string topicArn, CancellationToken cancellationToken);
Public Sub DeleteTopic(ByVal TopicArn As String) Async Version Public Sub DeleteTopic(ByVal TopicArn As String) As Task Public Sub DeleteTopic(ByVal TopicArn As String, cancellationToken As CancellationToken) As Task
Remarks
This method deletes the topic specified by the TopicArn parameter. All subscriptions to this topic will also be deleted. If the topic does not exist, no error is returned by Amazon.
DoEvents Method (AmazonSNS Component)
This method processes events from the internal message queue.
Syntax
public void DoEvents(); Async Version public async Task DoEvents(); public async Task DoEvents(CancellationToken cancellationToken);
Public Sub DoEvents() Async Version Public Sub DoEvents() As Task Public Sub DoEvents(cancellationToken As CancellationToken) As Task
Remarks
When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.
GetSubscriptionAttributes Method (AmazonSNS Component)
Retrieves the subscription's attributes.
Syntax
public void GetSubscriptionAttributes(string subscriptionArn); Async Version public async Task GetSubscriptionAttributes(string subscriptionArn); public async Task GetSubscriptionAttributes(string subscriptionArn, CancellationToken cancellationToken);
Public Sub GetSubscriptionAttributes(ByVal SubscriptionArn As String) Async Version Public Sub GetSubscriptionAttributes(ByVal SubscriptionArn As String) As Task Public Sub GetSubscriptionAttributes(ByVal SubscriptionArn As String, cancellationToken As CancellationToken) As Task
Remarks
This method retrieves the subscription's attributes. The attributes are available through the Subscriptions collection.
GetTopicAttributes Method (AmazonSNS Component)
Retrieves the topic's attributes.
Syntax
public void GetTopicAttributes(string topicArn); Async Version public async Task GetTopicAttributes(string topicArn); public async Task GetTopicAttributes(string topicArn, CancellationToken cancellationToken);
Public Sub GetTopicAttributes(ByVal TopicArn As String) Async Version Public Sub GetTopicAttributes(ByVal TopicArn As String) As Task Public Sub GetTopicAttributes(ByVal TopicArn As String, cancellationToken As CancellationToken) As Task
Remarks
This method topic the subscription's attributes. The topic are available through the Topics collection.
GetXValue Method (AmazonSNS Component)
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 (AmazonSNS Component)
This method interrupts the current method.
Syntax
public void Interrupt(); Async Version public async Task Interrupt(); public async Task Interrupt(CancellationToken cancellationToken);
Public Sub Interrupt() Async Version Public Sub Interrupt() As Task Public Sub Interrupt(cancellationToken As CancellationToken) As Task
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListSubscriptions Method (AmazonSNS Component)
Lists subscriptions for the current account.
Syntax
public void ListSubscriptions(); Async Version public async Task ListSubscriptions(); public async Task ListSubscriptions(CancellationToken cancellationToken);
Public Sub ListSubscriptions() Async Version Public Sub ListSubscriptions() As Task Public Sub ListSubscriptions(cancellationToken As CancellationToken) As Task
Remarks
This method lists the subscriptions for the current AWS account.
When calling this method all subscriptions for the current AWS account identified by AccessKey and SecretKey will be listed. The SubscriptionList event will fire once for each subscription and the Subscriptions collection will be populated with information about the subscriptions.
If the results are paged the IsSubscriptionPaged setting will return the value "True" and SubscriptionMarker will be populated. You may continue to call this method until IsSubscriptionPaged returns "False" and SubscriptionMarker is empty to retrieve all results.
ListTopics Method (AmazonSNS Component)
Lists all topics for the current account.
Syntax
public void ListTopics(); Async Version public async Task ListTopics(); public async Task ListTopics(CancellationToken cancellationToken);
Public Sub ListTopics() Async Version Public Sub ListTopics() As Task Public Sub ListTopics(cancellationToken As CancellationToken) As Task
Remarks
This method lists all topics for the AWS account specified by AccessKey and SecretKey.
When this method is called the TopicList event will fire once for each topic and the Topics collection will be populated with information about the topics.
If the results are paged the IsTopicPaged setting will return the value "True" and TopicMarker will be populated. You may continue to call this method until IsTopicPaged returns "False" and TopicMarker is empty to retrieve all results.
ListTopicSubscriptions Method (AmazonSNS Component)
Lists subscriptions to the specified topic.
Syntax
public void ListTopicSubscriptions(string topicArn); Async Version public async Task ListTopicSubscriptions(string topicArn); public async Task ListTopicSubscriptions(string topicArn, CancellationToken cancellationToken);
Public Sub ListTopicSubscriptions(ByVal TopicArn As String) Async Version Public Sub ListTopicSubscriptions(ByVal TopicArn As String) As Task Public Sub ListTopicSubscriptions(ByVal TopicArn As String, cancellationToken As CancellationToken) As Task
Remarks
This method lists the subscriptions to the specified topic.
When calling this method the subscriptions to the topic specified by TopicARN will be listed. The SubscriptionList event will fire once for each subscription and the Subscriptions collection will be populated with information about the subscriptions.
If the results are paged the IsSubscriptionPaged setting will return the value "True" and SubscriptionMarker will be populated. You may continue to call this method until IsSubscriptionPaged returns "False" and SubscriptionMarker is empty to retrieve all results.
Publish Method (AmazonSNS Component)
Publishes a message to the topic.
Syntax
public string Publish(string topicArn, string subject, string message); Async Version public async Task<string> Publish(string topicArn, string subject, string message); public async Task<string> Publish(string topicArn, string subject, string message, CancellationToken cancellationToken);
Public Function Publish(ByVal TopicArn As String, ByVal Subject As String, ByVal message As String) As String Async Version Public Function Publish(ByVal TopicArn As String, ByVal Subject As String, ByVal message As String) As Task(Of String) Public Function Publish(ByVal TopicArn As String, ByVal Subject As String, ByVal message As String, cancellationToken As CancellationToken) As Task(Of String)
Remarks
This method publishes a message to the topic specified by TopicArn.
The Subject parameter is optional and specifies the "Subject" line of the message delivered to e-mail endpoints. Subjects must be ASCII text that begins with a letter, number or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
The Message parameter is the text to send. Messages must be UTF-8 encoded strings at most 64 KB in size (65536 bytes, not 65536 characters).
The same message will be delivered to all subscribers. To send different messages based on the protocol used by the subscription call PublishCustom instead.
The method returns the unique MessageId assigned to the published message. It will be at most 100 characters in length.
PublishCustom Method (AmazonSNS Component)
Publishes a message to the topic.
Syntax
public string PublishCustom(string topicArn, string subject, string defaultMessage, string emailMessage, string emailJsonMessage, string httpMessage, string httpsMessage, string smsMessage, string sqsMessage); Async Version public async Task<string> PublishCustom(string topicArn, string subject, string defaultMessage, string emailMessage, string emailJsonMessage, string httpMessage, string httpsMessage, string smsMessage, string sqsMessage); public async Task<string> PublishCustom(string topicArn, string subject, string defaultMessage, string emailMessage, string emailJsonMessage, string httpMessage, string httpsMessage, string smsMessage, string sqsMessage, CancellationToken cancellationToken);
Public Function PublishCustom(ByVal TopicArn As String, ByVal Subject As String, ByVal defaultMessage As String, ByVal emailMessage As String, ByVal emailJsonMessage As String, ByVal httpMessage As String, ByVal httpsMessage As String, ByVal smsMessage As String, ByVal sqsMessage As String) As String Async Version Public Function PublishCustom(ByVal TopicArn As String, ByVal Subject As String, ByVal defaultMessage As String, ByVal emailMessage As String, ByVal emailJsonMessage As String, ByVal httpMessage As String, ByVal httpsMessage As String, ByVal smsMessage As String, ByVal sqsMessage As String) As Task(Of String) Public Function PublishCustom(ByVal TopicArn As String, ByVal Subject As String, ByVal defaultMessage As String, ByVal emailMessage As String, ByVal emailJsonMessage As String, ByVal httpMessage As String, ByVal httpsMessage As String, ByVal smsMessage As String, ByVal sqsMessage As String, cancellationToken As CancellationToken) As Task(Of String)
Remarks
This method may be used instead of Publish to specify different messages depending on the protocol used by the subscription.
TopicArn specifies the topic.
The Subject parameter is optional and specifies the "Subject" line of the message delivered to e-mail endpoints. Subjects must be ASCII text that begins with a letter, number or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
DefaultMessage will be used for any protocol that is not specifically assigned a message. If empty string is specified for any other message parameter this value will be used.
EmailMessage, EmailJsonMessage, HttpMessage, HttpsMessage, SmsMessage, and SqsMessage specify messages for the respective protocol. These parameters are all optional. If empty string is specified the DefaultMessage will be used.
The method returns the unique MessageId assigned to the published message. It will be at most 100 characters in length.
RemovePermission Method (AmazonSNS Component)
Removes permissions from a topic.
Syntax
public void RemovePermission(string topicArn, string policyLabel); Async Version public async Task RemovePermission(string topicArn, string policyLabel); public async Task RemovePermission(string topicArn, string policyLabel, CancellationToken cancellationToken);
Public Sub RemovePermission(ByVal TopicArn As String, ByVal PolicyLabel As String) Async Version Public Sub RemovePermission(ByVal TopicArn As String, ByVal PolicyLabel As String) As Task Public Sub RemovePermission(ByVal TopicArn As String, ByVal PolicyLabel As String, cancellationToken As CancellationToken) As Task
Remarks
This method removes permissions specified by the PolicyLabel from the access control policy of the topic specified by TopicArn.
Reset Method (AmazonSNS Component)
Resets request-related properties.
Syntax
public void Reset(); Async Version public async Task Reset(); public async Task Reset(CancellationToken cancellationToken);
Public Sub Reset() Async Version Public Sub Reset() As Task Public Sub Reset(cancellationToken As CancellationToken) As Task
Remarks
Calling this method will reset the component to the original state.
SendCustomRequest Method (AmazonSNS Component)
Allows the sending of a custom request to an Amazon web service.
Syntax
public string SendCustomRequest(string url, string requestData, string otherHeaders); Async Version public async Task<string> SendCustomRequest(string url, string requestData, string otherHeaders); public async Task<string> SendCustomRequest(string url, string requestData, string otherHeaders, CancellationToken cancellationToken);
Public Function SendCustomRequest(ByVal Url As String, ByVal RequestData As String, ByVal OtherHeaders As String) As String Async Version Public Function SendCustomRequest(ByVal Url As String, ByVal RequestData As String, ByVal OtherHeaders As String) As Task(Of String) Public Function SendCustomRequest(ByVal Url As String, ByVal RequestData As String, ByVal OtherHeaders As String, cancellationToken As CancellationToken) As Task(Of String)
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.
SetSubscriptionAttributes Method (AmazonSNS Component)
Sets attributes of the subscription.
Syntax
public void SetSubscriptionAttributes(string subscriptionArn, string attributeValue); Async Version public async Task SetSubscriptionAttributes(string subscriptionArn, string attributeValue); public async Task SetSubscriptionAttributes(string subscriptionArn, string attributeValue, CancellationToken cancellationToken);
Public Sub SetSubscriptionAttributes(ByVal SubscriptionArn As String, ByVal AttributeValue As String) Async Version Public Sub SetSubscriptionAttributes(ByVal SubscriptionArn As String, ByVal AttributeValue As String) As Task Public Sub SetSubscriptionAttributes(ByVal SubscriptionArn As String, ByVal AttributeValue As String, cancellationToken As CancellationToken) As Task
Remarks
This method is used to set an attribute of the subscription. Currently only the delivery policy may be set.
The SubscriptionArn parameter specifies the Amazon Resource Name (ARN) of the subscription.
The AttributeValue specifies the value to be set. Since the only currently valid attribute is the delivery policy, this is the value of the delivery policy in JSON format, for instance:
{"healthyRetryPolicy": {"minDelayTarget": 1, "maxDelayTarget": 5, "numRetries": 5, "numMaxDelayRetries": 5, "backoffFunction": "linear"}}
SetTopicAttributes Method (AmazonSNS Component)
Sets attributes on the specified topic.
Syntax
public void SetTopicAttributes(string topicArn, int attributeType, string attributeValue); Async Version public async Task SetTopicAttributes(string topicArn, int attributeType, string attributeValue); public async Task SetTopicAttributes(string topicArn, int attributeType, string attributeValue, CancellationToken cancellationToken);
Public Sub SetTopicAttributes(ByVal TopicArn As String, ByVal AttributeType As Integer, ByVal AttributeValue As String) Async Version Public Sub SetTopicAttributes(ByVal TopicArn As String, ByVal AttributeType As Integer, ByVal AttributeValue As String) As Task Public Sub SetTopicAttributes(ByVal TopicArn As String, ByVal AttributeType As Integer, ByVal AttributeValue As String, cancellationToken As CancellationToken) As Task
Remarks
This method may be used to specify attributes on the specified topic.
TopicArn specifies the topic.
AttributeType determines which attribute is set and AttributeValue specifies the value. The following table provides more information:
AttributeType | AttributeValue |
0 (DisplayName) | A human readable name to be used in the "From" field for email based endpoints |
1 (AccessPolicy) | A JSON serialized access policy for the topic |
2 (DeliveryPolicy) | A JSON serialized delivery policy for the topic |
An example access policy is:
{"Version":"2008-10-17","Id":"__default_policy_ID","Statement":[{"Sid":"__default_statement_ID","Effect":"Allow","Principal":{"AWS":"*"},"Action":["SNS:Publish","SNS:RemovePermission","SNS:SetTopicAttributes","SNS:DeleteTopic","SNS:ListSubscriptionsByTopic","SNS:GetTopicAttributes","SNS:Receive","SNS:AddPermission","SNS:Subscribe"],"Resource":"arn:aws:sns:us-east-1:120151960619:TestTopic","Condition":{"StringEquals":{"AWS:SourceOwner":"120151960619"}}},{"Sid":"__console_pub_0","Effect":"Allow","Principal":{"AWS":"*"},"Action":"SNS:Publish","Resource":"arn:aws:sns:us-east-1:120151960619:TestTopic"}]}
An example delivery policy is:
{"http":{"defaultHealthyRetryPolicy": {"minDelayTarget": 1, "maxDelayTarget": 5, "numRetries": 5, "numMaxDelayRetries": 5, "backoffFunction": "linear"}}}
Subscribe Method (AmazonSNS Component)
Request a subscription to the specific topic.
Syntax
public string Subscribe(string topicArn, string endpoint, int endpointProtocol); Async Version public async Task<string> Subscribe(string topicArn, string endpoint, int endpointProtocol); public async Task<string> Subscribe(string topicArn, string endpoint, int endpointProtocol, CancellationToken cancellationToken);
Public Function Subscribe(ByVal TopicArn As String, ByVal Endpoint As String, ByVal EndpointProtocol As Integer) As String Async Version Public Function Subscribe(ByVal TopicArn As String, ByVal Endpoint As String, ByVal EndpointProtocol As Integer) As Task(Of String) Public Function Subscribe(ByVal TopicArn As String, ByVal Endpoint As String, ByVal EndpointProtocol As Integer, cancellationToken As CancellationToken) As Task(Of String)
Remarks
This method requests a subscription to the topic specified by TopicArn. If the subscription was created immediately without requiring confirmation the SubscriptionArn will be returned by this method. The SubscriptionArn will begin with "arn:aws:sns". SubscriptionArn may be used with the following methods:
If the subscription requires confirmation this method returns the subscription status such as "pending confirmation".
The Endpoint and EndpointProtocol parameters specify how the subscription confirmation message is delivered. Possible values for EndpointProtocol are:
0 (email) | message via SMTP |
1 (email-json) | JSON-encoded message via SMTP |
2 (http) | JSON-encoded message via HTTP POST |
3 (https) | JSON-encoded message via HTTPS POST |
4 (sms) | message via SMS |
5 (sqs) | JSON-encoded message to an Amazon SQS queue |
The Endpoint parameter format depends on the chosen EndpointProtocol. Possible formats are:
A valid e-mail address | for use with the "email" protocol |
A valid e-mail address | for use with the "email-json" protocol |
A URL beginning with "http://" | for use with the "http" protocol |
A URL beginning with "https://" | for use with the "https" protocol |
A phone number (e.g. 19195447070) | for use with the "sms" protocol |
A SQS queue ARN | for use with the "sqs" protocol |
Once the subscription confirmation is received by the endpoint owner the ConfirmSubscription method must be called with the confirmation token to complete the subscription.
Note: Confirmation tokens are valid for 3 days.
Unsubscribe Method (AmazonSNS Component)
Unsubscribes from the topic.
Syntax
public void Unsubscribe(string subscriptionArn); Async Version public async Task Unsubscribe(string subscriptionArn); public async Task Unsubscribe(string subscriptionArn, CancellationToken cancellationToken);
Public Sub Unsubscribe(ByVal SubscriptionArn As String) Async Version Public Sub Unsubscribe(ByVal SubscriptionArn As String) As Task Public Sub Unsubscribe(ByVal SubscriptionArn As String, cancellationToken As CancellationToken) As Task
Remarks
This method deletes a subscription to a topic. The subscription is identified by the SubscriptionArn parameter.
If the subscription requires authentication for deletion, only the subscription owner or topic owner can unsubscribe. If authentication is not required a cancellation notice is sent to the endpoint, so that the endpoint owner can re-subscribe if the unsubscribe request was unintentional.
Error Event (AmazonSNS Component)
Fired when information is available about errors during data delivery.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, AmazonSNSErrorEventArgs e); public class AmazonSNSErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As AmazonSNSErrorEventArgs) Public Class AmazonSNSErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.
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.
Log Event (AmazonSNS Component)
Fired once for each log message.
Syntax
public event OnLogHandler OnLog; public delegate void OnLogHandler(object sender, AmazonSNSLogEventArgs e); public class AmazonSNSLogEventArgs : EventArgs { public int LogLevel { get; } public string Message { get; } public string LogType { get; } }
Public Event OnLog As OnLogHandler Public Delegate Sub OnLogHandler(sender As Object, e As AmazonSNSLogEventArgs) Public Class AmazonSNSLogEventArgs Inherits EventArgs Public ReadOnly Property LogLevel As Integer Public ReadOnly Property Message As String Public ReadOnly Property LogType As String End Class
Remarks
This event is fired once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of message. Possible values are as follows:
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).
Message is the log entry.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
SSLServerAuthentication Event (AmazonSNS Component)
Fired after the server presents its certificate to the client.
Syntax
public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication; public delegate void OnSSLServerAuthenticationHandler(object sender, AmazonSNSSSLServerAuthenticationEventArgs e); public class AmazonSNSSSLServerAuthenticationEventArgs : EventArgs { public string CertEncoded { get; }
public byte[] CertEncodedB { get; } public string CertSubject { get; } public string CertIssuer { get; } public string Status { get; } public bool Accept { get; set; } }
Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As AmazonSNSSSLServerAuthenticationEventArgs) Public Class AmazonSNSSSLServerAuthenticationEventArgs Inherits EventArgs Public ReadOnly Property CertEncoded As String
Public ReadOnly Property CertEncodedB As Byte() Public ReadOnly Property CertSubject As String Public ReadOnly Property CertIssuer As String Public ReadOnly Property Status As String Public Property Accept As Boolean End Class
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 (AmazonSNS Component)
Fired when secure connection progress messages are available.
Syntax
public event OnSSLStatusHandler OnSSLStatus; public delegate void OnSSLStatusHandler(object sender, AmazonSNSSSLStatusEventArgs e); public class AmazonSNSSSLStatusEventArgs : EventArgs { public string Message { get; } }
Public Event OnSSLStatus As OnSSLStatusHandler Public Delegate Sub OnSSLStatusHandler(sender As Object, e As AmazonSNSSSLStatusEventArgs) Public Class AmazonSNSSSLStatusEventArgs Inherits EventArgs Public ReadOnly Property Message As String End Class
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
SubscriptionList Event (AmazonSNS Component)
Fires with information about the subscription.
Syntax
public event OnSubscriptionListHandler OnSubscriptionList; public delegate void OnSubscriptionListHandler(object sender, AmazonSNSSubscriptionListEventArgs e); public class AmazonSNSSubscriptionListEventArgs : EventArgs { public string SubscriptionArn { get; } public string TopicArn { get; } public string Owner { get; } public string Endpoint { get; } public int Protocol { get; } }
Public Event OnSubscriptionList As OnSubscriptionListHandler Public Delegate Sub OnSubscriptionListHandler(sender As Object, e As AmazonSNSSubscriptionListEventArgs) Public Class AmazonSNSSubscriptionListEventArgs Inherits EventArgs Public ReadOnly Property SubscriptionArn As String Public ReadOnly Property TopicArn As String Public ReadOnly Property Owner As String Public ReadOnly Property Endpoint As String Public ReadOnly Property Protocol As Integer End Class
Remarks
This event fires once for each subscription returned from a call to ListSubscriptions or ListTopicSubscriptions.
SubscriptionArn is the ARN of the subscription.
TopicArn is the ARN of the subscription's topic.
Owner is the subscription's owner.
Protocol is the subscription's protocol. Possible values are:
0 (email) | message via SMTP |
1 (email-json) | JSON-encoded message via SMTP |
2 (http) | JSON-encoded message via HTTP POST |
3 (https) | JSON-encoded message via HTTPS POST |
4 (sms) | message via SMS |
5 (sqs) | JSON-encoded message to an Amazon SQS queue |
Endpoint is the subscription's endpoint. Possible formats are:
A valid e-mail address | for use with the "email" protocol |
A valid e-mail address | for use with the "email-json" protocol |
A URL beginning with "http://" | for use with the "http" protocol |
A URL beginning with "https://" | for use with the "https" protocol |
A phone number (e.g. 19195447070) | for use with the "sms" protocol |
A SQS queue ARN | for use with the "sqs" protocol |
TopicList Event (AmazonSNS Component)
Fires with information about the topic.
Syntax
public event OnTopicListHandler OnTopicList; public delegate void OnTopicListHandler(object sender, AmazonSNSTopicListEventArgs e); public class AmazonSNSTopicListEventArgs : EventArgs { public string TopicArn { get; } }
Public Event OnTopicList As OnTopicListHandler Public Delegate Sub OnTopicListHandler(sender As Object, e As AmazonSNSTopicListEventArgs) Public Class AmazonSNSTopicListEventArgs Inherits EventArgs Public ReadOnly Property TopicArn As String End Class
Remarks
This event fires once for each topic returned from a call to ListTopics.
TopicARN identifies the current topic.
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
- EffectiveDate
- ExpirationDate
- ExtendedKeyUsage
- Fingerprint
- FingerprintSHA1
- FingerprintSHA256
- Issuer
- PrivateKey
- PrivateKeyAvailable
- PrivateKeyContainer
- PublicKey
- PublicKeyAlgorithm
- PublicKeyLength
- SerialNumber
- SignatureAlgorithm
- Store
- StorePassword
- StoreType
- SubjectAltNames
- ThumbprintMD5
- ThumbprintSHA1
- ThumbprintSHA256
- Usage
- UsageFlags
- Version
- Subject
- Encoded
Fields
EffectiveDate
string (read-only)
Default: ""
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
string (read-only)
Default: ""
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
string (read-only)
Default: ""
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
string (read-only)
Default: ""
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
string (read-only)
Default: ""
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
string (read-only)
Default: ""
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
string (read-only)
Default: ""
The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
string (read-only)
Default: ""
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
bool (read-only)
Default: False
Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
string (read-only)
Default: ""
The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
string (read-only)
Default: ""
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
string (read-only)
Default: ""
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
int (read-only)
Default: 0
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
string (read-only)
Default: ""
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
string (read-only)
Default: ""
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
string
Default: "MY"
The name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StoreB
byte []
Default: "MY"
The name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
string
Default: ""
If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store.
StoreType
CertStoreTypes
Default: 0
The type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This field 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 component. 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 Store and set StorePassword 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. |
SubjectAltNames
string (read-only)
Default: ""
Comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
string (read-only)
Default: ""
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
string (read-only)
Default: ""
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
string (read-only)
Default: ""
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
string (read-only)
Default: ""
The text description of UsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int (read-only)
Default: 0
The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
string (read-only)
Default: ""
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
string
Default: ""
The subject of the certificate used for client authentication.
This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.
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.
Encoded
string
Default: ""
The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
EncodedB
byte []
Default: ""
The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
public Certificate();
Public Certificate()
Creates a instance whose properties can be set. This is useful for use with when generating new certificates.
public Certificate(string certificateFile);
Public Certificate(ByVal CertificateFile As String)
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate(byte[] encoded);
Public Certificate(ByVal Encoded As Byte())
Parses Encoded as an X.509 public key.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.
ConfigurationString is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the cstUser , cstMachine , cstPublicKeyFile , and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
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 Host and the FirewallType.
Fields
AutoDetect
bool
Default: False
Whether to automatically detect and use firewall system settings, if available.
FirewallType
FirewallTypes
Default: 0
The type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. Port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Host
string
Default: ""
The name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the component throws an exception.
Password
string
Default: ""
A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.
Port
int
Default: 0
The Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.
Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.
User
string
Default: ""
A username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the component throws an exception.
Constructors
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 Server and the AuthScheme.
Fields
AuthScheme
ProxyAuthSchemes
Default: 0
The type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.
AuthScheme should be set to authNone (3) when no authentication is expected.
By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication.
If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.
If AuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this field will clear the values of User and Password.
AutoDetect
bool
Default: False
Whether to automatically detect and use proxy system settings, if available. The default value is false.
Password
string
Default: ""
A password if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Port
int
Default: 80
The Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.
Server
string
Default: ""
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the Server field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.
SSL
ProxySSLTypes
Default: 0
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 component will use the psTunnel option. If the URL is an http URL, the component 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: ""
A username if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Constructors
SNSSubscription Type
This provides details about the subscription.
Remarks
The fields below provide details about the subscription.
- ConfirmationWasAuthenticated
- DeliveryPolicy
- EffectiveDeliveryPolicy
- Endpoint
- HasAttributes
- Owner
- Protocol
- SubscriptionArn
- TopicArn
Fields
ConfirmationWasAuthenticated
bool (read-only)
Default: False
This field reports whether or not the subscription was confirmed.
Note: This field is only applicable after calling GetSubscriptionAttributes.
DeliveryPolicy
string (read-only)
Default: ""
This field holds the JSON serialization of the subscription's delivery policy.
Note: This field is only applicable after calling GetSubscriptionAttributes.
EffectiveDeliveryPolicy
string (read-only)
Default: ""
This field holds the JSON serialization of the subscription's effective delivery policy. This policy takes into account the topic and account defaults.
Note: This field is only applicable after calling GetSubscriptionAttributes.
Endpoint
string (read-only)
Default: ""
This field contains the subscription's endpoint.
The format of the endpoint depends on the protocol used for the subscription. Possible formats are:
A valid e-mail address | for use with the "email" protocol |
A valid e-mail address | for use with the "email-json" protocol |
A URL beginning with "http://" | for use with the "http" protocol |
A URL beginning with "https://" | for use with the "https" protocol |
A phone number (e.g. 19195447070) | for use with the "sms" protocol |
A SQS queue ARN | for use with the "sqs" protocol |
Note: This field is only applicable after calling ListSubscriptions or ListTopicSubscriptions.
HasAttributes
bool (read-only)
Default: False
This field returns true if the subscription attributes are available. A subscription's attributes are only returned and parsed after calling GetSubscriptionAttributes. This field serves as an easy way to determine if the subscription's attributes are available.
The following fields are applicable after calling GetSubscriptionAttributes:
The following fields are applicable after calling ListSubscriptions or ListTopicSubscriptions:
Owner
string (read-only)
Default: ""
The AWS account ID of the subscription's owner.
Protocol
int (read-only)
Default: 0
This field specifies the protocol used by the subscription. Possible values are:
0 (email) | message via SMTP |
1 (email-json) | JSON-encoded message via SMTP |
2 (http) | JSON-encoded message via HTTP POST |
3 (https) | JSON-encoded message via HTTPS POST |
4 (sms) | message via SMS |
5 (sqs) | JSON-encoded message to an Amazon SQS queue |
Note: This field is only applicable after calling ListSubscriptions or ListTopicSubscriptions.
SubscriptionArn
string (read-only)
Default: ""
The subscription's Amazon Resource Name (ARN) used to identify the subscription.
TopicArn
string (read-only)
Default: ""
The Amazon Resource Name (ARN) of the topic this subscription is associated with.
Constructors
public SNSSubscription();
Public SNSSubscription()
public SNSSubscription(string subscriptionArn, string topicArn, string owner, string endpoint, int protocol, bool confirmationWasAuthenticated, string deliveryPolicy, string effectiveDeliveryPolicy, bool hasAttributes);
Public SNSSubscription(ByVal SubscriptionArn As String, ByVal TopicArn As String, ByVal Owner As String, ByVal Endpoint As String, ByVal Protocol As Integer, ByVal ConfirmationWasAuthenticated As Boolean, ByVal DeliveryPolicy As String, ByVal EffectiveDeliveryPolicy As String, ByVal HasAttributes As Boolean)
SNSTopic Type
This provides details about the topic.
Remarks
The fields below provide details about the topic.
- AccessPolicy
- DeliveryPolicy
- DisplayName
- EffectiveDeliveryPolicy
- HasAttributes
- Owner
- SubscriptionsConfirmed
- SubscriptionsDeleted
- SubscriptionsPending
- TopicArn
Fields
AccessPolicy
string (read-only)
Default: ""
This field holds the JSON serialized access control policy for the topic.
Note: This field is only applicable after calling GetTopicAttributes.
DeliveryPolicy
string (read-only)
Default: ""
The JSON serialized policy for the topic.
Note: This field is only applicable after calling GetTopicAttributes.
DisplayName
string (read-only)
Default: ""
This field holds the name used in the 'From' field for email based endpoints.
Note: This field is only applicable after calling GetTopicAttributes.
EffectiveDeliveryPolicy
string (read-only)
Default: ""
This field holds the JSON serialization of the topic's effective delivery policy. This policy takes into account the topic and account defaults.
Note: This field is only applicable after calling GetTopicAttributes.
HasAttributes
bool (read-only)
Default: False
This field returns true if the topic attributes are available. A topic's attributes are only returned and parsed after calling GetTopicAttributes. This field serves as an easy way to determine if the topic's attributes are available.
The following fields are applicable after calling GetTopicAttributes:
- DeliveryPolicy
- DisplayName
- EffectiveDeliveryPolicy
- Owner
- AccessPolicy
- SubscriptionsConfirmed
- SubscriptionsDeleted
- SubscriptionsPending
- TopicArn
The following fields are applicable after calling ListTopics:
Owner
string (read-only)
Default: ""
The AWS account ID of the topic's owner.
Note: This field is only applicable after calling GetTopicAttributes.
SubscriptionsConfirmed
int (read-only)
Default: 0
The number of confirmed subscriptions to this topic.
Note: This field is only applicable after calling GetTopicAttributes.
SubscriptionsDeleted
int (read-only)
Default: 0
The number of deleted subscriptions on this topic.
Note: This field is only applicable after calling GetTopicAttributes.
SubscriptionsPending
int (read-only)
Default: 0
The number of pending subscriptions on this topic.
Note: This field is only applicable after calling GetTopicAttributes.
TopicArn
string (read-only)
Default: ""
The Amazon Resource Name (ARN) of the topic.
Constructors
public SNSTopic(string topicArn, string owner, string displayName, string accessPolicy, string deliveryPolicy, string effectiveDeliveryPolicy, int subscriptionsPending, int subscriptionsConfirmed, int subscriptionsDeleted, bool hasAttributes);
Public SNSTopic(ByVal TopicArn As String, ByVal Owner As String, ByVal DisplayName As String, ByVal AccessPolicy As String, ByVal DeliveryPolicy As String, ByVal EffectiveDeliveryPolicy As String, ByVal SubscriptionsPending As Integer, ByVal SubscriptionsConfirmed As Integer, ByVal SubscriptionsDeleted As Integer, ByVal HasAttributes As Boolean)
Config Settings (AmazonSNS Component)
The component 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 component, access to these internal properties is provided through the Config method.SNS Config Settings
This describes the API version as defined by the service of the current protocol. The default is set to the version that the component was designed around, but may be changed to a different version.
Amazon defines each version as the date it was released. An example is: "2009-07-15".
The following methods are supported: GET,PUT,HEAD,POST and DELETE and are only used when SendCustomRequest is called. The default value is "" (empty string) in which case the default HTTP methods are used (more details about the default behavior can be found on the SendCustomRequest page).
This configuration may be queried after a call to ListSubscriptions or ListTopicSubscriptions to find out whether or not the server sent all subscriptions in the last listing. If all subscriptions were not listed, the component automatically sets the SubscriptionMarker property to a token used in the next request.
This configuration may be queried after a call to ListTopics to find out whether or not the server sent all topics in the last listing. If all topics were not listed, the component automatically sets the TopicMarker property to a token used in the next request.
This configuration allows you to publish a custom JSON message instead of the JSON message that is built internally by the component. This configuration is only valid when calling PublishCustom.
This setting is used to get or set the number of message attributes. This setting is applicable in SQS when calling the CreateMessage and ListMessages methods. This setting is applicable in SNS when calling the PublishMessage method.
This setting can be used to get or set the data type of the message attribute. This setting is applicable in SQS when calling the CreateMessage and ListMessages methods. This setting is applicable in SNS when calling the PublishMessage method.
Possible values are:
- 0 (string - default)
- 1 (number)
- 2 (binary)
Valid array indices are from 0 to MessageAttributeCount - 1.
This setting can be used to get or set the message attribute name. This setting is applicable in SQS when calling the CreateMessage and ListMessages methods. This setting is applicable in SNS when calling the PublishMessage method.
Valid array indices are from 0 to MessageAttributeCount - 1.
This setting gets or sets the value of the message attribute. This setting is applicable in SQS when calling the CreateMessage and ListMessages methods. This setting is applicable in SNS when calling the PublishMessage method.
Valid array indices are from 0 to MessageAttributeCount - 1.
This configuration setting allows you to send an SMS message directly to a phone number. This can be set to an E.164 formatted phone number. When setting this value call Publish with an empty string for the TopicArn parameter. For instance:
sns1.Config("PhoneNumber=+19191234567");
sns1.Publish("","","message");
The signature version used in the request. The default value is "4".
By default, this configuration is True, and when SendCustomRequest is called the component will sign the specified request to authenticate with the service. If set to False, the request will be sent as is, without signing.
This setting specifies the TargetArn when calling Publish. This may be set to a TopicArn or an EndpointArn. When setting this value call Publish with an empty string for the TopicArn parameter. For instance:
sns1.Config("TargetArn=myArn");
sns1.Publish("","subject","message");
By default, the component uses the service's URL. Setting this config will override this value.
HTTP Config Settings
When AllowHTTPCompression is True, the component adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The component only supports gzip and deflate decompression algorithms.
This configuration setting enables HTTP compression for receiving data. When set to True (default), the component will accept compressed data. It then will uncompress the data it has received. The component will handle data compressed by both gzip and deflate compression algorithms.
When True, the component 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.
This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".
If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component throws an exception if the server does not support HTTP/2.
The default value is True.
This configuration setting applies only when AuthScheme is set to Negotiate. If set to True, the component will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. Note: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False.
This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.
If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.
This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.
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]".
This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.
This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.
If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.
The default value is False.
If set to True, the URL passed to the component will be URL encoded. The default value is False.
This option determines what happens when the server issues a redirect. Normally, the component returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.
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 component throws an exception.
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 component throws an exception instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
The default value is False. If set to True, the component will perform a GET on the new location. Otherwise, it will use the same HTTP method again.
HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.
This property specifies the HTTP version used by the component. Possible values are as follows:
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0") or HTTP/3 ("3.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 component 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/2 is supported on all versions of Windows. If the Windows version is an earlier version than Windows 8.1/Windows Server 2012 R2, the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later, the system security libraries will be used by default.
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.
If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.
The default value for KeepAlive is false.
If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.
This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:
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).
This configuration setting should be set when the TransferredHeaders collection is to be populated when a Header event has been fired. This value represents the number of headers that are to be saved in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
This configuration setting should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
When FollowRedirects is set to any value other than frNever, the component will follow redirects until this maximum number of redirect attempts are made. The default value is 20.
This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the component will fall back to using "1.1" automatically. This setting will indicate which version was used.
This configuration setting can be set to a string of headers to be appended to the HTTP request headers.
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
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 component beyond what is provided.
This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.
This configuration setting is provided for use by components that do not directly expose Proxy properties.
This configuration setting is provided for use by components that do not directly expose Proxy properties.
This configuration setting is provided for use by components that do not directly expose Proxy properties.
This configuration setting is provided for use by components that do not directly expose Proxy properties.
This configuration setting is provided for use by components that do not directly expose Proxy properties.
This configuration setting returns the complete set of raw headers as sent by the client.
This configuration setting contains the result code of the last response from the server.
This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].
This configuration setting contains the contents of the last response from the server.
If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the component.
This configuration setting returns the complete set of raw headers as received from the server.
This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:
.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"));
If UseChunkedEncoding is set to True, the component will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the component will not use HTTP-chunked encoding. The default value is False.
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).
The default value is False and the hostname will always be used exactly as specified.
This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to True (default), the platform implementation is used. If set to False, an internal implementation is used.
When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).
This configuration specifies whether the component will attempt to use the Proxy auto-config URL when establishing a connection and AutoDetect is set to True.
When True (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".
Override the default with the name and version of your software.
TCPClient Config Settings
This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True.
When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the component will use Timeout for establishing a connection and transmitting/receiving data.
This configuration setting is provided for use by components that do not directly expose Firewall properties.
If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.
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 components that do not directly expose Firewall properties.
This entry is for TCPClient only and does not work for other components that descend from TCPClient.
If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.
RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.
The connection to the firewall is made by calling the Connect method.
If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
The FirewallPort is set automatically when FirewallType is set to a valid value.
Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.
Possible values are as follows:
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 components that do not directly expose Firewall properties.
If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the component throws an exception.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.
Note: This value is not applicable in macOS.
When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.
This property controls how a connection is closed. The default is True.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime 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 component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.
The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.
If the component 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 multihomed hosts (machines with more than one IP interface).
This configuration setting must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort 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 configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.
If an EOL string is found in the input stream before MaxLineLength 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.
This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.
This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:
www.google.com;www.nsoftware.com
If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.
Note: This value is not applicable in Java.
When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.
By default, this configuration setting is set to False.
When set to 0 (default), the component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. To instruct the component to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is False and NTLM V1 will be used. Set this to True to use NTLM V2.
SSL Config Settings
This configuration setting specifies the paths on disk to certificate authority (CA) certificate files when using Mono on Unix/Linux. It is not applicable in any other circumstances.
The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
If set to True, the component 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 component is the same.
When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This configuration setting specifies whether the component will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component throws an exception.
When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
This configuration setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The component will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the component throws an exception.
When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This configuration setting enables the cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the component 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 include the following:
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 the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
This configuration setting is used to enable or disable the supported security protocols.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that 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 supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the component 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 configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.
This configuration setting is applicable only when SSLProvider is set to Internal.
This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.
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.
Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.
This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.
When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
This configuration setting returns the cipher suite negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
This configuration setting returns the protocol version negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available in Java or when the provider is OpenSSL.
This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.
When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component throws an exception.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider 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)
This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
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
If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for User Datagram Protocol (UDP) ports.
When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).
This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component 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 (AmazonSNS Component)
SNS Errors
601 | An error was returned from the server. Please refer to the error message for additional information. |
602 | The cryptographic operation failed. Please see the error message for additional information. |
603 | Invalid Topic index. |
604 | Invalid Subscription index. |
605 | Invalid topic attribute type. |
606 | Invalid subscription attribute type. |
607 | Invalid subscription protocol value. |
The component may also return one of the following error codes, which are inherited from other components.
HTTP Errors
118 | Firewall error. The error description contains the 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 | Cannot open AttachedFile. |
The component may also return one of the following error codes, which are inherited from other components.
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 component 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. |
303 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
SSL Errors
270 | Cannot load specified security library. |
271 | Cannot open certificate store. |
272 | Cannot find specified certificate. |
273 | Cannot acquire security credentials. |
274 | Cannot find certificate chain. |
275 | Cannot verify certificate chain. |
276 | Error during handshake. |
280 | Error verifying certificate. |
281 | Could not find client certificate. |
282 | Could not find server certificate. |
283 | Error encrypting data. |
284 | Error decrypting data. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |