ICMP Component
Properties Methods Events Config Settings Errors
The ICMP component is used to facilitate ICMP communications. It can act both as a client and a server and can communicate with any number of hosts simultaneously. It also can generate and receive broadcast packets.
Syntax
TipwICMP
Remarks
The interface of the component is similar to the interface of TCPClient, only it is much simpler. The component is activated/deactivated by using the Active property. This property enables or disables the sending or receiving of data. Data can be sent in the same way as TCPClient, using the Send method and Text parameter or the DataToSend property. The destination is specified using the RemoteHost property. The component automatically creates an ICMP header containing MessageType, MessageSubType, and a checksum for the message.
If the UseConnection configuration setting is set to True, then a local association is created with the remote host. Otherwise, the component can receive datagrams (packets) from any host and can send datagrams to any host. Packets can be broadcast on the local net by setting the destination to 255.255.255.255.
Inbound data is received through the DataIn event.
The operation of the component is almost completely asynchronous. All the calls, except the ones that deal with domain name resolution, operate through Windows messages (no blocking calls). The gain in performance is considerable when compared with using blocking calls.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AcceptData | This property enables or disables data reception (the DataIn event). |
Active | This property indicates whether the component is active. |
DataToSend | This write-only property includes a string of data to be sent to the remote host. |
DontRoute | If this property is set to True, it forces the socket to send data directly to the interface (no routing). |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
MessageSubType | This property is the subtype of the ICMP message (part of the ICMP header). |
MessageType | This property includes the type of the ICMP message (part of the ICMP header). |
RemoteHost | This property includes the address of the RemoteHost. Domain names are resolved to IP addresses. |
Timeout | A timeout for the component. |
TimeToLive | This property includes the time-to-live (TTL) value for the ICMP packets sent by the component. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Activate | This method enables sending and receiving of data. |
Config | Sets or retrieves a configuration setting. |
Deactivate | This method disables sending and receiving of data. |
DoEvents | Processes events from the internal message queue. |
PauseData | This method pauses data reception. |
ProcessData | This method reenables data reception after a call to PauseData . |
Reset | Reset the component. |
ResolveRemoteHost | Resolves the hostname in RemoteHost to an IP address. |
Send | This method sends data to the remote host. |
SendBytes | This method sends data to the remote host. |
SendText | This method sends data to the remote host. |
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.
DataIn | This event is fired when a new ICMP messages come in. |
Error | Information about errors during data delivery. |
ReadyToSend | Fired when the component is ready to send data. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
DontFragment | Whether the DontFragment control flag is set. |
IcmpDllTimeout | The timeout for the component when using the icmp.dll. |
MaxMessageSize | The maximum length of the messages that can be received. |
MulticastTTL | The time to live (TTL) value for multicast ICMP packets sent by the component. |
ReceiveAllMode | Enables a socket to receive all IPv4 or IPv6 packets on the network. |
TimeoutInMilliseconds | The timeout is treated as milliseconds. |
UseConnection | Determines whether to use a connected socket. |
UseICMPDLL | Use the icmp.dll included on Windows Systems. |
UseIPHLPDLL | Use the iphlpapi.dll included on Windows Systems. |
UseIPv6 | Whether to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |
AcceptData Property (ICMP Component)
This property enables or disables data reception (the DataIn event).
Syntax
__property bool AcceptData = { read=FAcceptData, write=FSetAcceptData };
Default Value
True
Remarks
This property enables or disables data reception (the DataIn event). Setting this property to False, temporarily disables data reception (and the DataIn event). Setting this property to True, reenables data reception.
Note: It is recommended to use the PauseData or ProcessData method instead of setting this property.
This property is not available at design time.
Data Type
Boolean
Active Property (ICMP Component)
This property indicates whether the component is active.
Syntax
__property bool Active = { read=FActive, write=FSetActive };
Default Value
False
Remarks
This property indicates whether the component is currently active and can send or receive data.
If the UseConnection configuration setting is set to True, then a local association (connection) to the remote host also is created.
Note: Use the Activate or Deactivate method to control whether the component is active.
This property is not available at design time.
Data Type
Boolean
DataToSend Property (ICMP Component)
This write-only property includes a string of data to be sent to the remote host.
Syntax
__property String DataToSend = { write=FSetDataToSend }; __property DynamicArray<Byte> DataToSendB = { write=FSetDataToSendB };
Default Value
""
Remarks
This property is write-only and contains a string of data to be sent to the remote host. Assigning a string to this property makes the component send the string to the remote host. The Send method provides similar functionality.
The Transmission Control Protocol (TCP)/IP subsystem attempts to send the string assigned to this property as a complete message. If socket buffers are full, or if the message cannot be delivered for any other reason, an error is fired, and no portion of the message is sent. This is different from TCP in which case portions of the messages can be sent. ICMP sends either a complete message or nothing at all.
If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, DataToSend raises the exception with errorcode 10035 and message "[10035] Operation would block" (WSAEWOULDBLOCK). You can handle this exception, and then try to send the data again. .
This property is write-only and not available at design time.
Data Type
Byte Array
DontRoute Property (ICMP Component)
If this property is set to True, it forces the socket to send data directly to the interface (no routing).
Syntax
__property bool DontRoute = { read=FDontRoute, write=FSetDontRoute };
Default Value
False
Remarks
If this property is set to True, it forces the socket to send data directly to the interface (no routing). Normally, IP sockets send packets of data through routers and gateways until they reach the final destination. If this property is set to True, then data will be delivered on the local subnet only.
This property is not available at design time.
Data Type
Boolean
LocalHost Property (ICMP Component)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.
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 multi-homed hosts (machines with more than one IP interface).
NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
MessageSubType Property (ICMP Component)
This property is the subtype of the ICMP message (part of the ICMP header).
Syntax
__property int MessageSubType = { read=FMessageSubType, write=FSetMessageSubType };
Default Value
0
Remarks
This property contains the subtype of the ICMP message (part of the ICMP header). The ICMP message subtype (also referred to as "code") is a byte value representing the message subclass. Its meaning is associated with the MessageType.
Types and subtypes of ICMP messages are defined in the various internet RFCs and other documentation associated with Transmission Control Protocol (TCP)/IP.
Data Type
Integer
MessageType Property (ICMP Component)
This property includes the type of the ICMP message (part of the ICMP header).
Syntax
__property int MessageType = { read=FMessageType, write=FSetMessageType };
Default Value
0
Remarks
This property contains the type of the ICMP message (part of the ICMP header). The ICMP message type is a byte value representing the message class. The message type defines the structure and meaning of the message data assigned to DataToSend.
Types for ICMP messages are defined in the various internet RFCs and other documentation associated with Transmission Control Protocol (TCP/IP). The following are a few examples of ICMP message types:
0 | Echo reply ("ping" reply). |
3 | Destination unreachable. |
4 | Source quench. |
5 | Redirect (change a route). |
8 | Echo request ("ping" request). |
11 | Time exceeded for datagram. |
12 | Parameter problem on datagram. |
13 | Timestamp request. |
14 | Timestamp reply. |
17 | Address mask request. |
18 | Address mask reply. |
Data Type
Integer
RemoteHost Property (ICMP Component)
This property includes the address of the RemoteHost. Domain names are resolved to IP addresses.
Syntax
__property String RemoteHost = { read=FRemoteHost, write=FSetRemoteHost };
Default Value
""
Remarks
This property specifies the IP address (IP number in dotted internet format) or the domain name of the remote host.
If this property is set to 255.255.255.255, the component broadcasts data on the local subnet.
If this property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, the component raises an exception.
If UseConnection is True, this property must be set before the component is activated (Active is set to True).
Data Type
String
Timeout Property (ICMP Component)
A timeout for the component.
Syntax
__property int Timeout = { read=FTimeout, write=FSetTimeout };
Default Value
0
Remarks
If the Timeout property is set to 0, all operations return immediately, potentially failing with an 'WOULDBLOCK' error if data can't be sent or received immediately.
If Timeout is set to a positive value, the component will automatically retry each operation that would otherwise result in a 'WOULDBLOCK' error for a maximum of Timeout seconds.
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 raises an exception.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 0 (asynchronous operation).
Data Type
Integer
TimeToLive Property (ICMP Component)
This property includes the time-to-live (TTL) value for the ICMP packets sent by the component.
Syntax
__property int TimeToLive = { read=FTimeToLive, write=FSetTimeToLive };
Default Value
0
Remarks
This method contains the time-to-live (TTL) value for the ICMP packets sent by the component. The TTL field of the ICMP packet is a counter limiting the lifetime of a packet.
Each router (or other module) that handles a packet decrements the TTL field by one or more if it holds the packet for more than one second. Thus, the TTL value is effectively a hop count limit on how far a datagram can propagate through the internet. When the TTL value is reduced to zero (or less), the packet is discarded.
If the value of the property is set to zero, then the default TTL value of the underlying Transmission Control Protocol (TCP)/IP subsystem will be used.
This property is not available at design time.
Data Type
Integer
Activate Method (ICMP Component)
This method enables sending and receiving of data.
Syntax
void __fastcall Activate();
Remarks
This method enables sending and receiving of data. When called, the component will create a communication endpoint (socket) that can be used for sending and receiving ICMP messages. This method must be called before using the component to send and receive data.
If the UseConnection configuration setting is set to true, then a local association (connection) to the remote host also is created.
Config Method (ICMP Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
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.
Deactivate Method (ICMP Component)
This method disables sending and receiving of data.
Syntax
void __fastcall Deactivate();
Remarks
This method disables sending and receiving of data. When called, the component will destroy the existing socket and disable data communications.
DoEvents Method (ICMP Component)
Processes events from the internal message queue.
Syntax
void __fastcall DoEvents();
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.
PauseData Method (ICMP Component)
This method pauses data reception.
Syntax
void __fastcall PauseData();
Remarks
This method pauses data reception when called. While data reception is paused, the DataIn event will not fire. Call ProcessData to reenable data reception.
ProcessData Method (ICMP Component)
This method reenables data reception after a call to PauseData .
Syntax
void __fastcall ProcessData();
Remarks
This method reenables data reception after a previous call to PauseData. When PauseData is called, the DataIn event will not fire. To reenable data reception and allow DataIn to fire, call this method.
Note: This method is used only after previously calling PauseData. It does not need to be called to process incoming data by default.
Reset Method (ICMP Component)
Reset the component.
Syntax
void __fastcall Reset();
Remarks
This method will reset the component's properties to their default values.
ResolveRemoteHost Method (ICMP Component)
Resolves the hostname in RemoteHost to an IP address.
Syntax
void __fastcall ResolveRemoteHost();
Remarks
This method resolves the hostname specified by RemoteHost to an IP address. The resolved value is available in the RemoteHost property after this method returns.
In most cases calling this method is not necessary, the component will resolve the hostname automatically when necessary. If DelayHostResolution is true this method may be called to manually resolve RemoteHost if desired.
Send Method (ICMP Component)
This method sends data to the remote host.
Syntax
void __fastcall Send(DynamicArray<Byte> Text);
Remarks
This method sends data to the remote host. Calling this method is equivalent to setting the DataToSend property to Text.
SendBytes Method (ICMP Component)
This method sends data to the remote host.
Syntax
void __fastcall SendBytes(DynamicArray<Byte> Data);
Remarks
This method sends data to the remote host. Calling this method is equivalent to calling the SendBytes/SendText method.
SendText Method (ICMP Component)
This method sends data to the remote host.
Syntax
void __fastcall SendText(String Text);
Remarks
This method sends data to the remote host. Calling this method is equivalent to calling the SendBytes/SendText method.
DataIn Event (ICMP Component)
This event is fired when a new ICMP messages come in.
Syntax
typedef struct { int MessageType; int MessageSubType; String MessageData; DynamicArray<Byte> MessageDataB; int Checksum; String SourceAddress; } TipwICMPDataInEventParams; typedef void __fastcall (__closure *TipwICMPDataInEvent)(System::TObject* Sender, TipwICMPDataInEventParams *e); __property TipwICMPDataInEvent OnDataIn = { read=FOnDataIn, write=FOnDataIn };
Remarks
The MessageType parameter shows the type of the ICMP messages and the MessageSubType parameter shows its subtype.
The MessageData parameter contains the message data.
The Checksum parameter is True or False depending on the ICMP checksum validation on the message.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Error Event (ICMP Component)
Information about errors during data delivery.
Syntax
typedef struct { int ErrorCode; String Description; } TipwICMPErrorEventParams; typedef void __fastcall (__closure *TipwICMPErrorEvent)(System::TObject* Sender, TipwICMPErrorEventParams *e); __property TipwICMPErrorEvent OnError = { read=FOnError, write=FOnError };
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
ReadyToSend Event (ICMP Component)
Fired when the component is ready to send data.
Syntax
typedef struct { } TipwICMPReadyToSendEventParams; typedef void __fastcall (__closure *TipwICMPReadyToSendEvent)(System::TObject* Sender, TipwICMPReadyToSendEventParams *e); __property TipwICMPReadyToSendEvent OnReadyToSend = { read=FOnReadyToSend, write=FOnReadyToSend };
Remarks
The ReadyToSend event indicates that the underlying TCP/IP subsystem is ready to accept data after a failed DataToSend.
Config Settings (ICMP 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.ICMP Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DelayHostResolution:
Whether the hostname is resolved when RemoteHost is set.This setting specifies whether a hostname is resolved immediately when RemoteHost is set. If true the component will resolve the hostname and the IP address will be present in the RemoteHost property.
If false, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may called to manually resolve the value in RemoteHost at any time.
The default value is false. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DontFragment:
Whether the DontFragment control flag is set.When set to True, the DontFragment control flag in the IP header will be set.
The default value is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IcmpDllTimeout:
The timeout for the component when using the icmp.dll.The component will wait for the operation to complete before returning control.
If IcmpDllTimeout expires, and the operation is not yet complete, the component raises an exception. IcmpDllTimeout must be set to a positive value.
The default value for IcmpDllTimeout is 60 seconds. Note: This configuration setting is valid only when UseICMPDLL is set to True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxMessageSize: The maximum length of the messages that can be received.This setting specifies the maximum size of the datagrams that the component will accept without truncation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MulticastTTL:
The time to live (TTL) value for multicast ICMP packets sent by the component.When sending multicast packets, the setting specifies the time-to-live (TTL) field. The TTL field of the ICMP packet is a counter limiting the lifetime of a packet.
Each router (or other module) that handles a packet decrements the TTL field by one or more if it holds the packet for more than one second. Thus, the TTL is effectively a hop count limit on how far a datagram can propagate through the internet. When the TTL is reduced to zero (or less), the packet is discarded. By default, the default TTL value of the underlying Transmission Control Protocol (TCP)/IP subsystem will be used. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReceiveAllMode:
Enables a socket to receive all IPv4 or IPv6 packets on the network.This setting specifies the ReceiveAll mode for the socket. The following modes are available:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TimeoutInMilliseconds:
The timeout is treated as milliseconds.Setting TimeoutInMilliseconds to True causes the component
to use the value in the IcmpDllTimeout configuration setting
as milliseconds instead of seconds, which is the default.
Note: This setting is valid only when UseICMPDLL is set to True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseConnection:
Determines whether to use a connected socket.UseConnection specifies whether the component
should use a connected socket or not. The connection is
defined as an association in between the local address/port
and the remote address/port. As such, this
is not a connection in the traditional TCP sense. What it
means is only that the component will send and receive data
only to and from the specified destination.
The default value for this setting is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseICMPDLL: Use the icmp.dll included on Windows Systems.Setting UseICMPDLL to True causes the component to use the icmp.dll on Windows 9x or on later machines. This sometimes enables access to raw sockets when permissions for standard operations are prohibited. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPHLPDLL:
Use the iphlpapi.dll included on Windows Systems.Setting UseIPHLPDLL to True causes the component
to use the iphlpapi.dll on Windows XP or on later machines. This
sometimes enables access to raw sockets when permissions for
standard operations are prohibited.
Note: If both this and UseICMPDLL are enabled, the iphlpapi.dll will take precedence. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPv6:
Whether to use IPv6.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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Socket Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AbsoluteTimeout:
Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which 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 UDP ports. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallData: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InBufferSize:
The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OutBufferSize:
The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is false.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI:
Tells the component whether or not to use the system security libraries or an internal implementation.
When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to true tells the component to use the internal implementation instead of using the system security libraries. This setting is set to false by default on all platforms. |
Trappable Errors (ICMP Component)
ICMP Errors
104 The component is already Active. | |
107 Cannot change the LocalHost at this time. A connection is in progress. | |
109 The component must be Active for this operation. | |
112 Cannot change MaxMessageSize while ICMP is Active. | |
114 Cannot change RemoteHost when UseConnection is set and the component is Active. | |
117 Cannot change UseConnection while the component is Active. | |
118 The message cannot be longer than MaxMessageSize. | |
119 The message is too short. | |
120 Cannot create ICMP handle. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |