RCP Class

Properties Methods Events Configuration Settings Errors

The RCP component implements the popular UNIX Remote Copy Protocol, used to transfer files between systems.

Class Name

IPWorks_RCP

Procedural Interface

 ipworks_rcp_open();
 ipworks_rcp_close($res);
 ipworks_rcp_register_callback($res, $id, $function);
 ipworks_rcp_get_last_error($res);
 ipworks_rcp_get_last_error_code($res);
 ipworks_rcp_set($res, $id, $index, $value);
 ipworks_rcp_get($res, $id, $index);
 ipworks_rcp_do_config($res, $configurationstring);
 ipworks_rcp_do_doevents($res);
 ipworks_rcp_do_getfile($res);
 ipworks_rcp_do_interrupt($res);
 ipworks_rcp_do_putfile($res);

Remarks

Using the class 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 class 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 class 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 class 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 class 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 class 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.
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).
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.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
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 TCP 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.
RecordLength	The length of received data records.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
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.