Scroll to navigation

DPNS_READDIRXR(3) DPNS Library Functions DPNS_READDIRXR(3)

NAME

dpns_readdirxr - read DPNS directory opened by dpns_opendir in the name server

SYNOPSIS

#include <sys/types.h>
#include "dpns_api.h"

struct dpns_direnrep *dpns_readdirxr (dpns_DIR *dirp, char *se)

DESCRIPTION

dpns_readdirxr reads the DPNS directory opened by dpns_opendir in the name server. This routine returns a pointer to a structure containing the current directory entry (basename, guid and filesize) and the replica information.

struct dpns_rep_info {
	u_signed64	fileid;
	char		status;
	char		*host;
	char		*sfn;
};
struct dpns_direnrep {
	u_signed64	fileid;
	char		guid[CA_MAXGUIDLEN+1];
	mode_t		filemode;
	u_signed64	filesize;
	int		nbreplicas;
	struct dpns_rep_info *rep;	/* array of replica info structures */
	unsigned short	d_reclen;	/* length of this entry */
	char		d_name[1];	/* basename in variable length */
};

dpns_readdirxr caches a variable number of such entries, depending on the filename size, to minimize the number of requests to the name server.

specifies the pointer value returned by dpns_opendir.
allows to restrict the replica entries to a given SE.

RETURN VALUE

This routine returns a pointer to a structure containing the current directory entry if the operation was successful or NULL if the end of the directory was reached or if the operation failed. When the end of the directory is encountered, serrno is not changed. If the operation failed, serrno is set appropriately.

As dpns_readdirxr returns a null pointer both at the end of the directory and on error, an application wishing to check for error situations should set serrno to 0, then call dpns_readdirxr, then check serrno and if it is non-zero, assume an error has occurred.

ERRORS

File descriptor in DIR structure is invalid.
Memory could not be allocated for unmarshalling the reply.
dirp is a NULL pointer.
The length of se exceeds CA_MAXHOSTNAMELEN.
Communication error.
Name server is not running or is being shutdown.

SEE ALSO

dpns_closedir(3), dpns_opendir(3), dpns_rewinddir(3)

AUTHOR

LCG Grid Deployment Team

$Date$ DPNS