IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

RCP Bean

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

IPWorks.Rcp

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 bean with short descriptions. Click on the links for further details.

FileModeThe file mode for the RemoteFile .
FirewallA set of properties related to firewall access.
IdleThe current status of the component.
LocalFileThe file on the local host.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
PasswordThe password associated with User .
ProtocolSets the protocol to use for the transfer.
RemoteFileThe file on the remote host.
RemoteHostThe remote host to which to connect.
RemotePortThe port for the service (REXEC or RSHELL).
TimeoutA timeout for the component.
UserThe identification of the remote user for a transfer.

Method List


The following is the full list of the methods of the bean with short descriptions. Click on the links for further details.

configSets or retrieves a configuration setting .
doEventsProcesses events from the internal message queue.
getFileGets the specified file.
interruptInterrupt the current method.
putFilePuts a file to a specified location.

Event List


The following is the full list of the events fired by the bean with short descriptions. Click on the links for further details.

ConnectedFired immediately after a connection completes (or fails).
ConnectionStatusFired to indicate changes in connection state.
DisconnectedFired when a connection is closed.
ErrorInformation about errors during data delivery.
ProgressFired whenever data is being transferred between the localhost and RemoteHost .

Configuration Settings


The following is a list of configuration settings for the bean with short descriptions. Click on the links for further details.

EnableStderrEnables or disables secondary (stderr) stream.
StderrPortThe local port from which the remote system sends the stderr stream.
MaxStdoutMaximum storage available for the stdout buffer.
MaxStderrMaximum storage available for the stderr buffer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0