1
0
Fork 0
mirror of https://github.com/transmission/transmission synced 2024-12-26 09:37:56 +00:00
transmission/libtransmission/platform.h
Jordan Lee 879a2afcbd Update the copyright year in the source code comments.
The Berne Convention says that the copyright year is moot, so instead of adding another year to each file as in previous years, I've removed the year altogether from the source code comments in libtransmission, gtk, qt, utils, daemon, and cli.

Juliusz's copyright notice in tr-dht and Johannes' copyright notice in tr-lpd have been left alone; it didn't seem appropriate to modify them.
2011-01-19 13:48:47 +00:00

107 lines
2.6 KiB
C

/*
* This file Copyright (C) Mnemosyne LLC
*
* This file is licensed by the GPL version 2. Works owned by the
* Transmission project are granted a special exemption to clause 2(b)
* so that the bulk of its code can remain under the MIT license.
* This exemption does not extend to derived works not owned by
* the Transmission project.
*
* $Id$
*/
#ifndef __TRANSMISSION__
#error only libtransmission should #include this header.
#endif
#ifndef TR_PLATFORM_H
#define TR_PLATFORM_H
#define TR_PATH_DELIMITER '/'
#define TR_PATH_DELIMITER_STR "/"
#ifdef WIN32
#include <windef.h> /* MAX_PATH */
#define TR_PATH_MAX (MAX_PATH + 1)
#else
#include <limits.h> /* PATH_MAX */
#ifdef PATH_MAX
#define TR_PATH_MAX PATH_MAX
#else
#define TR_PATH_MAX 4096
#endif
#endif
/**
* @addtogroup tr_session Session
* @{
*/
/**
* @brief invoked by tr_sessionInit() to set up the locations of the resume, torrent, and clutch directories.
* @see tr_getResumeDir()
* @see tr_getTorrentDir()
* @see tr_getWebClientDir()
*/
void tr_setConfigDir( tr_session * session, const char * configDir );
/** @brief return the directory where .resume files are stored */
const char * tr_getResumeDir( const tr_session * );
/** @brief return the directory where .torrent files are stored */
const char * tr_getTorrentDir( const tr_session * );
/** @brief return the directory where the Web Client's web ui files are kept */
const char * tr_getWebClientDir( const tr_session * );
/** @brief return the number of bytes available for use in the specified path, or -1 on error */
int64_t tr_getFreeSpace( const char * path );
/** @} */
/**
* @addtogroup utils Utilities
* @{
*/
typedef struct tr_thread tr_thread;
/** @brief Instantiate a new process thread */
tr_thread* tr_threadNew( void ( *func )(void *), void * arg );
/** @brief Return nonzero if this function is being called from `thread'
@param thread the thread being tested */
tr_bool tr_amInThread( const tr_thread * );
/***
****
***/
typedef struct tr_lock tr_lock;
/** @brief Create a new thread mutex object */
tr_lock * tr_lockNew( void );
/** @brief Destroy a thread mutex object */
void tr_lockFree( tr_lock * );
/** @brief Attempt to lock a thread mutex object */
void tr_lockLock( tr_lock * );
/** @brief Unlock a thread mutex object */
void tr_lockUnlock( tr_lock * );
/** @brief return nonzero if the specified lock is locked */
int tr_lockHave( const tr_lock * );
#ifdef WIN32
void * mmap( void *ptr, long size, long prot, long type, long handle, long arg );
long munmap( void *ptr, long size );
#endif
/* @} */
#endif