source: trunk/libtransmission/fdlimit.h @ 1356

Last change on this file since 1356 was 1356, checked in by titer, 15 years ago

Merge io branch into trunk

  • Property svn:keywords set to Date Rev Author Id
File size: 3.9 KB
Line 
1/******************************************************************************
2 * $Id: fdlimit.h 1356 2007-01-14 12:00:21Z titer $
3 *
4 * Copyright (c) 2005-2006 Transmission authors and contributors
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *****************************************************************************/
24
25typedef struct tr_fd_s tr_fd_t;
26
27/***********************************************************************
28 * tr_fdInit
29 ***********************************************************************
30 * Detect the maximum number of open files and initializes things.
31 **********************************************************************/
32tr_fd_t * tr_fdInit();
33
34/***********************************************************************
35 * tr_fdFileOpen
36 ***********************************************************************
37 * If it isn't open already, tries to open the file 'name' in the
38 * directory 'folder'. If 'name' itself contains '/'s, required
39 * subfolders are created. The file is open read-write if 'write' is 1
40 * (created if necessary), read-only if 0.
41 * Returns the file descriptor if successful, otherwise returns
42 * one of the TR_ERROR_IO_*.
43 **********************************************************************/
44int tr_fdFileOpen( tr_fd_t *, char * folder, char * name, int write );
45
46/***********************************************************************
47 * tr_fdFileRelease
48 ***********************************************************************
49 * Indicates that the file whose descriptor is 'file' is unused at the
50 * moment and can safely be closed.
51 **********************************************************************/
52void tr_fdFileRelease( tr_fd_t *, int file );
53
54/***********************************************************************
55 * tr_fdFileClose
56 ***********************************************************************
57 * If the file 'name' in directory 'folder' was open, closes it,
58 * flushing data on disk.
59 **********************************************************************/
60void tr_fdFileClose( tr_fd_t *, char * folder, char * name );
61
62/***********************************************************************
63 * tr_fdSocketWillCreate
64 ***********************************************************************
65 *
66 **********************************************************************/
67int tr_fdSocketWillCreate( tr_fd_t *, int );
68
69/***********************************************************************
70 * tr_fdSocketClosed
71 ***********************************************************************
72 *
73 **********************************************************************/
74void tr_fdSocketClosed( tr_fd_t *, int );
75
76
77/***********************************************************************
78 * tr_fdClose
79 ***********************************************************************
80 * Frees resources allocated by tr_fdInit.
81 **********************************************************************/
82void tr_fdClose( tr_fd_t * );
Note: See TracBrowser for help on using the repository browser.