ppapi/api/pp_errors.idl

   1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2  * Use of this source code is governed by a BSD-style license that can be
   3  * found in the LICENSE file.
   4  */
   5
   6 /**
   7  * This file defines an enumeration of all PPAPI error codes.
   8  */
   9
  10 /**
  11  * This enumeration contains enumerators of all PPAPI error codes.
  12  *
  13  * Errors are negative valued. Callers should treat all negative values as a
  14  * failure, even if it's not in the list, since the possible errors are likely
  15  * to expand and change over time.
  16  */
  17 [unnamed] enum PP_Error {
  18   /**
  19    * This value is returned by a function on successful synchronous completion
  20    * or is passed as a result to a PP_CompletionCallback_Func on successful
  21    * asynchronous completion.
  22    */
  23   PP_OK                   = 0,
  24   /**
  25    * This value is returned by a function that accepts a PP_CompletionCallback
  26    * and cannot complete synchronously. This code indicates that the given
  27    * callback will be asynchronously notified of the final result once it is
  28    * available.
  29    */
  30   PP_OK_COMPLETIONPENDING = -1,
  31
  32   /**This value indicates failure for unspecified reasons. */
  33   PP_ERROR_FAILED         = -2,
  34
  35   /**
  36    * This value indicates failure due to an asynchronous operation being
  37    * interrupted. The most common cause of this error code is destroying a
  38    * resource that still has a callback pending. All callbacks are guaranteed
  39    * to execute, so any callbacks pending on a destroyed resource will be
  40    * issued with PP_ERROR_ABORTED.
  41    *
  42    * If you get an aborted notification that you aren't expecting, check to
  43    * make sure that the resource you're using is still in scope. A common
  44    * mistake is to create a resource on the stack, which will destroy the
  45    * resource as soon as the function returns.
  46    */
  47   PP_ERROR_ABORTED        = -3,
  48
  49   /** This value indicates failure due to an invalid argument. */
  50   PP_ERROR_BADARGUMENT    = -4,
  51
  52   /** This value indicates failure due to an invalid PP_Resource. */
  53   PP_ERROR_BADRESOURCE    = -5,
  54
  55   /** This value indicates failure due to an unavailable PPAPI interface. */
  56   PP_ERROR_NOINTERFACE    = -6,
  57
  58   /** This value indicates failure due to insufficient privileges. */
  59   PP_ERROR_NOACCESS       = -7,
  60
  61   /** This value indicates failure due to insufficient memory. */
  62   PP_ERROR_NOMEMORY       = -8,
  63
  64   /** This value indicates failure due to insufficient storage space. */
  65   PP_ERROR_NOSPACE        = -9,
  66
  67   /** This value indicates failure due to insufficient storage quota. */
  68   PP_ERROR_NOQUOTA        = -10,
  69
  70   /**
  71    * This value indicates failure due to an action already being in
  72    * progress.
  73    */
  74   PP_ERROR_INPROGRESS     = -11,
  75   /** This value indicates failure due to a file that does not exist. */
  76
  77   /**
  78    * The requested command is not supported by the browser.
  79    */
  80   PP_ERROR_NOTSUPPORTED = -12,
  81
  82   /**
  83    * Returned if you try to use a null completion callback to "block until
  84    * complete" on the main thread. Blocking the main thread is not permitted
  85    * to keep the browser responsive (otherwise, you may not be able to handle
  86    * input events, and there are reentrancy and deadlock issues).
  87    *
  88    * The goal is to provide blocking calls from background threads, but PPAPI
  89    * calls on background threads are not currently supported. Until this
  90    * support is complete, you must either do asynchronous operations on the
  91    * main thread, or provide an adaptor for a blocking background thread to
  92    * execute the operations on the main thread.
  93    */
  94   PP_ERROR_BLOCKS_MAIN_THREAD = -13,
  95
  96   PP_ERROR_FILENOTFOUND   = -20,
  97   /** This value indicates failure due to a file that already exists. */
  98   PP_ERROR_FILEEXISTS     = -21,
  99   /** This value indicates failure due to a file that is too big. */
 100   PP_ERROR_FILETOOBIG     = -22,
 101   /**
 102    * This value indicates failure due to a file having been modified
 103    * unexpectedly.
 104    */
 105   PP_ERROR_FILECHANGED    = -23,
 106   /** This value indicates that the pathname does not reference a file. */
 107   PP_ERROR_NOTAFILE       = -24,
 108   /** This value indicates failure due to a time limit being exceeded. */
 109   PP_ERROR_TIMEDOUT       = -30,
 110   /**
 111    * This value indicates that the user cancelled rather than providing
 112    * expected input.
 113    */
 114   PP_ERROR_USERCANCEL     = -40,
 115   /**
 116    * This value indicates failure due to lack of a user gesture such as a
 117    * mouse click or key input event. Examples of actions requiring a user
 118    * gesture are showing the file chooser dialog and going into fullscreen
 119    * mode.
 120    */
 121   PP_ERROR_NO_USER_GESTURE = -41,
 122   /**
 123    * This value indicates that the graphics context was lost due to a
 124    * power management event.
 125    */
 126   PP_ERROR_CONTEXT_LOST   = -50,
 127   /**
 128    * Indicates an attempt to make a PPAPI call on a thread without previously
 129    * registering a message loop via PPB_MessageLoop.AttachToCurrentThread.
 130    * Without this registration step, no PPAPI calls are supported.
 131    */
 132   PP_ERROR_NO_MESSAGE_LOOP = -51,
 133   /**
 134    * Indicates that the requested operation is not permitted on the current
 135    * thread.
 136    */
 137   PP_ERROR_WRONG_THREAD   = -52
 138 };
 139