Search: 
Available in: IP*WORKS!
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.

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

ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
GetFileGet File.
InterruptInterrupt the current method.
PutFilePut File

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.

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 component 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
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available
FirewallHostName or IP address of firewall (optional)
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only)
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall
FirewallPortThe TCP port for the FirewallHost;
FirewallUserA user name if authentication is to be used connecting through a firewall
FirewallTypeDetermines the type of firewall to connect through
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 (Windows/COM only)

| About | Privacy Policy | Terms of Use |
© Copyright 2010 /n software inc.