RCP Component [IP*Works! V8]
Properties
Methods
Events
Configuration Settings
The RCP component implements the popular UNIX Remote Copy Protocol,
used to transfer files between systems.
NOTE: What follows is a very short description of the component interfaces.
For more information, please consult the help files that come with the respective package.
Remarks
Using the component is as simple as specifying a LocalFile,
a RemoteFile and RemoteHost, and calling the GetFile
or the PutFile method.
The Remote Copy Protocol is implemented over either RSHELL or
REXEC. The component allows you to choose which protocol to use
via the Protocol property.
Property List
The following is the full list of the properties of the component with short
descriptions. Click on the links for further details.
| |
| FileMode | The file mode for the RemoteFile. |
| FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| Idle | The current status of the component. |
| LocalFile | The file on the local host. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| Password | The password associated with User. |
| Protocol | Sets the protocol to use for the transfer. |
| RemoteFile | The file on the remote host. |
| RemoteHost | The remote host to which to connect. |
| RemotePort | The port for the service (REXEC or RSHELL). |
| Timeout | A timeout for the component. |
| User | The identification of the remote user for a transfer. |
Method List
The following is the full list of the methods of the component with short
descriptions. Click on the links for further details.
| |
| Config | Sets or retrieves a configuration setting. |
| DoEvents | Processes events from the internal message queue. |
| GetFile | Gets the specified file. |
| Interrupt | Interrupt the current method. |
| PutFile | Puts a file to a specified location. |
Event List
The following is the full list of the events fired by the component with short
descriptions. Click on the links for further details.
| |
| Connected | Fired immediately after a connection completes (or fails). |
| ConnectionStatus | Fired to indicate changes in connection state. |
| Disconnected | Fired when a connection is closed. |
| Error | Information about errors during data delivery. |
| Progress | Fired whenever data is being transferred between the localhost and RemoteHost. |
Configuration Settings
The following is a list of configuration settings for the component with short
descriptions. Click on the links for further details.
| |
| EnableStderr | Enables or disables secondary (stderr) stream. |
| StderrPort | The local port from which the remote system sends the stderr stream. |
| MaxStdout | Maximum storage available for the stdout buffer. |
| MaxStderr | Maximum storage available for the stderr buffer. |
| UseIPv6 | Whether or not to use IPv6. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| 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 (IPPort only). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| FirewallType | Determines the type of firewall to connect through. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| 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. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
