ppb_sef_client_samsung.h

Go to the documentation of this file.

/**
 * This file defines the <code>PPB_SefClient_Samsung</code> interface.
 */

/* From samsung/ppb_sef_client_samsung.idl modified Mon Nov  4 08:40:28 2013. */

#ifndef PPAPI_C_SAMSUNG_PPB_SEF_CLIENT_SAMSUNG_H_
#define PPAPI_C_SAMSUNG_PPB_SEF_CLIENT_SAMSUNG_H_

#include "ppapi/c/pp_bool.h"
#include "ppapi/c/pp_completion_callback.h"
#include "ppapi/c/pp_instance.h"
#include "ppapi/c/pp_macros.h"
#include "ppapi/c/pp_resource.h"
#include "ppapi/c/pp_stdint.h"
#include "ppapi/c/pp_var.h"

#define PPB_SEFCLIENT_SAMSUNG_INTERFACE_0_1 "PPB_SefClient_Samsung;0.1"
#define PPB_SEFCLIENT_SAMSUNG_INTERFACE PPB_SEFCLIENT_SAMSUNG_INTERFACE_0_1

/**
 * @file
 */


/**
 * @addtogroup Typedefs
 * @{
 */
/**
 * Defines the callback type to receive events from EMP.
 *
 * @param[inout] user_data The opaque pointer that the caller passed into
 * <code>Open()</code>.
 * @param[in] event_type A type of the event.
 * @param[in] args_count How many arguments in the array.
 * @param[in] args An array of <code>PP_Var</code>. Please note that
 * the ref count of arguments is not increased on behalf of the plugin.
 */
typedef void (*PPB_SefClient_Samsung_Callback)(void* user_data,
                                               int32_t event_type,
                                               uint32_t args_count,
                                               const struct PP_Var args[]);
/**
 * @}
 */

/**
 * @addtogroup Interfaces
 * @{
 */
/**
 * Interface used to communicate with EMP (External Module Process).
 */
struct PPB_SefClient_Samsung_0_1 {
  /**
   * Create() creates Sef Client resource.
   *
   * @param[in] instance A <code>PP_Instance</code> identifying one instance
   * of a module.
   * @param[in] callback A <code>PPB_SefClient_Samsung_Callback</code>
   * callback function that browser calls when EMP sends event to Sef Client.
   * User can pass a null callback.
   * @param[in] user_data A pointer to user data used in the callback function.
   *
   * @return A <code>PP_Resource</code containing the Sef Client resource if
   * successful or 0 if resource cannot be created.
   */
  PP_Resource (*Create)(PP_Instance instance,
                        PPB_SefClient_Samsung_Callback callback,
                        void* user_data);
  /**
   * IsSefClient() determines if the provided resource if a Sef Client
   * resource.
   *
   * @param[in] resource A <code>PP_Resource</code corresponding to a generic
   * resource.
   *
   * @return A <code>PP_Bool</code containing <code>PP_TRUE</code if given
   * resource is a Sef Client resource, otherwise <code>PP_FALSE</code>.
   */
  PP_Bool (*IsSefClient)(PP_Resource resource);
  /**
   * Open() opens new EMP with given name, version and credential. It's possible
   * to call Open() only once on given Sef Client resource.
   *
   * @param[in] sef_client A <code>PP_Resource</code> corresponding to a Sef
   * Client resource.
   * @param[in] name The name of the EMP.
   * @param[in] version The version of the EMP.
   * @param[in] credential The credential of the EMP.
   * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
   * completion of Open().
   *
   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
   */
  int32_t (*Open)(PP_Resource sef_client,
                  const char* name,
                  const char* version,
                  const char* credential,
                  struct PP_CompletionCallback callback);
  /**
   * Execute() executes given command on opened EMP.
   *
   *
   * @param[in] sef_client A <code>PP_Resource</code> corresponding to a Sef
   * Client resource.
   * @param[in] params_count The number of parameters.
   * @param[in] params An array of parameters.
   * @param[in] result A pointer where will be stored result of executed
   * command.
   * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
   * completion of Execute().
   *
   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
   */
  int32_t (*Execute)(PP_Resource sef_client,
                     uint32_t params_count,
                     const struct PP_Var params[],
                     struct PP_Var* result,
                     struct PP_CompletionCallback callback);
};

typedef struct PPB_SefClient_Samsung_0_1 PPB_SefClient_Samsung;
/**
 * @}
 */

#endif  /* PPAPI_C_SAMSUNG_PPB_SEF_CLIENT_SAMSUNG_H_ */