File: dpm_putdone.man

package info (click to toggle)
dpm-postgres 1.7.4.7-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 13,788 kB
  • ctags: 10,782
  • sloc: ansic: 146,136; sh: 13,362; perl: 11,142; python: 5,529; cpp: 5,113; sql: 1,790; makefile: 955; fortran: 113
file content (82 lines) | stat: -rw-r--r-- 1,798 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
.\" @(#)$RCSfile: dpm_putdone.man,v $ $Revision: 1.2 $ $Date: 2006/02/17 06:47:32 $ CERN IT-GD/CT Jean-Philippe Baud
.\" Copyright (C) 2004-2006 by CERN/IT/GD/CT
.\" All rights reserved
.\"
.TH DPM_PUTDONE 3 "$Date: 2006/02/17 06:47:32 $" LCG "DPM Library Functions"
.SH NAME
dpm_putdone \- mark a set of files as complete
.SH SYNOPSIS
.B #include <sys/types.h>
.br
\fB#include "dpm_api.h"\fR
.sp
.BI "int dpm_putdone (char *" r_token ,
.BI "int " nbsurls ,
.BI "char **" surls ,
.BI "int *" nbreplies ,
.BI "struct dpm_filestatus **" filestatuses )
.SH DESCRIPTION
.B dpm_putdone
marks a set of files as complete.
.LP
The input arguments are:
.TP
.I r_token
specifies the token returned by a previous put request.
.TP
.I nbsurls
specifies the number of files belonging to the request.
.TP
.I surls
specifies the array of file names.
.LP
The output arguments are:
.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_filestatus structures allocated
by the API. The client application is responsible for freeing the array when not
needed anymore.
.PP
.nf
.ft CW
struct dpm_filestatus {
	char		*surl;
	int		status;
	char		*errstring;
};
.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 r_token ,
.IR surls ,
.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 nbsurls
is not strictly positive, the token is too long or not known or
all file requests have errors.
.TP
.B SENOSHOST
Host unknown.
.TP
.B SEINTERNAL
Database error.
.TP
.B SECOMERR
Communication error.