transmission/libtransmission/rpcimpl.h

/*
 * This file Copyright (C) 2008-2014 Mnemosyne LLC
 *
 * It may be used under the GNU GPL versions 2 or 3
 * or any future license endorsed by Mnemosyne LLC.
 *
 * $Id$
 */

#ifndef TR_RPC_H
#define TR_RPC_H

#ifdef __cplusplus
extern "C" {
#endif

#include "transmission.h"
#include "variant.h"

/***
****  RPC processing
***/

typedef void (*tr_rpc_response_func)(tr_session * session,
                                     tr_variant * response,
                                     void       * user_data);

/* http://www.json.org/ */
void tr_rpc_request_exec_json (tr_session            * session,
                               const tr_variant      * request,
                               tr_rpc_response_func    callback,
                               void                  * callback_user_data);

/* see the RPC spec's "Request URI Notation" section */
void tr_rpc_request_exec_uri (tr_session           * session,
                              const void           * request_uri,
                              size_t                 request_uri_len,
                              tr_rpc_response_func   callback,
                              void                 * callback_user_data);

void tr_rpc_parse_list_str (tr_variant  * setme,
                            const char  * list_str,
                            size_t        list_str_len);

#ifdef __cplusplus
}
#endif

#endif /* TR_RPC_H */
partial implementation of json-ipc backend: torrent start/stop/close/verify/stat/info, as are getting & setting per-torrent peer limits, upload speeds, and download speeds. this is a work in progress. 2008-05-12 00:41:55 +00:00			`/*`
Licensing changes: 1. add the option the code to be used under GPLv2 or GPLv3; previously only GPLv2 was allowed 2. add the "proxy option" as described in GPLv3 so we can add future licenses without having to bulk-edit everything again :) 3. remove the awkward "exception for MIT code in Mac client" clause; it was unnecessary and confusing. 2014-01-19 01:09:44 +00:00			`* This file Copyright (C) 2008-2014 Mnemosyne LLC`
partial implementation of json-ipc backend: torrent start/stop/close/verify/stat/info, as are getting & setting per-torrent peer limits, upload speeds, and download speeds. this is a work in progress. 2008-05-12 00:41:55 +00:00			`*`
Copyedit the license's revised text: (1) remove unnecessary repitition use of the word 'license' from the top of the header and source files (2) add the standard 'we hope it's useful, but no warranty' clause to COPYING (3) make explicit that linking OpenSSL is allowed (see https://people.gnome.org/~markmc/openssl-and-the-gpl.html for background) (4) sync the Qt and GTK+ clients' license popups with COPYING's revised text 2014-01-21 03:10:30 +00:00			`* It may be used under the GNU GPL versions 2 or 3`
Licensing changes: 1. add the option the code to be used under GPLv2 or GPLv3; previously only GPLv2 was allowed 2. add the "proxy option" as described in GPLv3 so we can add future licenses without having to bulk-edit everything again :) 3. remove the awkward "exception for MIT code in Mac client" clause; it was unnecessary and confusing. 2014-01-19 01:09:44 +00:00			`* or any future license endorsed by Mnemosyne LLC.`
partial implementation of json-ipc backend: torrent start/stop/close/verify/stat/info, as are getting & setting per-torrent peer limits, upload speeds, and download speeds. this is a work in progress. 2008-05-12 00:41:55 +00:00			`*`
fix svn id property 2008-05-28 17:17:12 +00:00			`* $Id$`
partial implementation of json-ipc backend: torrent start/stop/close/verify/stat/info, as are getting & setting per-torrent peer limits, upload speeds, and download speeds. this is a work in progress. 2008-05-12 00:41:55 +00:00			`*/`

make the request/response messages a little terser. add per-torrent speed limit toggles. rename ipc -> rpc. 2008-05-12 23:51:17 +00:00			`#ifndef TR_RPC_H`
			`#define TR_RPC_H`
partial implementation of json-ipc backend: torrent start/stop/close/verify/stat/info, as are getting & setting per-torrent peer limits, upload speeds, and download speeds. this is a work in progress. 2008-05-12 00:41:55 +00:00
(trunk libT) wrap rpcimpl.h in 'namespace "C"' when #included from C++ 2009-03-25 00:15:42 +00:00			`#ifdef __cplusplus`
			`extern "C" {`
			`#endif`

