mirror of
https://github.com/transmission/transmission
synced 2024-12-29 19:16:23 +00:00
dadffa2c0f
This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
57 lines
1.3 KiB
C
57 lines
1.3 KiB
C
/*
|
|
* This file Copyright (C) 2016 Mnemosyne LLC
|
|
*
|
|
* It may be used under the GNU GPL versions 2 or 3
|
|
* or any future license endorsed by Mnemosyne LLC.
|
|
*
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
typedef struct tr_session_id* tr_session_id_t;
|
|
|
|
/**
|
|
* Create new session identifier object.
|
|
*
|
|
* @return New session identifier object.
|
|
*/
|
|
tr_session_id_t tr_session_id_new(void);
|
|
|
|
/**
|
|
* Free session identifier object.
|
|
*
|
|
* @param[in] session_id Session identifier object.
|
|
*/
|
|
void tr_session_id_free(tr_session_id_t session_id);
|
|
|
|
/**
|
|
* Get current session identifier as string.
|
|
*
|
|
* @param[in] session_id Session identifier object.
|
|
*
|
|
* @return String representation of current session identifier.
|
|
*/
|
|
char const* tr_session_id_get_current(tr_session_id_t session_id);
|
|
|
|
/**
|
|
* Check if session ID corresponds to session running on the same machine as
|
|
* the caller.
|
|
*
|
|
* This is useful for various behavior alterations, such as transforming
|
|
* relative paths to absolute before passing through RPC, or presenting
|
|
* different UI for local and remote sessions.
|
|
*
|
|
* @param[in] session_id String representation of session identifier object.
|
|
*
|
|
* @return `True` if session is valid and local, `false` otherwise.
|
|
*/
|
|
bool tr_session_id_is_local(char const* session_id);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|