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

FileMode The file mode for the RemoteFile.
Firewall A set of properties related to firewall access.
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 connect to.
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 complete descriptions.

Config Sets or retrieves a component configuration setting.
DoEvents Processes events from the internal message queue.
GetFile Get File.
Interrupt Interrupt the current method.
PutFile Put File

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

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 .

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
CloseStreamAfterTransfer If true, the component will close the upload or download stream after the transfer.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
EnableStderr Enables or disables secondary (stderr) stream.
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
InBufferSize The size in bytes of the incoming queue of the socket.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
OutBufferSize The size in bytes of the outgoing queue of the socket.
SocketHandle The handle of the main socket used by the component.
StderrPort The local port from which the remote system sends the stderr stream.
TcpNoDelay Whether or not to delay when sending packets
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)

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