.TH "LRC Operations" 3 "Wed Jan 25 2012" "Version 5.2" "globus rls client" \" -*- nroff -*-
.ad l
.nh
.SH NAME
LRC Operations \- 
.SS "Data Structures"

.in +1c
.ti -1c
.RI "struct \fBglobus_rls_rli_info_t\fP"
.br
.RI "\fIInformation about RLI server, returned by \fBglobus_rls_client_lrc_rli_info()\fP and \fBglobus_rls_client_lrc_rli_list()\fP\&. \fP"
.in -1c
.SS "Defines"

.in +1c
.ti -1c
.RI "#define \fBFRLI_BLOOMFILTER\fP   0x1"
.br
.ti -1c
.RI "#define \fBMAXURL\fP   256"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_attr_add\fP (\fBglobus_rls_handle_t\fP *h, char *key, \fBglobus_rls_attribute_t\fP *attr)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_attr_add_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *attr_obj_list, globus_list_t **str2bulk_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_attr_create\fP (\fBglobus_rls_handle_t\fP *h, char *name, \fBglobus_rls_obj_type_t\fP objtype, \fBglobus_rls_attr_type_t\fP type)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_attr_delete\fP (\fBglobus_rls_handle_t\fP *h, char *name, \fBglobus_rls_obj_type_t\fP objtype, globus_bool_t clearvalues)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_attr_get\fP (\fBglobus_rls_handle_t\fP *h, char *name, \fBglobus_rls_obj_type_t\fP objtype, globus_list_t **attr_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_attr_modify\fP (\fBglobus_rls_handle_t\fP *h, char *key, \fBglobus_rls_attribute_t\fP *attr)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_attr_remove\fP (\fBglobus_rls_handle_t\fP *h, char *key, \fBglobus_rls_attribute_t\fP *attr)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_attr_remove_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *attr_obj_list, globus_list_t **str2bulk_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_attr_search\fP (\fBglobus_rls_handle_t\fP *h, char *name, \fBglobus_rls_obj_type_t\fP objtype, \fBglobus_rls_attr_op_t\fP op, \fBglobus_rls_attribute_t\fP *operand1, \fBglobus_rls_attribute_t\fP *operand2, int *offset, int reslimit, globus_list_t **attr_obj_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_attr_value_get\fP (\fBglobus_rls_handle_t\fP *h, char *key, char *name, \fBglobus_rls_obj_type_t\fP objtype, globus_list_t **attr_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_attr_value_get_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *keylist, char *name, \fBglobus_rls_obj_type_t\fP objtype, globus_list_t **attr_obj_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_add\fP (\fBglobus_rls_handle_t\fP *h, char *lfn, char *pfn)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_add_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *str2_list, globus_list_t **str2bulk_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_clear\fP (\fBglobus_rls_handle_t\fP *h)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_create\fP (\fBglobus_rls_handle_t\fP *h, char *lfn, char *pfn)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_create_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *str2_list, globus_list_t **str2bulk_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_delete\fP (\fBglobus_rls_handle_t\fP *h, char *lfn, char *pfn)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_delete_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *str2_list, globus_list_t **str2bulk_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_exists\fP (\fBglobus_rls_handle_t\fP *h, char *key, \fBglobus_rls_obj_type_t\fP objtype)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_exists_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *keylist, \fBglobus_rls_obj_type_t\fP objtype, globus_list_t **str2bulk_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_get_lfn\fP (\fBglobus_rls_handle_t\fP *h, char *pfn, int *offset, int reslimit, globus_list_t **str2_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_get_lfn_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *pfnlist, globus_list_t **str2bulk_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_get_lfn_wc\fP (\fBglobus_rls_handle_t\fP *h, char *pfn_pattern, \fBglobus_rls_pattern_t\fP type, int *offset, int reslimit, globus_list_t **str2_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_get_pfn\fP (\fBglobus_rls_handle_t\fP *h, char *lfn, int *offset, int reslimit, globus_list_t **str2_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_get_pfn_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *lfnlist, globus_list_t **str2bulk_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_get_pfn_wc\fP (\fBglobus_rls_handle_t\fP *h, char *lfn_pattern, \fBglobus_rls_pattern_t\fP type, int *offset, int reslimit, globus_list_t **str2_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_mapping_exists\fP (\fBglobus_rls_handle_t\fP *h, char *lfn, char *pfn)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_renamelfn\fP (\fBglobus_rls_handle_t\fP *h, char *oldname, char *newname)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_renamelfn_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *str2_list, globus_list_t **str2bulk_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_renamepfn\fP (\fBglobus_rls_handle_t\fP *h, char *oldname, char *newname)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_renamepfn_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *str2_list, globus_list_t **str2bulk_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_rli_add\fP (\fBglobus_rls_handle_t\fP *h, char *rli_url, int flags, char *pattern)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_rli_delete\fP (\fBglobus_rls_handle_t\fP *h, char *rli_url, char *pattern)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_rli_get_part\fP (\fBglobus_rls_handle_t\fP *h, char *rli_url, char *pattern, globus_list_t **str2_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_rli_info\fP (\fBglobus_rls_handle_t\fP *h, char *rli_url, \fBglobus_rls_rli_info_t\fP *info)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_lrc_rli_list\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t **rliinfo_list)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Functions to view and update data managed by a LRC server\&. 
.SH "Define Documentation"
.PP 
.SS "#define \fBFRLI_BLOOMFILTER\fP   0x1"
.PP
Update RLI using bloom filters (see \fBglobus_rls_client_lrc_rli_add()\fP)\&. 
.SS "#define \fBMAXURL\fP   256"
.PP
Maximum length of URL string\&. 
.SH "Function Documentation"
.PP 
.SS "globus_result_t \fBglobus_rls_client_lrc_attr_add\fP (\fBglobus_rls_handle_t\fP *h, char *key, \fBglobus_rls_attribute_t\fP *attr)"
.PP
Add an attribute to an object in the LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIkey\fP Logical or Physical File Name (LFN or PFN) that identifies object attribute should be added to\&.
.br
\fIattr\fP Attribute to be added to object\&. \fBname, objtype, type and val \fP should be set in \fIattr\fP\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Attribute successfully associated with object\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_attr_add_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *attr_obj_list, globus_list_t **str2bulk_list)"
.PP
Bulk add attributes to objects in the LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIattr_obj_list\fP List of object names (LFN or PFN) and attributes to be added\&. Each list datum should be of type \fBglobus_rls_attribute_object_t\fP\&.
.br
\fIstr2bulk_list\fP List of failed updates\&. Each list datum is a \fBglobus_rls_string2_bulk_t\fP structure\&. \fBstr2\&.s1\fP will be the oject name, \fBstr2\&.s2\fP the attribute name, and \fBrc\fP will be the result code from the failed update\&. Only failed updates will be returned\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_attr_create\fP (\fBglobus_rls_handle_t\fP *h, char *name, \fBglobus_rls_obj_type_t\fPobjtype, \fBglobus_rls_attr_type_t\fPtype)"
.PP
Define new attribute in LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an LRC server\&.
.br
\fIname\fP Name of attribute\&.
.br
\fIobjtype\fP Object (LFN or PFN) type that attribute applies to\&.
.br
\fItype\fP Type of attribute value\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Attribute successfully created\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_attr_delete\fP (\fBglobus_rls_handle_t\fP *h, char *name, \fBglobus_rls_obj_type_t\fPobjtype, globus_bool_tclearvalues)"
.PP
Undefine attribute in LRC database, previously created with \fBglobus_rls_client_lrc_attr_create()\fP\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an LRC server\&.
.br
\fIname\fP Name of attribute\&.
.br
\fIobjtype\fP Object (LFN or PFN) type that attribute applies to\&.
.br
\fIclearvalues\fP If GLOBUS_TRUE then any any values for this attribute are first removed from the objects they're associated with\&. If GLOBUS_FALSE and any values exist then \fBGLOBUS_RLS_ATTR_EXIST\fP is returned\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Attribute successfully removed\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_attr_get\fP (\fBglobus_rls_handle_t\fP *h, char *name, \fBglobus_rls_obj_type_t\fPobjtype, globus_list_t **attr_list)"
.PP
Return definitions of attributes in LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIname\fP Name of attribute\&. If name is NULL all attributes of the specified \fIobjtype\fP are returned\&.
.br
\fIobjtype\fP Object (LFN or PFN) type that attribute applies to\&.
.br
\fIattr_list\fP Any attribute definitions found will be returned as a list of \fBglobus_rls_attribute_t\fP structures\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Attribute definitions successfully retrieved\&. \fIattr_list\fP should be freed with \fBglobus_rls_client_free_list()\fP when it is no longer needed\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_attr_modify\fP (\fBglobus_rls_handle_t\fP *h, char *key, \fBglobus_rls_attribute_t\fP *attr)"
.PP
Modify an attribute value\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIkey\fP Name of object (LFN or PFN)\&.
.br
\fIattr\fP Attribute to be modified\&. The \fBobjtype \fP, \fBname \fP and \fBtype \fP fields should be set in \fIattr\fP to identify the attribute, the \fBval \fP field should be the new value\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Attribute successfully modified\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_attr_remove\fP (\fBglobus_rls_handle_t\fP *h, char *key, \fBglobus_rls_attribute_t\fP *attr)"
.PP
Remove an attribute from an object (LFN or PFN) in the LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIkey\fP Name of object (LFN or PFN)\&.
.br
\fIattr\fP Attribute to be removed\&. The \fBobjtype \fP and \fBname \fP fields should be set in \fIattr\fP to identify the attribute\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Attribute successfully removed\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_attr_remove_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *attr_obj_list, globus_list_t **str2bulk_list)"
.PP
Bulk remove attributes from objects in the LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIattr_obj_list\fP List of object names (LFN or PFN) and attributes to be removed\&. It is not necessary to set the attribute type or value\&. Each list datum should be of type \fBglobus_rls_attribute_object_t\fP\&.
.br
\fIstr2bulk_list\fP List of failed updates\&. Each list datum is a \fBglobus_rls_string2_bulk_t\fP structure\&. \fBstr2\&.s1\fP will be the oject name, \fBstr2\&.s2\fP the attribute name, and \fBrc\fP will be the result code from the failed update\&. Only failed updates will be returned\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_attr_search\fP (\fBglobus_rls_handle_t\fP *h, char *name, \fBglobus_rls_obj_type_t\fPobjtype, \fBglobus_rls_attr_op_t\fPop, \fBglobus_rls_attribute_t\fP *operand1, \fBglobus_rls_attribute_t\fP *operand2, int *offset, intreslimit, globus_list_t **attr_obj_list)"
.PP
Search for objects (LFNs or PFNs) in a LRC database that have the specified attribute whose value matches a boolean expression\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIname\fP Name of attribute\&.
.br
\fIobjtype\fP Object (LFN or PFN) type that attribute applies to\&.
.br
\fIop\fP Operator to be used in searching for values\&.
.br
\fIoperand1\fP First operand in boolean expression\&. \fBtype \fP and \fBval \fP should be set in \fBglobus_rls_attribute_t\fP\&.
.br
\fIoperand2\fP Second operand in boolean expression, only used when \fIop\fP is globus_rls_client_attr_op_btw\&. \fBtype \fP and \fBval \fP should be set in \fBglobus_rls_attribute_t\fP\&.
.br
\fIoffset\fP Offset into result list\&. Used in conjunction with \fIreslimit\fP to retrieve results a few at a time\&. Use 0 to begin with first result\&. If NULL then API will handle accumulating partial results transparently\&.
.br
\fIreslimit\fP Maximum number of results to return\&. Used in conjunction with \fIoffset\fP to retrieve results a few at a time\&. Use 0 to retrieve all results\&.
.br
\fIattr_obj_list\fP Any objects with the specified attribute will be returned, with the attribute value, in a list of \fBglobus_rls_attribute_object_t\fP structures\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Objects with specified attribute returned in \fIattr_obj_list\fP\&. \fIattr_obj_list\fP should be freed with \fBglobus_rls_client_free_list()\fP when it is no longer needed\&. See \fBQuery Results\fP\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_attr_value_get\fP (\fBglobus_rls_handle_t\fP *h, char *key, char *name, \fBglobus_rls_obj_type_t\fPobjtype, globus_list_t **attr_list)"
.PP
Return attributes in LRC database for specified object (LFN or PFN)\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIkey\fP Logical or Physical File Name (LFN or PFN) that identifies object attributes should be retrieved for\&.
.br
\fIname\fP Name of attribute to retrieve\&. If NULL all attributes for \fIkey\fP, \fIobjtype\fP are returned\&.
.br
\fIobjtype\fP Object (LFN or PFN) type that attribute applies to\&.
.br
\fIattr_list\fP Any attributes found will be returned in this list of \fBglobus_rls_attribute_t\fP structures\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Attributes successfully retrieved\&. \fIattr_list\fP should be freed with \fBglobus_rls_client_free_list()\fP when it is no longer needed\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_attr_value_get_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *keylist, char *name, \fBglobus_rls_obj_type_t\fPobjtype, globus_list_t **attr_obj_list)"
.PP
Return attributes in LRC database for specified objects (LFN or PFN)\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIkeylist\fP Logical or Physical File Names (LFNs or PFNs) that identify object attributes should be retrieved for\&. Each list datum should be a string containing the LFN or PFN\&.
.br
\fIname\fP Name of attribute to retrieve\&. If NULL all attributes for \fIkey\fP, \fIobjtype\fP are returned\&.
.br
\fIobjtype\fP Object (LFN or PFN) type that attribute applies to\&.
.br
\fIattr_obj_list\fP Any attributes found will be returned in this list of \fBglobus_rls_attribute_object_t\fP structures\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Attributes successfully retrieved\&. \fIattr_obj_list\fP should be freed with \fBglobus_rls_client_free_list()\fP when it is no longer needed\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_add\fP (\fBglobus_rls_handle_t\fP *h, char *lfn, char *pfn)"
.PP
Add mapping to PFN to an existing LFN\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIlfn\fP LFN to add \fIpfn\fP mapping to, should already exist\&.
.br
\fIpfn\fP PFN that \fIlfn\fP should map to\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP New mapping created\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_add_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *str2_list, globus_list_t **str2bulk_list)"
.PP
Bulk add LFN,PFN mappings in LRC database\&. LFNs must already exist\&.
.PP
\fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIstr2_list\fP LFN,PFN pairs to add mappings\&.
.br
\fIstr2bulk_list\fP List of failed updates\&. Each list datum is a \fBglobus_rls_string2_bulk_t\fP structure\&. \fBstr2\&.s1\fP will be the LFN, and \fBstr2\&.s2\fP the PFN it maps to, and \fBrc\fP will be the result code from the failed update\&. Only failed updates will be returned\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_clear\fP (\fBglobus_rls_handle_t\fP *h)"
.PP
Clear all mappings from LRC database\&. User needs both ADMIN and LRCUPDATE privileges to perform this operation\&. Note that if the LRC is cleared this will not be reflected in any RLI servers updated by the LRC until the next softstate update, even if immediate updates are enabled\&.
.PP
\fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Mappings cleared\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_create\fP (\fBglobus_rls_handle_t\fP *h, char *lfn, char *pfn)"
.PP
Create mapping between a LFN and PFN\&. LFN should not exist yet\&.
.PP
\fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIlfn\fP LFN to add \fIpfn\fP mapping to, should not already exist\&.
.br
\fIpfn\fP PFN that \fIlfn\fP should map to\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP New mapping created\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_create_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *str2_list, globus_list_t **str2bulk_list)"
.PP
Bulk create LFN,PFN mappings in LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIstr2_list\fP LFN,PFN pairs to create mappings for\&.
.br
\fIstr2bulk_list\fP List of failed updates\&. Each list datum is a \fBglobus_rls_string2_bulk_t\fP structure\&. \fBstr2\&.s1\fP will be the LFN, and \fBstr2\&.s2\fP the PFN it maps to, and \fBrc\fP will be the result code from the failed update\&. Only failed updates will be returned\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_delete\fP (\fBglobus_rls_handle_t\fP *h, char *lfn, char *pfn)"
.PP
Delete mapping between LFN and PFN\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIlfn\fP LFN to remove mapping from\&.
.br
\fIpfn\fP PFN that \fIlfn\fP maps to that is being removed\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Mapping removed\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_delete_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *str2_list, globus_list_t **str2bulk_list)"
.PP
Bulk delete LFN,PFN mappings in LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIstr2_list\fP LFN,PFN pairs to add mappings\&.
.br
\fIstr2bulk_list\fP List of failed updates\&. Each list datum is a \fBglobus_rls_string2_bulk_t\fP structure\&. \fBstr2\&.s1\fP will be the LFN, and \fBstr2\&.s2\fP the PFN it maps to, and \fBrc\fP will be the result code from the failed update\&. Only failed updates will be returned\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_exists\fP (\fBglobus_rls_handle_t\fP *h, char *key, \fBglobus_rls_obj_type_t\fPobjtype)"
.PP
Check if an object exists in the LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIkey\fP LFN or PFN that identifies object\&.
.br
\fIobjtype\fP Type of object \fIkey\fP refers to (\fBglobus_rls_obj_lrc_lfn\fP or \fBglobus_rls_obj_lrc_pfn\fP)\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Object exists\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_exists_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *keylist, \fBglobus_rls_obj_type_t\fPobjtype, globus_list_t **str2bulk_list)"
.PP
Bulk check if objects exist in the LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIkeylist\fP LFNs or PFNs that identify objects\&.
.br
\fIobjtype\fP Type of object \fIkey\fP refers to (\fBglobus_rls_obj_lrc_lfn\fP or \fBglobus_rls_obj_lrc_pfn\fP)\&.
.br
\fIstr2bulk_list\fP Results of existence check\&. Each list datum will be a \fBglobus_rls_string2_bulk_t\fP structure\&. \fBstr2\&.s1\fP will be the LFN or PFN, and \fBstr2\&.s2\fP empty, and \fBrc\fP will be the result code indicating existence\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_get_lfn\fP (\fBglobus_rls_handle_t\fP *h, char *pfn, int *offset, intreslimit, globus_list_t **str2_list)"
.PP
Return LFNs mapped to PFN in the LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIpfn\fP PFN to search for\&.
.br
\fIoffset\fP Offset into result list\&. Used in conjunction with \fIreslimit\fP to retrieve results a few at a time\&. Use 0 to begin with first result\&. If NULL then API will handle accumulating partial results transparently\&.
.br
\fIreslimit\fP Maximum number of results to return\&. Used in conjunction with \fIoffset\fP to retrieve results a few at a time\&. Use 0 to retrieve all results\&.
.br
\fIstr2_list\fP List of LFNs that map to \fIpfn\fP\&. Each list datum will be a \fBglobus_rls_string2_t\fP structure\&. \fBs1\fP will be the LFN, and \fBs2\fP the PFN it maps to\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP List of LFNs that map to \fIpfn\fP in \fIstr2_list\fP\&. See \fBQuery Results\fP\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_get_lfn_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *pfnlist, globus_list_t **str2bulk_list)"
.PP
Bulk return LFNs mapped to PFN in the LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIpfnlist\fP PFNs to search for\&.
.br
\fIstr2bulk_list\fP Results of queries\&. Each list datum will be a \fBglobus_rls_string2_bulk_t\fP structure\&. \fBstr2\&.s1\fP will be the LFN, and \fBstr2\&.s2\fP the PFN it maps to, and \fBrc\fP will be the result code from the query\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_get_lfn_wc\fP (\fBglobus_rls_handle_t\fP *h, char *pfn_pattern, \fBglobus_rls_pattern_t\fPtype, int *offset, intreslimit, globus_list_t **str2_list)"
.PP
Return LFNs mapped to wildcarded PFN in the LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIpfn_pattern\fP PFN pattern to search for\&.
.br
\fItype\fP Identifies wildcard characters used in \fIpfn_pattern\fP\&. Wildcard chars can be Unix file globbing chars (* matches 0 or more characters, ? matches any single character) or SQL 'like' wildcard characters (% matches 0 or more charactes, _ matches any single character)\&.
.br
\fIoffset\fP Offset into result list\&. Used in conjunction with \fIreslimit\fP to retrieve results a few at a time\&. Use 0 to begin with first result\&. If NULL then the API will handle accumulating partial results transparently\&.
.br
\fIreslimit\fP Maximum number of results to return\&. Used in conjunction with \fIoffset\fP to retrieve results a few at a time\&. Use 0 to retrieve all results\&.
.br
\fIstr2_list\fP List of LFNs that map to \fIpfn_pattern\fP\&. Each list datum will be a \fBglobus_rls_string2_t\fP structure\&. \fBs1\fP will be the LFN, and \fBs2\fP the PFN it maps to\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP List of LFNs that map to \fIpfn_pattern\fP in \fIstr2_list\fP\&. See \fBQuery Results\fP\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_get_pfn\fP (\fBglobus_rls_handle_t\fP *h, char *lfn, int *offset, intreslimit, globus_list_t **str2_list)"
.PP
Return PFNs mapped to LFN in the LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIlfn\fP LFN to search for\&.
.br
\fIoffset\fP Offset into result list\&. Used in conjunction with \fIreslimit\fP to retrieve results a few at a time\&. Use 0 to begin with first result\&.
.br
\fIreslimit\fP Maximum number of results to return\&. Used in conjunction with \fIoffset\fP to retrieve results a few at a time\&. Use 0 to retrieve all results\&.
.br
\fIstr2_list\fP List of PFNs that map to \fIlfn\fP\&. Each list datum will be a \fBglobus_rls_string2_t\fP structure\&. \fBs1\fP will be the LFN, and \fBs2\fP the PFN it maps to\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP List of PFNs that map to \fIlfn\fP in \fIstr2_list\fP\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_get_pfn_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *lfnlist, globus_list_t **str2bulk_list)"
.PP
Bulk return PFNs mapped to LFN in the LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIlfnlist\fP LFNs to search for\&.
.br
\fIstr2bulk_list\fP Results of queries\&. Each list datum will be a \fBglobus_rls_string2_bulk_t\fP structure\&. \fBstr2\&.s1\fP will be the LFN, and \fBstr2\&.s2\fP the PFN it maps to, and \fBrc\fP will be the result code from the query\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_get_pfn_wc\fP (\fBglobus_rls_handle_t\fP *h, char *lfn_pattern, \fBglobus_rls_pattern_t\fPtype, int *offset, intreslimit, globus_list_t **str2_list)"
.PP
Return PFNs mapped to wildcarded LFN in the LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIlfn_pattern\fP LFN pattern to search for\&.
.br
\fItype\fP Identifies wildcard characters used in \fIlfn_pattern\fP\&. Wildcard chars can be Unix file globbing chars (* matches 0 or more characters, ? matches any single character) or SQL 'like' wildcard characters (% matches 0 or more charactes, _ matches any single character)\&.
.br
\fIoffset\fP Offset into result list\&. Used in conjunction with \fIreslimit\fP to retrieve results a few at a time\&. Use 0 to begin with first result\&.
.br
\fIreslimit\fP Maximum number of results to return\&. Used in conjunction with \fIoffset\fP to retrieve results a few at a time\&. Use 0 to retrieve all results\&.
.br
\fIstr2_list\fP List of PFNs that map to \fIlfn_pattern\fP\&. Each list datum will be a \fBglobus_rls_string2_t\fP structure\&. \fBs1\fP will be the LFN, and \fBs2\fP the PFN it maps to\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP List of PFNs that map to \fIlfn_pattern\fP in \fIstr2_list\fP\&. See \fBQuery Results\fP\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_mapping_exists\fP (\fBglobus_rls_handle_t\fP *h, char *lfn, char *pfn)"
.PP
Check if a mapping exists in the LRC database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIlfn\fP LFN of mapping\&.
.br
\fIpfn\fP PFN of mapping\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Object exists\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_renamelfn\fP (\fBglobus_rls_handle_t\fP *h, char *oldname, char *newname)"
.PP
Rename LFN\&. If immediate mode is ON, the LRC will send update messages to associated RLIs\&.
.PP
\fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIoldname\fP Existing LFN name, to be renamed\&.
.br
\fInewname\fP New LFN name, to replace existing name\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP LFN renamed\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_renamelfn_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *str2_list, globus_list_t **str2bulk_list)"
.PP
Bulk rename LFN names in LRC database\&. LFNs must already exist\&. If immediate mode is ON, the LRC will send update messages to associated RLIs\&.
.PP
\fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIstr2_list\fP oldname,newname pairs such that newname replaces oldname for LFNs\&.
.br
\fIstr2bulk_list\fP List of failed updates\&. Each list datum is a \fBglobus_rls_string2_bulk_t\fP structure\&. \fBstr2\&.s1\fP will be the old LFN name, and \fBstr2\&.s2\fP the new LFN name, and \fBrc\fP will be the result code from the failed update\&. Only failed updates will be returned\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_renamepfn\fP (\fBglobus_rls_handle_t\fP *h, char *oldname, char *newname)"
.PP
Rename PFN\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIoldname\fP Exisintg PFN name, to be renamed\&.
.br
\fInewname\fP New PFN name, to replace existing name\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP PFN renamed\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_renamepfn_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *str2_list, globus_list_t **str2bulk_list)"
.PP
Bulk rename PFN names in LRC database\&. PFNs must already exist\&.
.PP
\fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIstr2_list\fP oldname,newname pairs such that newname replaces oldname for PFNs\&.
.br
\fIstr2bulk_list\fP List of failed updates\&. Each list datum is a \fBglobus_rls_string2_bulk_t\fP structure\&. \fBstr2\&.s1\fP will be the old PFN name, and \fBstr2\&.s2\fP the new PFN name, and \fBrc\fP will be the result code from the failed update\&. Only failed updates will be returned\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_rli_add\fP (\fBglobus_rls_handle_t\fP *h, char *rli_url, intflags, char *pattern)"
.PP
LRC servers send information about LFNs in their database to the the list of RLI servers in the database, added with the following function\&. Updates may be partitioned amongst multiple RLIs by specifying one or more patterns for an RLI\&.
.PP
\fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIrli_url\fP URL of RLI server that LRC should send updates to\&.
.br
\fIflags\fP Should be zero or \fBFRLI_BLOOMFILTER\fP\&.
.br
\fIpattern\fP If not NULL used to filter which LFNs are sent to \fIrli_url\fP\&. Standard Unix wildcard characters (*, ?) may be used to do wildcard matches\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP RLI (with pattern if not NULL) added to LRC database\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_rli_delete\fP (\fBglobus_rls_handle_t\fP *h, char *rli_url, char *pattern)"
.PP
Delete an entry from the LRC rli/partition tables\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIrli_url\fP URL of RLI server to remove from LRC partition table\&.
.br
\fIpattern\fP If not NULL then only the specific \fIrli_url/pattern\fP is removed, else all partition information for \fIrli_url\fP is removed\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP RLI and pattern (if specified) removed from LRC partition table\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_rli_get_part\fP (\fBglobus_rls_handle_t\fP *h, char *rli_url, char *pattern, globus_list_t **str2_list)"
.PP
Get RLI update partitions from LRC server\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIrli_url\fP If not NULL identifies RLI that partition data will be retrieved for\&. If NULL then all RLIs are retrieved\&.
.br
\fIpattern\fP If not NULL returns only partitions with matching patterns, otherwise all patterns are retrieved\&.
.br
\fIstr2_list\fP Results added to list\&. Datums in \fIstr2_list\fP are of type \fBglobus_rls_string2_t\fP structure\&. \fBs1\fP will be the rli url, \fBs2\fP an empty string or the pattern used to partition updates\&. See \fBQuery Results\fP\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Partition data retrieved from server, written to \fIstr2_list\fP\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_rli_info\fP (\fBglobus_rls_handle_t\fP *h, char *rli_url, \fBglobus_rls_rli_info_t\fP *info)"
.PP
Get info about RLI server updated by an LRC server\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIrli_url\fP URL of RLI server to retrieve info for\&.
.br
\fIinfo\fP Data about RLI server will be written here\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Info about RLI server successfully retrieved\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_lrc_rli_list\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t **rliinfo_list)"
.PP
Return URLs of RLIs that LRC sends updates to\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIrliinfo_list\fP List of RLIs updated by this LRC returned in this list\&. Each list datum is of type \fBglobus_rls_rli_info_t\fP\&. \fIrliinfo_list\fP should be freed with \fBglobus_rls_client_free_list()\fP when no longer needed\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP List of RLIs updated by this LRC returned in \fIrliinfo_list\fP\&. 
.RE
.PP

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