Line data    Source code

       1             : /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
       2             : /* vim:expandtab:shiftwidth=4:tabstop=4:
       3             :  */
       4             : /* This Source Code Form is subject to the terms of the Mozilla Public
       5             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       6             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
       7             : 
       8             : #ifndef nsRemoteClient_h__
       9             : #define nsRemoteClient_h__
      10             : 
      11             : #include "nscore.h"
      12             : 
      13             : /**
      14             :  * Pure-virtual common base class for remoting implementations.
      15             :  */
      16             : 
      17           0 : class nsRemoteClient
      18             : {
      19             : public:
      20             :   /**
      21             :    * Initializes the client
      22             :    */
      23             :   virtual nsresult Init() = 0;
      24             : 
      25             :   /**
      26             :    * Send a complete command line to a running instance.
      27             :    *
      28             :    * @param aProgram This is the preferred program that we want to use
      29             :    * for this particular command.
      30             :    *
      31             :    * @param aUsername This allows someone to only talk to an instance
      32             :    * of the server that's running under a particular username.  If
      33             :    * this isn't specified here it's pulled from the LOGNAME
      34             :    * environmental variable if it's set.
      35             :    *
      36             :    * @param aProfile This allows you to specify a particular server
      37             :    * running under a named profile.  If it is not specified the
      38             :    * profile is not checked.
      39             :    *
      40             :    * @param argc The number of command-line arguments.
      41             :    *
      42             :    * @param argv The command-line arguments.
      43             :    *
      44             :    * @param aDesktopStartupID the contents of the DESKTOP_STARTUP_ID environment
      45             :    * variable defined by the Startup Notification specification
      46             :    * http://standards.freedesktop.org/startup-notification-spec/startup-notification-0.1.txt
      47             :    *
      48             :    * @param aResponse If there is a response, it will be here.  This
      49             :    * includes error messages.  The string is allocated using stdlib
      50             :    * string functions, so free it with free().
      51             :    *
      52             :    * @return true if succeeded, false if no running instance was found.
      53             :    * 
      54             :    */
      55             :   virtual nsresult SendCommandLine(const char *aProgram, const char *aUsername,
      56             :                                    const char *aProfile,
      57             :                                    int32_t argc, char **argv,
      58             :                                    const char* aDesktopStartupID,
      59             :                                    char **aResponse, bool *aSucceeded) = 0;
      60             : };
      61             : 
      62             : #endif // nsRemoteClient_h__