.\" @(#)$RCSfile: dpm_putx.man,v $ $Revision: 1.0 $ $Date: 2013/11/27 10:00:00 $ CERN IT-SDC/ID David Smith
.\" Copyright (C) 2004-2013 by CERN/IT/SDC/ID
.\" All rights reserved
.\"
.TH DPM_PUTX 3 "$Date: 2013/11/27 10:00:00 $" LCG "DPM Library Functions"
.SH NAME
dpm_putx \- make a set of existing files available for I/O
.SH SYNOPSIS
.B #include <sys/types.h>
.br
\fB#include "dpm_api.h"\fR
.sp
.BI "int dpm_putx (int " nbreqfiles ,
.BI "struct dpm_putfilereqx *" reqfiles ,
.BI "int " nbprotocols ,
.BI "char **" protocols ,
.BI "char *" u_token ,
.BI "int " overwrite ,
.BI "time_t " retrytime ,
.BI "char *" r_token ,
.BI "int *" nbreplies ,
.BI "struct dpm_putfilestatus **" filestatuses )
.SH DESCRIPTION
.B dpm_putx
makes a set of existing files available for I/O. Compared to dpm_put there is control over
the destination within the DPM available.
.LP
The input arguments are:
.TP
.I nbreqfiles
specifies the number of files belonging to the request.
.TP
.I reqfiles
specifies the array of file requests (dpm_putfilereqx structures).
.PP
.nf
.ft CW
struct dpm_putfilereqx {
	char		*to_surl;
	time_t	lifetime;
	time_t	f_lifetime;
	char		f_type;
	char		s_token[CA_MAXDPMTOKENLEN+1];
	char		ret_policy;
	char		ac_latency;
	u_signed64	requested_size;
	int		reserved; /* must be zero */
	char		server[CA_MAXHOSTNAMELEN+1];
	char		pfnhint[CA_MAXSFNLEN+1];
};
.ft
.fi
.TP
.I nbprotocols
specifies the number of protocols.
.TP
.I protocols
specifies the array of protocols.
.TP
.I u_token
specifies the user provided description associated with the request.
.TP
.I overwrite
if set to 1, it allows to overwrite an existing file.
.TP
.I retrytime
This field is currently ignored.
.LP
The output arguments are:
.TP
.I r_token
Address of a buffer to receive the system allocated token.
The buffer must be at least CA_MAXDPMTOKENLEN+1 characters long.
.TP
.I nbreplies
will be set to the number of replies in the array of file statuses.
.TP
.I filestatuses
will be set to the address of an array of dpm_putfilestatus structures allocated
by the API. The client application is responsible for freeing the array when not
needed anymore.
.PP
.nf
.ft CW
struct dpm_putfilestatus {
	char		*to_surl;
	char		*turl;
	u_signed64	filesize;
	int		status;
	char		*errstring;
	time_t	pintime;
	time_t	f_lifetime;
};
.ft
.fi
.SH RETURN VALUE
This routine returns 0 if the operation was successful or -1 if the operation
failed. In the latter case,
.B serrno
is set appropriately.
.SH ERRORS
.TP 1.3i
.B EFAULT
.IR reqfiles ,
.IR protocols ,
.IR r_token ,
.I nbreplies
or
.I filestatuses
is a NULL pointer.
.TP
.B ENOMEM
Memory could not be allocated for marshalling the request.
.TP
.B EINVAL
.I nbreqfiles
or
.I nbprotocols
is not strictly positive, the protocols are not supported, the length of the
user request description is greater than 255, reserved is not zero or all
file requests have errors.
.TP
.B SENOSHOST
Host unknown.
.TP
.B SEINTERNAL
Database error.
.TP
.B SECOMERR
Communication error.