toolkit/components/remote/nsRemoteClient.h

   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 TOOLKIT_COMPONENTS_REMOTE_NSREMOTECLIENT_H_
   9 #define TOOLKIT_COMPONENTS_REMOTE_NSREMOTECLIENT_H_
  10
  11 #include "nscore.h"
  12
  13 /**
  14  * Pure-virtual common base class for remoting implementations.
  15  */
  16
  17 class nsRemoteClient {
  18  public:
  19   virtual ~nsRemoteClient() = default;
  20
  21   /**
  22    * Initializes the client
  23    */
  24   virtual nsresult Init() = 0;
  25
  26   /**
  27    * Send a complete command line to a running instance.
  28    *
  29    * @param aProgram This is the preferred program that we want to use
  30    * for this particular command.
  31    *
  32    * @param aProfile This allows you to specify a particular server
  33    * running under a named profile.  If it is not specified the
  34    * profile is not checked.
  35    *
  36    * @param argc The number of command-line arguments.
  37    *
  38    * @param argv The command-line arguments.
  39    *
  40    * @param aRaise Whether the target instance's window should be brought to the
  41    * foreground. The actual effect of this is platform-dependent; see comments
  42    * in platform-specific implementations for further information.
  43    */
  44   virtual nsresult SendCommandLine(const char* aProgram, const char* aProfile,
  45                                    int32_t argc, const char** argv,
  46                                    bool aRaise) = 0;
  47 };
  48
  49 #endif  // TOOLKIT_COMPONENTS_REMOTE_NSREMOTECLIENT_H_