dpns_listreplicax(3) [debian man page]

DPNS_LISTREPLICAX(3)					      DPNS Library Functions					      DPNS_LISTREPLICAX(3)

NAME

       dpns_listreplicax - list replica entries for a given pool/server/filesystem

SYNOPSIS

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

       struct dpns_filereplica *dpns_listreplicax (const char *poolname, const char *server, const char *fs, int flags, dpns_list *listp)

DESCRIPTION

       dpns_listreplicax  lists  replica entries for a given pool/server/filesystem.  This routine returns a pointer to a structure containing the
       current replica entry.

       struct dpns_filereplica {
	    u_signed64	   fileid;
	    u_signed64	   nbaccesses;
	    time_t	   atime;	  /* last access to replica */
	    time_t	   ptime;	  /* replica pin time */
	    char      status;
	    char      f_type;	     /* 'V' for Volatile, 'P' for Permanent */
	    char      poolname[CA_MAXPOOLNAMELEN+1];
	    char      host[CA_MAXHOSTNAMELEN+1];
	    char      fs[80];
	    char      sfn[CA_MAXSFNLEN+1];
       };

       poolname
	      specifies the disk pool (only meaningful for the DPM).

       server specifies the Storage Element or disk server hostname.

       fs     specifies the file system (only meaningful for the DPM).

       flags  may be one of the following constant:

	      CNS_LIST_BEGIN
		     the first call must have this flag set to allocate buffers and initialize pointers.

	      CNS_LIST_CONTINUE
		     all the following calls must have this flag set.

	      CNS_LIST_END
		     final call to terminate the list and free resources.

RETURN VALUE

       This routine returns a pointer to a structure containing the current replica entry if the operation was successful or NULL if  all  entries
       have been returned or if the operation failed. In the latter case, serrno is set appropriately.

EXAMPLES

       A C program listing the files residing on a given server could look like:

	    int flags;
	    dpns_list list;
	    struct dpns_filereplica *lp;

	    flags = CNS_LIST_BEGIN;
	    while ((lp = dpns_listreplicax (NULL, server, NULL, flags, &list))) {
		 flags = CNS_LIST_CONTINUE;
		 /* process the entry */
		 .....
	    }
	    (void) dpns_listreplicax (NULL, server, NULL, CNS_LIST_END, &list);

ERRORS

       ENOMEM	    Memory could not be allocated for the output buffer.

       EFAULT	    poolname, server and fs are NULL pointers or listp is a NULL pointer.

       EINVAL	    The length of poolname exceeds CA_MAXPOOLNAMELEN or the length of server exceeds CA_MAXHOSTNAMELEN or the length of fs exceeds
		    79.

       SENOSHOST    Host unknown.

       SENOSSERV    Service unknown.

       SECOMERR     Communication error.

       ENSNACT	    Name server is not running or is being shutdown.

SEE ALSO

       Castor_limits(4), dpns_addreplica(3)

DPNS
							   $Date: 2005/07/21 08:31:48 $ 				      DPNS_LISTREPLICAX(3)

DPNS_ADDREPLICA(3)					      DPNS Library Functions						DPNS_ADDREPLICA(3)

NAME

       dpns_addreplica - add a replica for a given file

SYNOPSIS

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

       int  dpns_addreplica  (const  char  *guid, struct dpns_fileid *file_uniqueid, const char *server, const char *sfn, const char status, const
       char f_type, const char *poolname, const char *fs)

       int dpns_addreplicax (const char *guid, struct dpns_fileid *file_uniqueid, const char *server, const char *sfn, const  char  status,  const
       char f_type, const char *poolname, const char *fs, const char r_type, const char *setname)

DESCRIPTION

       dpns_addreplica	adds a replica for a given file.  The file can be specified by guid or by file_uniqueid.  If both are given, file_uniqueid
       is used.

       guid   specifies the Grid Unique IDentifier.

       server is either the Storage Element fully qualified hostname or the disk server.

       sfn    is either the Site URL or the Physical File Name for the replica.

       status can be set to

	      -      file is available

	      P      file is being populated

	      D      file is being deleted.

       f_type may be one of the following:

	      V      Volatile

	      D      Durable

	      P      Permanent.

       poolname
	      specifies the disk pool name (this argument is only meaningful for the Disk Pool Manager).

       fs     specifies the mount point of the dedicated filesystem (this argument is only meaningful for the Disk Pool Manager).

       r_type may be one of the following:

	      P      Primary

	      S      Secondary.

       setname
	      is either the replica set name or the space token.

RETURN VALUE

       This routine returns 0 if the operation was successful or -1 if the operation failed. In the latter case, serrno is set appropriately.

ERRORS

       ENOENT	    The named file does not exist.

       EACCES	    Search permission is denied on a component of the parent directory or the effective user ID does not match the  owner  of  the
		    file or read permission on the file entry itself is denied.

       EFAULT	    guid and file_uniqueid are NULL pointers or server or sfn is a NULL pointer.

       EEXIST	    The sfn exists already.

       EISDIR	    The file is not a regular file.

       EINVAL	    The  length  of  guid  exceeds  CA_MAXGUIDLEN,  the length of server exceeds CA_MAXHOSTNAMELEN, the length of poolname exceeds
		    CA_MAXPOOLNAMELEN or the length of fs exceeds 79 or setname exceeds 36.

       ENAMETOOLONG The length of sfn exceeds CA_MAXSFNLEN.

       SENOSHOST    Host unknown.

       SENOSSERV    Service unknown.

       SECOMERR     Communication error.

       ENSNACT	    Name server is not running or is being shutdown.

SEE ALSO

       Castor_limits(4), dpns_delreplica(3), dpns_listreplica(3)

DPNS
							   $Date: 2006/12/01 09:19:37 $ 					DPNS_ADDREPLICA(3)