/*---------------------------------------------------------------------------
    ipr_nonce.h - ipr_nonce component

Nonces are held in a hash table.  The nonce value is the key into the
table.  This class generates the nonce value.
    Generated from ipr_nonce.icl by icl_gen using GSL/4.
    
    Copyright (c) 1996-2009 iMatix Corporation
    All rights reserved.
    
    This file is licensed under the BSD license as follows:
    
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:
    
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in
      the documentation and/or other materials provided with the
      distribution.
    * Neither the name of iMatix Corporation nor the names of its
      contributors may be used to endorse or promote products derived
      from this software without specific prior written permission.
    
    THIS SOFTWARE IS PROVIDED BY IMATIX CORPORATION "AS IS" AND ANY
    EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL IMATIX CORPORATION BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    These header files use macros to implement a split inclusion in which all
    safe definitions (those that do not depend on the presence of other
    definitions) are done first, and all unsafe definitions are done in a
    second pass through the same headers.

    The first header file included from the main C program defines itself as
    the "root" and thus controls the inclusion of the safe/unsafe pieces of
    the other headers.
 *---------------------------------------------------------------------------*/

#if !defined (ICL_IMPORT_HEADERS) || (ICL_IMPORT_HEADERS == 1)
# ifndef INCLUDE_IPR_NONCE_SAFE
#   define INCLUDE_IPR_NONCE_SAFE
#   define INCLUDE_IPR_NONCE_ACTIVE
#   if !defined (ICL_IMPORT_HEADERS)
#       define ICL_IMPORT_IPR_NONCE_ROOT
#       define ICL_IMPORT_HEADERS 1
#   endif
#   ifdef __cplusplus
extern "C" {
#   endif

//  Our own class typedef

typedef struct _ipr_nonce_t ipr_nonce_t;

#define IPR_NONCE_ALIVE                 0xFABB
#define IPR_NONCE_DEAD                  0xDEAD

#define IPR_NONCE_ASSERT_SANE(self)\
{\
    if (!self) {\
        fprintf (stderr, "FATAL ERROR at %s:%u, in %s\n", __FILE__, __LINE__, ICL_ASSERT_SANE_FUNCTION);\
        fprintf (stderr, "Attempting to work with a NULL ipr_nonce\n");\
        fprintf (stderr, "Please report this to openamq-dev@lists.openamq.org\n");\
        fflush (stderr);\
        abort ();\
    }\
    if (self->object_tag != IPR_NONCE_ALIVE) {\
        fprintf (stderr, "FATAL ERROR at %s:%u, in %s\n", __FILE__, __LINE__, ICL_ASSERT_SANE_FUNCTION);\
        fprintf (stderr, "ipr_nonce at %p expected object_tag=0x%x, actual object_tag=0x%x\n", self, IPR_NONCE_ALIVE, self->object_tag);\
        ipr_nonce_show (self, ICL_CALLBACK_DUMP, stderr);\
        fprintf (stderr, "Please report this to openamq-dev@lists.openamq.org\n");\
        fflush (stderr);\
        abort ();\
    }\
}
#   ifdef __cplusplus
}
#   endif

#   include "ipr_str.h"
#   include "ipr_nonce_table.h"
#   include "icl_mem.h"
#   ifdef __cplusplus
extern "C" {
#   endif

#   ifdef __cplusplus
}
#   endif
#   undef INCLUDE_IPR_NONCE_ACTIVE
#   if defined (ICL_IMPORT_IPR_NONCE_ROOT)
#       undef  ICL_IMPORT_HEADERS
#       define ICL_IMPORT_HEADERS 2
#   endif
# endif
#endif

#if !defined (ICL_IMPORT_HEADERS) || (ICL_IMPORT_HEADERS == 2)
# ifndef INCLUDE_IPR_NONCE_UNSAFE
#   define INCLUDE_IPR_NONCE_UNSAFE
#   define INCLUDE_IPR_NONCE_ACTIVE

#   include "ipr_str.h"
#   include "ipr_nonce_table.h"
#   include "icl_mem.h"

