.TH "globus_gass_cache.h" 3 "Mon Oct 5 2015" "Version 9.4" "globus_gass_cache" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gass_cache.h \- 
.PP
GASS Cache API\&.  

.SH SYNOPSIS
.br
.PP
\fC#include 'globus_common\&.h'\fP
.br
\fC#include <sys/param\&.h>\fP
.br

.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_GASS_CACHE_MODULE\fP   (&globus_i_gass_cache_module)"
.br
.RI "\fImodule_descriptor \fP"
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef struct 
.br
globus_i_gass_cache_t * \fBglobus_gass_cache_t\fP"
.br
.RI "\fIGASS Cache Handle\&. \fP"
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBglobus_gass_cache_open\fP (const char *cache_directory_path, \fBglobus_gass_cache_t\fP *cache_handle)"
.br
.RI "\fIOpen a GASS Cache\&. \fP"
.ti -1c
.RI "int \fBglobus_gass_cache_close\fP (\fBglobus_gass_cache_t\fP *cache_handle)"
.br
.RI "\fIClose a cache handle\&. \fP"
.ti -1c
.RI "int \fBglobus_gass_cache_add\fP (\fBglobus_gass_cache_t\fP cache_handle, const char *url, const char *tag, globus_bool_t create, unsigned long *timestamp, char **local_filename)"
.br
.RI "\fIAdd a tag to an URL in the cache\&. \fP"
.ti -1c
.RI "int \fBglobus_gass_cache_add_done\fP (\fBglobus_gass_cache_t\fP cache_handle, const char *url, const char *tag, unsigned long timestamp)"
.br
.RI "\fIComplete adding a cache entry and unlock it\&. \fP"
.ti -1c
.RI "int \fBglobus_gass_cache_query\fP (\fBglobus_gass_cache_t\fP cache_handle, const char *url, const char *tag, globus_bool_t wait_for_lock, unsigned long *timestamp, char **local_filename, globus_bool_t *is_locked)"
.br
.RI "\fIQuery the GASS Cache\&. \fP"
.ti -1c
.RI "int \fBglobus_gass_cache_delete_start\fP (\fBglobus_gass_cache_t\fP cache_handle, const char *url, const char *tag, unsigned long *timestamp)"
.br
.RI "\fIRemove a cache tag\&. \fP"
.ti -1c
.RI "int \fBglobus_gass_cache_delete\fP (\fBglobus_gass_cache_t\fP cache_handle, const char *url, const char *tag, unsigned long timestamp, globus_bool_t is_locked)"
.br
.RI "\fIRemove one instance of the tag from the cache entry's tag list\&. \fP"
.ti -1c
.RI "int \fBglobus_gass_cache_cleanup_tag\fP (\fBglobus_gass_cache_t\fP cache_handle, const char *url, const char *tag)"
.br
.RI "\fIRemove a tag from a cache entry\&. \fP"
.ti -1c
.RI "int \fBglobus_gass_cache_cleanup_tag_all\fP (\fBglobus_gass_cache_t\fP cache_handle, char *tag)"
.br
.RI "\fIRemove a tag from all cache entries
.PP
Remove all instances of the tag from the cache entry's tag list\&. If there are no more tags in the tag list, then remove this cache entry and delete the associated local cache file\&. If the cache entry is locked with the same tag as is passed to this function, then the entry is unlocked after removing the tags\&. Otherwise, the cache entry's lock is left untouched\&. \fP"
.ti -1c
.RI "int \fBglobus_gass_cache_mangle_url\fP (const \fBglobus_gass_cache_t\fP cache_handle, const char *url, char **mangled_url, int *length)"
.br
.RI "\fIConvert a URL to a string suitable as a file path\&. \fP"
.ti -1c
.RI "int \fBglobus_gass_cache_mangle_tag\fP (const \fBglobus_gass_cache_t\fP cache_handle, const char *tag, char **mangled_tag, int *length)"
.br
.RI "\fIConvert a tag to a string suitable as a file path\&. \fP"
.ti -1c
.RI "int \fBglobus_gass_cache_get_dirs\fP (const \fBglobus_gass_cache_t\fP cache_handle, const char *url, const char *tag, char **global_root, char **local_root, char **tmp_root, char **log_root, char **global_dir, char **local_dir)"
.br
.RI "\fIGet the set of directories used by a GASS Cache\&. \fP"
.ti -1c
.RI "int \fBglobus_gass_cache_get_cache_dir\fP (const \fBglobus_gass_cache_t\fP cache_handle, char **cache_dir)"
.br
.RI "\fIGet the GASS Cache's root directory\&. \fP"
.ti -1c
.RI "int \fBglobus_gass_cache_get_cache_type_string\fP (const \fBglobus_gass_cache_t\fP cache_handle, char **cache_type)"
.br
.RI "\fIGet the type of GASS Cache directory layout\&. \fP"
.ti -1c
.RI "const char * \fBglobus_gass_cache_error_string\fP (int error_code)"
.br
.RI "\fILook up the error string corresponding to a GASS Cache error\&. \fP"
.in -1c
.SH "Detailed Description"
.PP 
GASS Cache API\&. 


.SH "Author"
.PP 
Generated automatically by Doxygen for globus_gass_cache from the source code\&.