transmission/libtransmission/rpcimpl.h

/*
 * This file Copyright (C) 2008-2014 Mnemosyne LLC
 *
 * It may be used under the GNU Public License v2 or v3 licenses,
 * 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
***/

struct evbuffer;

typedef void (*tr_rpc_response_func)(tr_session      * session,
                                     struct evbuffer * response,
                                     void            * user_data);
/* http://www.json.org/ */
void tr_rpc_request_exec_json (tr_session            * session,
                               const void            * request_json,
                               int                     request_len,
                               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,
                              int                    request_len,
                              tr_rpc_response_func   callback,
                              void                 * callback_user_data);

void tr_rpc_parse_list_str (tr_variant  * setme,
                            const char  * list_str,
                            int           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			`*`
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			`* It may be used under the GNU Public License v2 or v3 licenses,`
			`* 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`
			`***/`

(trunk) #3836 "libevent2 support" -- bump libevent2 requirement to 2.0.10. This will break the Mac build for a minute intil BMW applies his Mac patch 2010-12-20 02:07:51 +00:00			`struct evbuffer;`
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
(libT) #5234 'typo causing RPC session-get error in nightlies': add unit test (currently failing) to test for this issue. 2013-01-21 00:00:00 +00:00			`typedef void (tr_rpc_response_func)(tr_session session,`
			`struct evbuffer * response,`
			`void * 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			`/* 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,`
(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_json,`
(trunk libT) prefer `int' over `ssize_t' 2009-01-19 14:05:43 +00:00			`int request_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);`
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,`
(trunk libT) prefer `int' over `ssize_t' 2009-01-19 14:05:43 +00:00			`int request_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,`
			`int 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 */`