security/nss/lib/ckfw/ckfwm.h

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is the Netscape security libraries.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Netscape Communications Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 1994-2000
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #ifndef CKFWM_H
  38 #define CKFWM_H
  39
  40 #ifdef DEBUG
  41 static const char CKFWM_CVS_ID[] = "@(#) $RCSfile: ckfwm.h,v $ $Revision: 1.6 $ $Date: 2005/08/25 20:08:26 $";
  42 #endif /* DEBUG */
  43
  44 /*
  45  * ckfwm.h
  46  *
  47  * This file prototypes the module-private calls of the NSS Cryptoki Framework.
  48  */
  49
  50 #ifndef NSSBASET_H
  51 #include "nssbaset.h"
  52 #endif /* NSSBASET_H */
  53
  54 #ifndef NSSCKT_H
  55 #include "nssckt.h"
  56 #endif /* NSSCKT_H */
  57
  58 #ifndef NSSCKFWT_H
  59 #include "nssckfwt.h"
  60 #endif /* NSSCKFWT_H */
  61
  62 /*
  63  * nssCKFWHash
  64  *
  65  *  nssCKFWHash_Create
  66  *  nssCKFWHash_Destroy
  67  *  nssCKFWHash_Add
  68  *  nssCKFWHash_Remove
  69  *  nssCKFWHash_Count
  70  *  nssCKFWHash_Exists
  71  *  nssCKFWHash_Lookup
  72  *  nssCKFWHash_Iterate
  73  */
  74
  75 /*
  76  * nssCKFWHash_Create
  77  *
  78  */
  79 NSS_EXTERN nssCKFWHash *
  80 nssCKFWHash_Create
  81 (
  82   NSSCKFWInstance *fwInstance,
  83   NSSArena *arena,
  84   CK_RV *pError
  85 );
  86
  87 /*
  88  * nssCKFWHash_Destroy
  89  *
  90  */
  91 NSS_EXTERN void
  92 nssCKFWHash_Destroy
  93 (
  94   nssCKFWHash *hash
  95 );
  96
  97 /*
  98  * nssCKFWHash_Add
  99  *
 100  */
 101 NSS_EXTERN CK_RV
 102 nssCKFWHash_Add
 103 (
 104   nssCKFWHash *hash,
 105   const void *key,
 106   const void *value
 107 );
 108
 109 /*
 110  * nssCKFWHash_Remove
 111  *
 112  */
 113 NSS_EXTERN void
 114 nssCKFWHash_Remove
 115 (
 116   nssCKFWHash *hash,
 117   const void *it
 118 );
 119
 120 /*
 121  * nssCKFWHash_Count
 122  *
 123  */
 124 NSS_EXTERN CK_ULONG
 125 nssCKFWHash_Count
 126 (
 127   nssCKFWHash *hash
 128 );
 129
 130 /*
 131  * nssCKFWHash_Exists
 132  *
 133  */
 134 NSS_EXTERN CK_BBOOL
 135 nssCKFWHash_Exists
 136 (
 137   nssCKFWHash *hash,
 138   const void *it
 139 );
 140
 141 /*
 142  * nssCKFWHash_Lookup
 143  *
 144  */
 145 NSS_EXTERN void *
 146 nssCKFWHash_Lookup
 147 (
 148   nssCKFWHash *hash,
 149   const void *it
 150 );
 151
 152 /*
 153  * nssCKFWHash_Iterate
 154  *
 155  */
 156 NSS_EXTERN void
 157 nssCKFWHash_Iterate
 158 (
 159   nssCKFWHash *hash,
 160   nssCKFWHashIterator fcn,
 161   void *closure
 162 );
 163
 164 #endif /* CKFWM_H */