ShiTransaction.h

Go to the documentation of this file.

/*****************************************************************
|
|   Sushi - Transaction
|
|   $Id: ShiTransaction.h 7930 2014-06-25 11:05:10Z jebaseelir $
|   Original author:  Gilles Boccon-Gibod
|
|   This software is provided to you pursuant to your agreement 
|   with Intertrust Technologies Corporation ("Intertrust"). 
|   This software may be used only in accordance with the terms 
|   of the agreement.
|      
|   Copyright (c) 2005-2014 by Intertrust. All rights reserved. 
|
****************************************************************/
#ifndef _SHI_TRANSACTION_H_
#define _SHI_TRANSACTION_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "ShiResults.h"
#include "ShiTypes.h"
#include "ShiList.h"
#include "ShiEngine.h"

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/
typedef enum {
    SHI_TRANSACTION_TYPE_SERVICE_TOKEN_PROCESSING,
    SHI_TRANSACTION_TYPE_PERSONALIZATION,
    SHI_TRANSACTION_TYPE_USER_REGISTRATION,
    SHI_TRANSACTION_TYPE_LINK_ACQUISITION,
    SHI_TRANSACTION_TYPE_LINK_RELEASE,
    SHI_TRANSACTION_TYPE_SECURITY_DATA_UPDATE,
    SHI_TRANSACTION_TYPE_SECURITY_DATA_CERTIFICATION,
    SHI_TRANSACTION_TYPE_SUSPENSION_LIST_UPDATE,
    SHI_TRANSACTION_TYPE_METERING_DATA_UPDATE,
    SHI_TRANSACTION_TYPE_LICENSE_ACQUISITION,
    SHI_TRANSACTION_TYPE_CRL_UPDATE,
    SHI_TRANSACTION_TYPE_PERSONALITY_UPDATE
} SHI_TransactionType;

typedef enum {
    SHI_TRANSACTION_STATE_STARTING,
    SHI_TRANSACTION_STATE_SUCCEEDED,
    SHI_TRANSACTION_STATE_FAILED,
    SHI_TRANSACTION_STATE_IN_PROGRESS
} SHI_TransactionState;

typedef struct {
    SHI_EngineEvent      base;              
    SHI_TransactionType  transaction_type;  
    SHI_TransactionState transaction_state; 
} SHI_TransactionEvent;

typedef struct {
    SHI_TransactionEvent base;         
    SHI_Ordinal          current_step; 
    SHI_Cardinal         total_steps;  
} SHI_TransactionProgressEvent;

typedef struct {
    SHI_Result  code;    
    const char* message; 
    const char* service_exception; 
} SHI_TransactionResult;

typedef struct {
    SHI_TransactionEvent  base;   
    SHI_TransactionResult result; 
} SHI_TransactionEndEvent;

#endif /* _SHI_TRANSACTION_H_ */