source: trunk/libtransmission/platform.h @ 10633

Last change on this file since 10633 was 10633, checked in by charles, 11 years ago

(trunk libT) tweak MAX_PATH_LENGTH a little for better portability -- defer to limits.h's definition when present

  • Property svn:keywords set to Date Rev Author Id
File size: 2.5 KB
Line 
1/*
2 * This file Copyright (C) 2009-2010 Mnemosyne LLC
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: platform.h 10633 2010-05-06 15:07:18Z charles $
11 */
12
13#ifndef __TRANSMISSION__
14 #error only libtransmission should #include this header.
15#endif
16
17#ifndef TR_PLATFORM_H
18#define TR_PLATFORM_H
19
20#if defined( WIN32 )
21 #define TR_PATH_DELIMITER '\\'
22 #define TR_PATH_DELIMITER_STR "\\"
23#else
24 #define TR_PATH_DELIMITER '/'
25 #define TR_PATH_DELIMITER_STR "/"
26#endif
27
28#ifdef WIN32
29 #include <windows.h> /* MAX_PATH */
30#else
31 #include <limits.h> /* MAX_PATH */
32#endif
33#ifdef MAX_PATH
34 #define TR_MAX_PATH MAX_PATH
35#else
36 #define TR_MAX_PATH 4096
37#endif
38
39/**
40 * @addtogroup tr_session Session
41 * @{
42 */
43
44/**
45 * @brief invoked by tr_sessionInit() to set up the locations of the resume, torrent, and clutch directories.
46 * @see tr_getResumeDir()
47 * @see tr_getTorrentDir()
48 * @see tr_getWebClientDir()
49 */
50void tr_setConfigDir( tr_session * session, const char * configDir );
51
52/** @brief return the directory where .resume files are stored */
53const char * tr_getResumeDir( const tr_session * );
54
55/** @brief return the directory where .torrent files are stored */
56const char * tr_getTorrentDir( const tr_session * );
57
58/** @brief return the directory where the Web Client's web ui files are kept */
59const char * tr_getWebClientDir( const tr_session * );
60
61/** @} */
62
63
64/**
65 * @addtogroup utils Utilities
66 * @{
67 */
68
69typedef struct tr_thread tr_thread;
70
71/** @brief Instantiate a new process thread */
72tr_thread* tr_threadNew( void ( *func )(void *), void * arg );
73
74/** @brief Return nonzero if this function is being called from `thread'
75    @param thread the thread being tested */
76int tr_amInThread( const tr_thread * );
77
78/***
79****
80***/
81
82typedef struct tr_lock tr_lock;
83
84/** @brief Create a new thread mutex object */
85tr_lock * tr_lockNew( void );
86
87/** @brief Destroy a thread mutex object */
88void tr_lockFree( tr_lock * );
89
90/** @brief Attempt to lock a thread mutex object */
91void tr_lockLock( tr_lock * );
92
93/** @brief Unlock a thread mutex object */
94void tr_lockUnlock( tr_lock * );
95
96/** @brief return nonzero if the specified lock is locked */
97int tr_lockHave( const tr_lock * );
98
99#ifdef WIN32
100void * mmap( void *ptr, long  size, long  prot, long  type, long  handle, long  arg );
101
102long munmap( void *ptr, long  size );
103#endif
104
105/* @} */
106
107#endif
Note: See TracBrowser for help on using the repository browser.