← Back to branch summary

~ubuntu-branches/ubuntu/quantal/simgrid/quantal

« back to all changes in this revision

Viewing changes to doc/html/group__msg__file__management.html

  • Committer: Package Import Robot
  • Author(s): Lucas Nussbaum, Martin Quinson, Lucas Nussbaum
  • Date: 2012-06-09 16:24:44 UTC
  • mfrom: (10.1.4 sid)
  • Revision ID: package-import@ubuntu.com-20120609162444-xook34f3d6qy5ixj
Tags: 3.7.1-1
[ Martin Quinson ]
* debian/copyright: update FSF address (thanks lintian for noticing)

[ Lucas Nussbaum ]
* New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/group__msg__file__management.html
2
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
 
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
5
<title>SimGrid: File Management Functions</title>
7
 
 
8
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
9
 
<link href="doxygen.css" rel="stylesheet" type="text/css" />
10
 
 
11
 
 
12
 
 
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
13
8
<link href="simgrid.css" rel="stylesheet" type="text/css">
14
9
</head>
15
10
<body>
16
 
<div id="top"><!-- do not remove this div! -->
17
 
 
18
 
 
 
11
<!-- Generated by Doxygen 1.7.4 -->
 
12
<div id="top">
19
13
<div id="titlearea">
20
14
<table cellspacing="0" cellpadding="0">
21
15
 <tbody>
22
16
 <tr style="height: 56px;">
23
 
  
24
 
  
25
17
  <td style="padding-left: 0.5em;">
26
 
   <div id="projectname">SimGrid
27
 
   &#160;<span id="projectnumber">3.7</span>
28
 
   </div>
 
18
   <div id="projectname">SimGrid&#160;<span id="projectnumber">3.7.1</span></div>
29
19
   <div id="projectbrief">Scalable simulation of distributed systems</div>
30
20
  </td>
31
 
  
32
 
  
33
 
  
34
21
 </tr>
35
22
 </tbody>
36
23
</table>
37
24
</div>
38
 
 
39
 
<!-- Generated by Doxygen 1.7.6.1 -->
40
25
  <div id="navrow1" class="tabs">
41
26
    <ul class="tablist">
42
27
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
65
50
  <li> <a href="group__API__index.html"><span>Full Index</span></a></li>
66
51
  <li> <a href="group__XBT__API.html"><span>XBT</span></a></li>
67
52
  <li class="current"> <a href="group__MSG__API.html"><span>MSG</span></a></li>
 
53
  <li> <a href="group__SIMIX__API.html"><span>SIMIX</span></a></li>
68
54
  <li> <a href="group__GRAS__API.html"><span>GRAS</span></a></li>
69
55
  <li> <a href="group__AMOK__API.html"><span>AMOK</span></a></li>
70
56
  <li> <a href="group__SMPI__API.html"><span>SMPI</span></a></li>
97
83
<a href="#func-members">Functions</a>  </div>
98
84
  <div class="headertitle">
99
85
<div class="title">File Management Functions</div>  </div>
100
 
<div class="ingroups"><a class="el" href="group__MSG__API.html">MSG</a></div></div><!--header-->
 
86
<div class="ingroups"><a class="el" href="group__MSG__API.html">MSG</a></div></div>
101
87
<div class="contents">
102
88
 
103
89
<p>This section describes the file structure of MSG (<a class="el" href="group__msg__file__management.html#ga87e0d76d9428e822d9a67e676c8a2775" title="File datatype.You should consider this as an opaque object.">msg_file_t</a>) and the functions for managing it. It is based on POSIX functions.  
131
117
<div class="memproto">
132
118
      <table class="memname">
133
119
        <tr>
134
 
          <td class="memname">size_t <a class="el" href="group__msg__file__management.html#gaa50c476feb29279dcef94cfb9fd26767">MSG_file_read</a> </td>
 
120
          <td class="memname">size_t MSG_file_read </td>