#   ifdef __cplusplus
extern "C" {
#   endif
//  Global variables

extern Bool
    ipr_nonce_animating;

//  Structure of the ipr_nonce object

struct _ipr_nonce_t {
dbyte
    object_tag;                     //  Object validity marker
ipr_nonce_table_t
    *table_head;                    //  Hash table container
ipr_nonce_t
    *table_next;                    //  Next item in the hash slot
qbyte
    table_index;                    //  Index of item in table
icl_shortstr_t
    key;                            //  Item's original key
int64_t
    count;                          //  Client nonce count value
apr_time_t
    expiry;                         //  Calculated expiry time
size_t
    quota;                          //  Hits remaining
};

#   ifdef __cplusplus
}
#   endif
#   ifdef __cplusplus
extern "C" {
#   endif
//  Method prototypes
#define ipr_nonce_new(table,key,ttl,quota)  ipr_nonce_new_ (__FILE__, __LINE__, table, key, ttl, quota)
ipr_nonce_t *
    ipr_nonce_new_ (
char * file,                            //  Source file for call
size_t line,                            //  Line number for call
ipr_nonce_table_t * table,              //  Table to insert into
char * key,                             //  Hash keyNonce value or NULL
size_t ttl,                             //  Time to live, seconds
size_t quota                            //  Lifespan, in hits
);

ipr_nonce_t *
    ipr_nonce_assume (
ipr_nonce_table_t * table,              //  Nonce table
char * key,                             //  Nonce value
size_t ttl,                             //  Time to live, seconds
size_t quota                            //  Lifespan, in hits
);

int
    ipr_nonce_expired (
ipr_nonce_t * self                      //  Reference to object
);

void
    ipr_nonce_selftest (
void);

void
    ipr_nonce_remove_from_all_containers (
ipr_nonce_t * self                      //  The item
);

#define ipr_nonce_show(item,opcode,trace_file)  ipr_nonce_show_ (item, opcode, trace_file, __FILE__, __LINE__)
void
    ipr_nonce_show_ (
void * item,                            //  The opaque pointer
int opcode,                             //  The callback opcode
FILE * trace_file,                      //  File to print to
char * file,                            //  Source file
size_t line                             //  Line number
);

void
    ipr_nonce_terminate (
void);

#define ipr_nonce_destroy(self)         ipr_nonce_destroy_ (self, __FILE__, __LINE__)
void
    ipr_nonce_destroy_ (
ipr_nonce_t * ( * self_p ),             //  Reference to object reference
char * file,                            //  Source fileSource file
size_t line                             //  Line numberLine number
);

void
    ipr_nonce_show_animation (
Bool enabled                            //  Are we enabling or disabling animation?
);

#define ipr_nonce_new_in_scope(self_p,_scope,table,key,ttl,quota)  ipr_nonce_new_in_scope_ (self_p, _scope, __FILE__, __LINE__, table, key, ttl, quota)
void
    ipr_nonce_new_in_scope_ (
ipr_nonce_t * * self_p,                 //  Not documented
icl_scope_t * _scope,                   //  Not documented
char * file,                            //  Source file for call
size_t line,                            //  Line number for call
ipr_nonce_table_t * table,              //  Table to insert into
char * key,                             //  Hash keyNonce value or NULL
size_t ttl,                             //  Time to live, seconds
size_t quota                            //  Lifespan, in hits
);


#   ifdef __cplusplus
}
#   endif
#   undef INCLUDE_IPR_NONCE_ACTIVE
#   if defined (ICL_IMPORT_IPR_NONCE_ROOT)
#       undef  ICL_IMPORT_HEADERS
#       define ICL_IMPORT_HEADERS 3
#   endif
# endif
#endif

#if !defined (ICL_IMPORT_HEADERS) || (ICL_IMPORT_HEADERS == 3)
# if !defined (INCLUDE_IPR_NONCE_INLINE)
#   define INCLUDE_IPR_NONCE_INLINE
#   define INCLUDE_IPR_NONCE_ACTIVE

#   include "ipr_str.h"
#   include "ipr_nonce_table.h"
#   include "icl_mem.h"

#   ifdef __cplusplus
extern "C" {
#   endif

#if (defined (BASE_TRACE)   || defined (BASE_TRACE_IPR_NONCE)   || defined (BASE_TRACE_IPR_NONCE_NEW)   || defined (BASE_TRACE_IPR_NONCE_ASSUME)   || defined (BASE_TRACE_IPR_NONCE_EXPIRED)   || defined (BASE_TRACE_IPR_NONCE_DESTROY)   || defined (BASE_TRACE_IPR_NONCE_SELFTEST)   || defined (BASE_TRACE_IPR_NONCE_REMOVE_FROM_ALL_CONTAINERS)   || defined (BASE_TRACE_IPR_NONCE_SHOW)   || defined (BASE_TRACE_IPR_NONCE_TERMINATE)   || defined (BASE_TRACE_IPR_NONCE_DESTROY_PUBLIC)   || defined (BASE_TRACE_IPR_NONCE_ALLOC)   || defined (BASE_TRACE_IPR_NONCE_FREE)   || defined (BASE_TRACE_IPR_NONCE_CACHE_INITIALISE)   || defined (BASE_TRACE_IPR_NONCE_CACHE_PURGE)   || defined (BASE_TRACE_IPR_NONCE_CACHE_TERMINATE)   || defined (BASE_TRACE_IPR_NONCE_SHOW_ANIMATION)   || defined (BASE_TRACE_IPR_NONCE_NEW_IN_SCOPE) )
void
    ipr_nonce_dump (icl_os_thread_t thread, apr_time_t time, qbyte info);
#endif

#   ifdef __cplusplus
}
#   endif
#   undef INCLUDE_IPR_NONCE_ACTIVE
#   if defined (ICL_IMPORT_IPR_NONCE_ROOT)
#       undef ICL_IMPORT_HEADERS
#       undef ICL_IMPORT_IPR_NONCE_ROOT
#   endif
# endif
#endif
