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

.in +1c
.ti -1c
.RI "struct \fBglobus_rls_sender_info_t\fP"
.br
.RI "\fIInformation about server sending updates to an rli, returned by \fBglobus_rls_client_rli_sender_list()\fP\&. \fP"
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_rli_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_rli_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_rli_get_lrc\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_rli_get_lrc_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_rli_get_lrc_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_rli_sender_list\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t **senderinfo_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_rli_lrc_list\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t **lrcinfo_list)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_rli_mapping_exists\fP (\fBglobus_rls_handle_t\fP *h, char *lfn, char *lrc)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_rli_rli_add\fP (\fBglobus_rls_handle_t\fP *h, char *rli_url, char *pattern)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_rli_rli_delete\fP (\fBglobus_rls_handle_t\fP *h, char *rli_url, char *pattern)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_rls_client_rli_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_rli_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 RLI server\&. 
.SH "Function Documentation"
.PP 
.SS "globus_result_t \fBglobus_rls_client_rli_exists\fP (\fBglobus_rls_handle_t\fP *h, char *key, \fBglobus_rls_obj_type_t\fPobjtype)"
.PP
Check if an object exists in the RLI database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIkey\fP LFN or LRC that identifies object\&.
.br
\fIobjtype\fP Type of object \fIkey\fP refers to (\fBglobus_rls_obj_rli_lfn\fP or \fBglobus_rls_obj_rli_lrc\fP)\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Object exists\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_rli_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 RLI database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIkeylist\fP LFNs or LRCs that identify objects\&.
.br
\fIobjtype\fP Type of object \fIkey\fP refers to (\fBglobus_rls_obj_rli_lfn\fP or \fBglobus_rls_obj_rli_lrc\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 LRC, and \fBstr2\&.s2\fP empty, and \fBrc\fP will be the result code indicating existence\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_rli_get_lrc\fP (\fBglobus_rls_handle_t\fP *h, char *lfn, int *offset, intreslimit, globus_list_t **str2_list)"
.PP
Return LRCs mapped to LFN in the RLI database\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIlfn\fP LFN whose list of LRCs is desired\&.
.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 LRCs that \fIlfn\fP maps to\&. Each list datum will be a \fBglobus_rls_string2_t\fP structure\&. \fBs1\fP will be the LFN, and \fBs2\fP the LRC it maps to\&. \fIstr2_list\fP should be freed with \fBglobus_rls_client_free_list()\fP\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP List of LRCs that map to \fIlfn\fP in \fIstr2_list\fP\&. See \fBQuery Results\fP\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_rli_get_lrc_bulk\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t *lfnlist, globus_list_t **str2bulk_list)"
.PP
Bulk return LRCs mapped to LFN in the RLI 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 LRC it maps to, and \fBrc\fP will be the result code from the query\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_rli_get_lrc_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 LRCs mapped to wildcarded LFN in the RLI 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 LRCs that map to \fIlfn_pattern\fP\&. Each list datum will be a \fBglobus_rls_string2_t\fP\&. \fBs1\fP will be the LFN, and \fBs2\fP the LRC it maps to\&. \fIstr2_list\fP should be freed with \fBglobus_rls_client_free_list()\fP\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP List of LRCs that map to \fIlfn_pattern\fP in \fIstr2_list\fP\&. See \fBQuery Results\fP\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_rli_sender_list\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t **senderinfo_list)"
.PP
Get list of servers updating this RLI server\&. Similar to globus_rls_client_rli_get_part() except no partition information is returned\&.
.PP
\fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIsenderinfo_list\fP Datums in senderinfo_list will be of type \fBglobus_rls_sender_info_t\fP\&. \fIsenderinfo_list\fP should be freed with \fBglobus_rls_client_free_list()\fP\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP List of LRCs updating RLI added to \fIsenderinfo_list\fP\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_rli_lrc_list\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t **lrcinfo_list)"
.PP
Deprecated, use \fBglobus_rls_client_rli_sender_list()\fP\&. \fBParameters:\fP
.RS 4
\fIh\fP Handle connected to an RLS server\&.
.br
\fIlrcinfo_list\fP Datums in lrcinfo_list will be of type globus_rls_lrc_info_t\&. \fIlrcinfo_list\fP should be freed with \fBglobus_rls_client_free_list()\fP\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIGLOBUS_SUCCESS\fP List of LRCs updating RLI added to \fIlrcinfo_list\fP\&. 
.RE
.PP

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

.SS "globus_result_t \fBglobus_rls_client_rli_rli_add\fP (\fBglobus_rls_handle_t\fP *h, char *rli_url, char *pattern)"
.PP
RLI 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
\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 RLI database\&. 
.RE
.PP

.SS "globus_result_t \fBglobus_rls_client_rli_rli_delete\fP (\fBglobus_rls_handle_t\fP *h, char *rli_url, char *pattern)"
.PP
Delete an entry from the RLI 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 RLI 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_rli_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 RLI 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_rli_rli_list\fP (\fBglobus_rls_handle_t\fP *h, globus_list_t **rliinfo_list)"
.PP
Return URLs of RLIs that RLI 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 RLI 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\&.