refactor libtransmission's tr_benc class as tr_variant. 2012-12-14 04:34:42 +00:00			`#include "transmission.h"`
			`#include "variant.h"`

RPC/IPC redesign 2008-05-18 16:44:30 +00:00			`/***`
			`**** RPC processing`
			`***/`

Improve RPC performance for local sessions Don't unnecessarily de-/serialize JSON data if local session is used. 2015-07-13 00:32:48 +00:00			`typedef void (tr_rpc_response_func)(tr_session session,`
			`tr_variant * response,`
			`void * user_data);`
partial implementation of json-ipc backend: torrent start/stop/close/verify/stat/info, as are getting & setting per-torrent peer limits, upload speeds, and download speeds. this is a work in progress. 2008-05-12 00:41:55 +00:00
fix bug in the benc-to-json converter. add rison-to-json converter so we can pass commands to transmission in a uri. add unit tests for the new code. 2008-05-13 12:52:58 +00:00			`/* http://www.json.org/ */`
Follow more common whitespace style conventions in the C code (libtransmission, daemon, utils, cli, gtk). 2012-12-05 17:29:46 +00:00			`void tr_rpc_request_exec_json (tr_session * session,`
Improve RPC performance for local sessions Don't unnecessarily de-/serialize JSON data if local session is used. 2015-07-13 00:32:48 +00:00			`const tr_variant * request,`
(trunk libT) In RPC, add general support for nonblocking methods, and specific support for adding a torrent via its URL and fetching it via curl without blocking. 2009-01-18 15:24:26 +00:00			`tr_rpc_response_func callback,`
Follow more common whitespace style conventions in the C code (libtransmission, daemon, utils, cli, gtk). 2012-12-05 17:29:46 +00:00			`void * callback_user_data);`
fix bug in the benc-to-json converter. add rison-to-json converter so we can pass commands to transmission in a uri. add unit tests for the new code. 2008-05-13 12:52:58 +00:00
RPC/IPC redesign 2008-05-18 16:44:30 +00:00			`/* see the RPC spec's "Request URI Notation" section */`
Follow more common whitespace style conventions in the C code (libtransmission, daemon, utils, cli, gtk). 2012-12-05 17:29:46 +00:00			`void tr_rpc_request_exec_uri (tr_session * session,`
(trunk libT) In RPC, add general support for nonblocking methods, and specific support for adding a torrent via its URL and fetching it via curl without blocking. 2009-01-18 15:24:26 +00:00			`const void * request_uri,`
Ongoing refactoring (use size_t instead of int) 2015-12-25 10:19:50 +00:00			`size_t request_uri_len,`
(trunk libT) In RPC, add general support for nonblocking methods, and specific support for adding a torrent via its URL and fetching it via curl without blocking. 2009-01-18 15:24:26 +00:00			`tr_rpc_response_func callback,`
Follow more common whitespace style conventions in the C code (libtransmission, daemon, utils, cli, gtk). 2012-12-05 17:29:46 +00:00			`void * callback_user_data);`
run libT, cli, daemon, gtk through the source-code formatter "uncrustify" as promised/threatened 2008-09-23 19:11:04 +00:00
refactor libtransmission's tr_benc class as tr_variant. 2012-12-14 04:34:42 +00:00			`void tr_rpc_parse_list_str (tr_variant * setme,`
			`const char * list_str,`
Ongoing refactoring (use size_t instead of int) 2015-12-25 10:19:50 +00:00			`size_t list_str_len);`
(rpc) 1. fix #968: 'transmission-remote -r' deletes all 2. fix error in escaping control characters when serializing tr_benc to JSON 3. fix small memory leak in rpc command parsing 2008-05-24 18:22:16 +00:00
(trunk libT) wrap rpcimpl.h in 'namespace "C"' when #included from C++ 2009-03-25 00:15:42 +00:00			`#ifdef __cplusplus`
			`}`
			`#endif`
(rpc) simplify the rpc accessors 2008-06-16 03:47:50 +00:00
(trunk libT) make rpcimpl.h includable from C++ M rpcimpl.h 2009-03-25 18:41:48 +00:00			`#endif /* TR_RPC_H */`