epoc32/include/cryptospi/cryptobaseapi.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
/*
williamr@4
     2
* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     3
* All rights reserved.
williamr@4
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of the License "Eclipse Public License v1.0"
williamr@4
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     8
*
williamr@4
     9
* Initial Contributors:
williamr@4
    10
* Nokia Corporation - initial contribution.
williamr@4
    11
*
williamr@4
    12
* Contributors:
williamr@4
    13
*
williamr@4
    14
* Description: 
williamr@4
    15
* crypto base api interface
williamr@4
    16
*
williamr@4
    17
*/
williamr@4
    18
williamr@4
    19
williamr@4
    20
/**
williamr@4
    21
 @file
williamr@4
    22
 @publishedAll
williamr@4
    23
 @released
williamr@4
    24
*/
williamr@4
    25
williamr@4
    26
#ifndef __CRYPTOAPI_BASEAPI_H__
williamr@4
    27
#define __CRYPTOAPI_BASEAPI_H__
williamr@4
    28
williamr@4
    29
#include <e32base.h>
williamr@4
    30
#include <cryptospi/plugincharacteristics.h>
williamr@4
    31
williamr@4
    32
namespace CryptoSpi
williamr@4
    33
	{
williamr@4
    34
	class MPlugin;
williamr@4
    35
	class MHash;
williamr@4
    36
	class MAsyncHash;
williamr@4
    37
	class CCryptoParams;
williamr@4
    38
	class CExtendedCharacteristics;
williamr@4
    39
		
williamr@4
    40
	NONSHARABLE_CLASS(CCryptoBase) : public CBase
williamr@4
    41
		{
williamr@4
    42
	public:
williamr@4
    43
		/**
williamr@4
    44
		Retrieves the plugin's common characteristics
williamr@4
    45
		@param aPluginCharacteristics The plugin characteristics value retrieved
williamr@4
    46
		@leave ...	Any of the crypto error codes defined in 
williamr@4
    47
  					cryptospi_errs.h or any of the system-wide error codes.
williamr@4
    48
		*/
williamr@4
    49
		IMPORT_C void GetCharacteristicsL(const TCharacteristics*& aPluginCharacteristics);
williamr@4
    50
		
williamr@4
    51
		/**
williamr@4
    52
		Retrieves the plugin's extended characteristics
williamr@4
    53
		@return The extended plugin characteristics, on the heap.
williamr@4
    54
		This should be deleted by the caller when finished with.
williamr@4
    55
		@leave ...	Any of the crypto error codes defined in 
williamr@4
    56
  					cryptospi_errs.h or any of the system-wide error codes.
williamr@4
    57
		*/	
williamr@4
    58
		IMPORT_C const CExtendedCharacteristics* GetExtendedCharacteristicsL();
williamr@4
    59
williamr@4
    60
        /**
williamr@4
    61
        Resets the state of the crypto object to uninitialised. All prior
williamr@4
    62
        state is lost.
williamr@4
    63
        */
williamr@4
    64
        IMPORT_C void Reset();
williamr@4
    65
	
williamr@4
    66
	protected:
williamr@4
    67
		/**
williamr@4
    68
		 * @internalComponent
williamr@4
    69
		 * 
williamr@4
    70
		 * Constructor
williamr@4
    71
		 **/		
williamr@4
    72
		CCryptoBase(MPlugin* aPlugin, TInt aLibHandle);
williamr@4
    73
		/**
williamr@4
    74
		Destructor
williamr@4
    75
		*/
williamr@4
    76
		virtual ~CCryptoBase();
williamr@4
    77
	
williamr@4
    78
	protected:
williamr@4
    79
		/**
williamr@4
    80
		The plugin implementation
williamr@4
    81
		*/
williamr@4
    82
		MPlugin* iPlugin;	
williamr@4
    83
		
williamr@4
    84
		/**
williamr@4
    85
		The current plugin DLL loaded
williamr@4
    86
		*/
williamr@4
    87
		TInt iLibHandle;
williamr@4
    88
		};
williamr@4
    89
	}
williamr@4
    90
williamr@4
    91
#endif //__CRYPTOAPI_BASEAPI_H__
williamr@4
    92