Loading...
Searching...
No Matches
globus_object_cache.h
Go to the documentation of this file.
/*
* Copyright 1999-2006 University of Chicago
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef GLOBUS_OBJECT_CACHE_H
#define GLOBUS_OBJECT_CACHE_H
#include "globus_common_include.h"
#include "globus_fifo.h"
#include "globus_list.h"
#include "globus_hashtable.h"
#include "globus_object.h"
#ifdef __cplusplus
extern "C" {
#endif
/**********************************************************************
* Object Cache API Types
* globus_object_cache_t -- container
**********************************************************************/
typedef struct globus_object_cache_s {
globus_hashtable_t handlemap;
globus_fifo_t handles; /* in case we add a cache list function */
unsigned long capacity_limit;
unsigned long entry_count;
} globus_object_cache_t;
/**********************************************************************
* Object Cache API
**********************************************************************/
extern void
globus_object_cache_init (globus_object_cache_t * cache);
/* does nothing if cache is NULL */
extern void
globus_object_cache_destroy (globus_object_cache_t * cache);
/* does nothing if cache is NULL */
extern void
globus_object_cache_insert (globus_object_cache_t * cache,
void * new_handle,
globus_object_t * new_object);
/* does nothing if cache is NULL, or new_handle is already mapped in cache,
* or new_object is NULL */
extern globus_object_t *
globus_object_cache_lookup (globus_object_cache_t * cache,
void * handle);
/* returns object stored in cache with handle, or
* returns NULL if not mapped or if cache is NULL */
extern globus_object_t *
globus_object_cache_remove (globus_object_cache_t * cache,
void * handle);
/* returns object removed from cache with handle, or
* returns NULL if not mapped or if cache is NULL */
extern globus_fifo_t *
globus_object_cache_list (globus_object_cache_t * cache);
/* returns fifo containing existing handles in order inserted, or
* returns NULL if cache is NULL */
#ifdef __cplusplus
}
#endif
#endif /* GLOBUS_OBJECT_CACHE_H */
globus_common_include.h
Include System Headers.
globus_fifo.h
Globus FIFO.
globus_hashtable.h
Hash Table.
globus_list.h
Linked List.
globus_fifo_t
struct globus_fifo_s * globus_fifo_t
Definition globus_fifo.h:48