Aspera Developer Documentation

CommandClientImpl Class Reference

List of all members.


Detailed Description

The class that can issue commands and return the results.

Public Member Functions

 CommandClientImpl ()
 ~CommandClientImpl ()
CmdReplyInfo * connect (char *host, char *user, char *passphrase, char *privkeyfile, int port, CmdError &cmderr)
 Connects to the specified remote computer using a Putty generated private key file for authentications and returns the remote system information.
CmdReplyInfo * connect (char *host, char *user, char *passwd, int port, CmdError &cmderr)
 Connects to the specified remote computer using a username and password for authentication and returns the remote system information.
void disconnect ()
 Disconnects from the remote computer.
CmdReplyFile * execLs (char cmdargs[], CmdError &cmderr)
 Executes an ls command. Requires the path of the file/directory as a parameter. Forward slash can be used to separate the driectories, on windows as well. If the path includes spaces, the path needs to be enclosed in double quotation marks.
int execRm (char cmdargs[], CmdError &cmderr)
 Remove the file or directory specified in the first argument.
CmdReplyMd5sum * execMd5sum (char cmdargs[], CmdError &cmderr)
 Returns the MD5 sum of the specified file.
int execCp (char src[], char dest[], CmdError &cmderr)
 Copies a file. Requires two arguments, source and destination.
CmdReplyMounts * execDf (CmdError &cmderr)
 Retrieves the file system disk usage information.
CmdReplySize * execDu (char cmdargs[], CmdError &cmderr)
 Retrieves the disk usage information of a file/directory.
CmdReplyInfo * execInfo (CmdError &cmderr)
 Retrives the system information of the remote information. This information is same as that returned by the connect method.
int execMkdir (char cmdargs[], CmdError &cmderr)
 Creates a directory with the specified name.
int execMv (char src[], char dest[], CmdError &cmderr)
 Moves a file. Requires two arguments, source and destination.
char * getUser ()
 Returns the active user name.
void setError (int _errnum, char *_errstr)
 Internal use only.
void getError (CmdError *cmderr)
 Internal use only.

Friends

void * runloop (void *ptr)

Constructor & Destructor Documentation


Member Function Documentation

CmdReplyInfo * connect ( char *  host,
char *  user,
char *  passphrase,
char *  privkeyfile,
int  port,
CmdError &  cmderr 
)

Connects to the specified remote computer using a Putty generated private key file for authentications and returns the remote system information.

CmdReplyInfo * connect ( char *  host,
char *  user,
char *  passwd,
int  port,
CmdError &  cmderr 
)

Connects to the specified remote computer using a username and password for authentication and returns the remote system information.

void disconnect (  ) 

Disconnects from the remote computer.

CmdReplyFile * execLs ( char  cmdargs[],
CmdError &  cmderr 
)

Executes an ls command. Requires the path of the file/directory as a parameter. Forward slash can be used to separate the driectories, on windows as well. If the path includes spaces, the path needs to be enclosed in double quotation marks.

int execRm ( char  cmdargs[],
CmdError &  cmderr 
)

Remove the file or directory specified in the first argument.

CmdReplyMd5sum * execMd5sum ( char  cmdargs[],
CmdError &  cmderr 
)

Returns the MD5 sum of the specified file.

int execCp ( char  src[],
char  dest[],
CmdError &  cmderr 
)

Copies a file. Requires two arguments, source and destination.

CmdReplyMounts * execDf ( CmdError &  cmderr  ) 

Retrieves the file system disk usage information.

CmdReplySize * execDu ( char  cmdargs[],
CmdError &  cmderr 
)

Retrieves the disk usage information of a file/directory.

CmdReplyInfo * execInfo ( CmdError &  cmderr  ) 

Retrives the system information of the remote information. This information is same as that returned by the connect method.

int execMkdir ( char  cmdargs[],
CmdError &  cmderr 
)

Creates a directory with the specified name.

int execMv ( char  src[],
char  dest[],
CmdError &  cmderr 
)

Moves a file. Requires two arguments, source and destination.

char * getUser (  ) 

Returns the active user name.

void setError ( int  _errnum,
char *  _errstr 
)

Internal use only.

void getError ( CmdError *  cmderr  ) 

Internal use only.


Friends And Related Function Documentation

void* runloop ( void *  ptr  )  [friend]


Copyright © 2005 Aspera, Inc. | asperasoft.com