Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsRemoteClient Class Reference

Pure-virtual common base class for remoting implementations. More...

#include <nsRemoteClient.h>

Inheritance diagram for nsRemoteClient:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual nsresult Init ()=0
 Initializes the client.
virtual nsresult SendCommand (const char *aProgram, const char *aUsername, const char *aProfile, const char *aCommand, char **aResponse, PRBool *aSucceeded)=0
 Sends a command to a running instance.
virtual nsresult SendCommandLine (const char *aProgram, const char *aUsername, const char *aProfile, PRInt32 argc, char **argv, char **aResponse, PRBool *aSucceeded)=0
 Send a complete command line to a running instance.

Detailed Description

Pure-virtual common base class for remoting implementations.

Definition at line 49 of file nsRemoteClient.h.


Member Function Documentation

virtual nsresult nsRemoteClient::Init ( ) [pure virtual]

Initializes the client.

Implemented in XRemoteClient, and XRemoteClient.

virtual nsresult nsRemoteClient::SendCommand ( const char *  aProgram,
const char *  aUsername,
const char *  aProfile,
const char *  aCommand,
char **  aResponse,
PRBool aSucceeded 
) [pure virtual]

Sends a command to a running instance.

Parameters:
aProgramThis is the preferred program that we want to use for this particular command.
aNoProgramFallbackThis boolean attribute tells the client code that if the preferred program isn't found that it should fail not send the command to another server.
aUsernameThis allows someone to only talk to an instance of the server that's running under a particular username. If this isn't specified here it's pulled from the LOGNAME environmental variable if it's set.
aProfileThis allows you to specify a particular server running under a named profile. If it is not specified the profile is not checked.
aCommandThis is the command that is passed to the server. Please see the additional information located at: http://www.mozilla.org/unix/remote.html
aResponseIf there is a response, it will be here. This includes error messages. The string is allocated using stdlib string functions, so free it with free().

true if succeeded, false if no running instance was found.

Implemented in XRemoteClient, and XRemoteClient.

virtual nsresult nsRemoteClient::SendCommandLine ( const char *  aProgram,
const char *  aUsername,
const char *  aProfile,
PRInt32  argc,
char **  argv,
char **  aResponse,
PRBool aSucceeded 
) [pure virtual]

Send a complete command line to a running instance.

See also:
sendCommand
Parameters:
argcThe number of command-line arguments.

Implemented in XRemoteClient, and XRemoteClient.


The documentation for this class was generated from the following file: