1RFIOSETOPT(3) Rfio Library Functions
2RFIOSETOPT(3)
3[1mNAME[0m
7 rfiosetopt ‐ set RFIO options
8[1mSYNOPSIS[0m
10 [1m#include <sys/types.h>[0m
11 [1m#include "rfio_api.h"[0m
12 [1mint rfiosetopt (int [4m[22mopt[24m[1m, int *[4m[22mp‐
14val[24m[1m, int [4m[22mlen[24m[1m)[0m
15 [1mint rfio_setbufsize (int [4m[22ms[24m[1m, int
17[4m[22mbufsize[24m[1m)[0m
18[1mDESCRIPTION[0m
20 [1mrfiosetopt [22msets the RFIO option [4mopt[24m to the
21content of the memory cell
22 pointed by [4mpval[24m.
23 [1mrfio_setbufsize [22msets the size of the readahead buf‐
25fer to be used on a
26 particular socket connection.
27 [4mopt[24m can have on of the following values:
29 [1mRFIO_READOPT[0m
31 The value pointed by pval can be 0,
32RFIO_READBUF,
33 RFIO_READAHEAD or RFIO_STREAM (V3).
34 If set to zero, a normal read will be used
36(one request
37 to the server per read).
38 If set to RFIO_READBUF, an internal buffer
40is allocated
41 in the client API, each call to the server
42fills this
43 buffer and the user buffer is filled from
44the internal
45 buffer. There is one server call per buffer
46fill.
47 If set to RFIO_READAHEAD, an initial call is
49sent to the
50 server which pushes data to the client
51buffer until end
52 of file is reached or an error occurs or a
53new request
54 comes from the client. There is no inter‐
55mediate buffer
56 unless RFIO_READBUF|RFIO_READAHEAD is speci‐
57fied.
58 If RFIO_STREAM is set, the V3 protocol is
60enabled. This
61 uses 2 socket connections between the
62client and the
63 server and the server itself is multi‐
64threaded allowing
65 overlap of disk and network operations.
66The data is
67 pushed on the data socket until end of file
68is reached or
69 an error occurs. The transfer can be inter‐
70rupted by send‐
71 ing a packet on the control socket.
72 Default is RFIO_READBUF.
73 The default internal buffer size is 128kB,
75but the buffer
76 size can be set with an entry RFIO
77IOBUFSIZE in
78 [1mshift.conf [22mor thru the environment
79variable RFIO_IOBUF‐
80 SIZE.
81 [1mRFIO_NETOPT[0m
83 The value pointed by pval can be RFIO_NONET
84or RFIO_NET.
85 If set to RFIO_NONET, the NET entries in
86[1mshift.conf [22mare
87 ignored. Default is RFIO_NET.
88 [1mRFIO_NETRETRYOPT[0m
90 The value pointed by pval can be
91RFIO_RETRYIT or
92 RFIO_NOTIME2RETRY.
93 If set to RFIO_RETRYIT, there will be re‐
95tries on failing
96 connect. The number of retries is given by
97the environ‐
98 ment variable RFIO_CONRETRY or the RFIO CON‐
99RETRY entry in
100 [1mshift.conf[22m. The retry interval (in
101seconds) is given by
102 the environment variable RFIO_CONRETRYINT
103or the RFIO
104 CONRETRYINT entry.
105 If set to RFIO_NOTIME2RETRY, there will
107be no retry on
108 failing connect.
109 Default is RFIO_RETRYIT.
110 [1mRFIO_CONNECTOPT[0m
112 The value pointed by pval can be
113RFIO_NOLOCAL or
114 RFIO_FORCELOCAL. If set to RFIO_FORCELO‐
115CAL, no parsing
116 is done on pathname. The file is assumed
117to be local.
118 Default is RFIO_NOLOCAL.
119 The [4mlen[24m argument is ignored.
121 [4ms[24m is the file descriptor of the receiving socket.
123 [4mbufsize[24m is the size of the readahead buffer to be
125used.
126[1mRETURN VALUE[0m
128 [1mrfiosetopt [22mreturns 0 if the operation was success‐
129ful or ‐1 if the oper‐
130 ation failed. In the latter case, [1mserrno [22mis set
131appropriately.
132[1mERRORS[0m
134 [1mENOMEM [22mbuffer could not be allocated.
135 [1mEINVAL [4m[22mopt[24m is not a valid option,
137[4mbufsize[24m is negative or the user
138 tries to change the buffer size after the
139actual I/O has
140 started.
141[1mSEE ALSO[0m
143 [1mrfio_open(3)[22m, [1mrfioreadopt(3)[0m
144[1mAUTHOR[0m
146 [1mLCG Grid Deployment [22mTeam
147LCG $Date$
151RFIOSETOPT(3)
152