135
121
          <td>(</td>
136
122
          <td class="paramtype">const char *&#160;</td>
137
123
          <td class="paramname"><em>storage</em>, </td>
170
156
<div class="memdoc">
171
157
 
172
158
<p>Read elements of a file. </p>
173
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
159
<dl><dt><b>Parameters:</b></dt><dd>
174
160
  <table class="params">
175
161
    <tr><td class="paramname">storage</td><td>is the name where find the stream </td></tr>
176
162
    <tr><td class="paramname">ptr</td><td>buffer to where the data is copied </td></tr>
189
175
<div class="memproto">
190
176
      <table class="memname">
191
177
        <tr>
192
 
          <td class="memname">size_t <a class="el" href="group__msg__file__management.html#ga4c1bc277cdba7e197dfe8981de92f882">MSG_file_write</a> </td>
 
178
          <td class="memname">size_t MSG_file_write </td>
193
179
          <td>(</td>
194
180
          <td class="paramtype">const char *&#160;</td>
195
181
          <td class="paramname"><em>storage</em>, </td>
228
214
<div class="memdoc">
229
215
 
230
216
<p>Write elements into a file. </p>
231
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
217
<dl><dt><b>Parameters:</b></dt><dd>
232
218
  <table class="params">
233
219
    <tr><td class="paramname">storage</td><td>is the name where find the stream </td></tr>
234
220
    <tr><td class="paramname">ptr</td><td>buffer from where the data is copied </td></tr>
247
233
<div class="memproto">
248
234
      <table class="memname">
249
235
        <tr>
250
 
          <td class="memname"><a class="el" href="group__msg__file__management.html#ga87e0d76d9428e822d9a67e676c8a2775">msg_file_t</a> <a class="el" href="group__msg__file__management.html#ga9a75874749af8607e52304d1750306c7">MSG_file_open</a> </td>
 
236
          <td class="memname"><a class="el" href="group__msg__file__management.html#ga87e0d76d9428e822d9a67e676c8a2775">msg_file_t</a> MSG_file_open </td>
251
237
          <td>(</td>
252
238
          <td class="paramtype">const char *&#160;</td>
253
239
          <td class="paramname"><em>storage</em>, </td>
274
260
<div class="memdoc">
275
261
 
276
262
<p>Opens the file whose name is the string pointed to by path. </p>
277
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
263
<dl><dt><b>Parameters:</b></dt><dd>
278
264
  <table class="params">
279
265
    <tr><td class="paramname">storage</td><td>is the name where find the file to open </td></tr>
280
266
    <tr><td class="paramname">path</td><td>is the file location on the storage </td></tr>
291
277
<div class="memproto">
292
278
      <table class="memname">
293
279
        <tr>
294
 
          <td class="memname">int <a class="el" href="group__msg__file__management.html#gac8c3a9437d079a3945d43c35beaac169">MSG_file_close</a> </td>
 
280
          <td class="memname">int MSG_file_close </td>
295
281
          <td>(</td>
296
282
          <td class="paramtype">const char *&#160;</td>
297
283
          <td class="paramname"><em>storage</em>, </td>
312
298
<div class="memdoc">
313
299
 
314
300
<p>Close the file. </p>
315
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
301
<dl><dt><b>Parameters:</b></dt><dd>
316
302
  <table class="params">
317
303
    <tr><td class="paramname">storage</td><td>is the name where find the stream </td></tr>
318
304
    <tr><td class="paramname">fp</td><td>is the file to close </td></tr>
328
314
<div class="memproto">
329
315
      <table class="memname">
330
316
        <tr>
331
 
          <td class="memname">int <a class="el" href="group__msg__file__management.html#ga99e20b217dd3e8efafc8b48792c24654">MSG_file_stat</a> </td>
 
317
          <td class="memname">int MSG_file_stat </td>
332
318
          <td>(</td>
333
319
          <td class="paramtype">const char *&#160;</td>
334
320
          <td class="paramname"><em>storage</em>, </td>
355
341
<div class="memdoc">
356
342
 
357
343
<p>Stats the file pointed by fd. </p>
358
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
344
<dl><dt><b>Parameters:</b></dt><dd>
359
345
  <table class="params">
360
346
    <tr><td class="paramname">storage</td><td>is the name where find the stream </td></tr>
361
347
    <tr><td class="paramname">fd</td><td>is the file descriptor (<a class="el" href="group__msg__file__management.html#ga87e0d76d9428e822d9a67e676c8a2775" title="File datatype.You should consider this as an opaque object.">msg_file_t</a>) </td></tr>
367
353
 
368
354
</div>
369
355
</div>
370
 
</div><!-- contents -->
 
356
</div>
371
357
<p>
372
358
<hr>
373
359
 
378
364
Back to the main Simgrid Documentation page</b></a>
379
365
</td>
380
366
<td align=middle>
381
 
<small>The version of <a href="http://simgrid.gforge.inria.fr">SimGrid</a> documented here is v3.7.<br/>
 
367
<small>The version of <a href="http://simgrid.gforge.inria.fr">SimGrid</a> documented here is v3.7.1.<br/>
382
368
Documentation of other versions can be found in their respective
383
369
archive files (directory doc/html).
384
370
</td>