source: trunk/libtransmission/ipcparse.h @ 2149

Last change on this file since 2149 was 2149, checked in by livings124, 15 years ago

Merge file selection and torrent creation into the main branch.

The new code for these features is under a new license.

  • Property svn:keywords set to Date Rev Author Id
File size: 6.0 KB
Line 
1/******************************************************************************
2 * $Id: ipcparse.h 2149 2007-06-18 03:40:41Z livings124 $
3 *
4 * Copyright (c) 2007 Joshua Elsasser
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *****************************************************************************/
24
25#ifndef TR_DAEMON_IPC_H
26#define TR_DAEMON_IPC_H
27
28#include <inttypes.h>
29
30/* yay for typedefs, we can't forward declare benc_val_t or tr_info_t
31   like with structs */
32#include "bencode.h"
33#include "transmission.h"
34
35#define IPC_MIN_MSG_LEN         ( 8 )
36#define IPC_MAX_MSG_LEN         ( 0x7fffffff - IPC_MIN_MSG_LEN )
37
38enum ipc_msg
39{
40    IPC_MSG_ADDMANYFILES = 0,
41    IPC_MSG_ADDONEFILE,
42    IPC_MSG_AUTOMAP,
43    IPC_MSG_AUTOSTART,
44    IPC_MSG_BAD,
45    IPC_MSG_DIR,
46    IPC_MSG_DOWNLIMIT,
47    IPC_MSG_FAIL,
48    IPC_MSG_GETAUTOMAP,
49    IPC_MSG_GETAUTOSTART,
50    IPC_MSG_GETDIR,
51    IPC_MSG_GETDOWNLIMIT,
52    IPC_MSG_GETINFO,
53    IPC_MSG_GETINFOALL,
54    IPC_MSG_GETPEX,
55    IPC_MSG_GETPORT,
56    IPC_MSG_GETSTAT,
57    IPC_MSG_GETSTATALL,
58    IPC_MSG_GETSUP,
59    IPC_MSG_GETUPLIMIT,
60    IPC_MSG_LOOKUP,
61    IPC_MSG_INFO,
62    IPC_MSG_NOOP,
63    IPC_MSG_NOTSUP,
64    IPC_MSG_PEX,
65    IPC_MSG_PORT,
66    IPC_MSG_QUIT,
67    IPC_MSG_REMOVE,
68    IPC_MSG_REMOVEALL,
69    IPC_MSG_START,
70    IPC_MSG_STARTALL,
71    IPC_MSG_STAT,
72    IPC_MSG_STOP,
73    IPC_MSG_STOPALL,
74    IPC_MSG_OK,
75    IPC_MSG_SUP,
76    IPC_MSG_UPLIMIT,
77    IPC_MSG_VERSION,
78    IPC__MSG_COUNT
79};
80
81#define IPC_INF_COMMENT         ( 1 << 0 )
82#define IPC_INF_CREATOR         ( 1 << 1 )
83#define IPC_INF_DATE            ( 1 << 2 )
84#define IPC_INF_FILES           ( 1 << 3 )
85#define IPC_INF_HASH            ( 1 << 4 )
86#define IPC_INF_ID              ( 1 << 5 )
87#define IPC_INF_NAME            ( 1 << 6 )
88#define IPC_INF_PATH            ( 1 << 7 )
89#define IPC_INF_PRIVATE         ( 1 << 8 )
90#define IPC_INF_SAVED           ( 1 << 9 )
91#define IPC_INF_SIZE            ( 1 << 10 )
92#define IPC_INF_TRACKERS        ( 1 << 11 )
93#define IPC_INF__MAX            ( 1 << 12 )
94
95#define IPC_ST_COMPLETED        ( 1 << 0 )
96#define IPC_ST_DOWNSPEED        ( 1 << 1 )
97#define IPC_ST_DOWNTOTAL        ( 1 << 2 )
98#define IPC_ST_ERROR            ( 1 << 3 )
99#define IPC_ST_ERRMSG           ( 1 << 4 )
100#define IPC_ST_ETA              ( 1 << 5 )
101#define IPC_ST_ID               ( 1 << 6 )
102#define IPC_ST_PEERDOWN         ( 1 << 7 )
103#define IPC_ST_PEERFROM         ( 1 << 8 )
104#define IPC_ST_PEERTOTAL        ( 1 << 9 )
105#define IPC_ST_PEERUP           ( 1 << 10 )
106#define IPC_ST_RUNNING          ( 1 << 11 )
107#define IPC_ST_STATE            ( 1 << 12 )
108#define IPC_ST_SWARM            ( 1 << 13 )
109#define IPC_ST_TRACKER          ( 1 << 14 )
110#define IPC_ST_TKDONE           ( 1 << 15 )
111#define IPC_ST_TKLEECH          ( 1 << 16 )
112#define IPC_ST_TKSEED           ( 1 << 17 )
113#define IPC_ST_UPSPEED          ( 1 << 18 )
114#define IPC_ST_UPTOTAL          ( 1 << 19 )
115#define IPC_ST__MAX             ( 1 << 20 )
116
117struct ipc_funcs;
118struct ipc_info;
119struct strlist;
120
121struct ipc_info
122{
123    struct ipc_funcs * funcs;
124    int                vers;
125};
126
127#define HASVERS( info )         ( 0 < (info)->vers )
128
129#define TORRENT_ID_VALID( id )  ( 0 < (id) && INT_MAX > (id) )
130
131typedef void ( *trd_msgfunc )( enum ipc_msg, benc_val_t *, int64_t, void * );
132
133/* any of these functions that can fail may set errno for any of the
134   errors set by malloc() or calloc() */
135
136/* setup */
137struct ipc_funcs * ipc_initmsgs ( void );
138int          ipc_addmsg   ( struct ipc_funcs *, enum ipc_msg, trd_msgfunc );
139void         ipc_setdefmsg( struct ipc_funcs *, trd_msgfunc );
140void         ipc_freemsgs ( struct ipc_funcs * );
141void         ipc_newcon   ( struct ipc_info *, struct ipc_funcs * );
142
143/* message creation */
144/* sets errno to EPERM if requested message not supported by protocol vers */
145benc_val_t * ipc_initval  ( struct ipc_info *, enum ipc_msg, int64_t,
146                            benc_val_t *, int );
147uint8_t *    ipc_mkval    ( benc_val_t *, size_t * );
148uint8_t *    ipc_mkempty  ( struct ipc_info *, size_t *, enum ipc_msg,
149                            int64_t );
150uint8_t *    ipc_mkint    ( struct ipc_info *, size_t *, enum ipc_msg, int64_t,
151                            int64_t );
152uint8_t *    ipc_mkstr    ( struct ipc_info *, size_t *, enum ipc_msg, int64_t,
153                            const char * );
154uint8_t *    ipc_mkvers   ( size_t * );
155uint8_t *    ipc_mkgetinfo( struct ipc_info *, size_t *, enum ipc_msg, int64_t,
156                            int, const int * );
157int          ipc_addinfo  ( benc_val_t *, int, tr_info_t *, int );
158int          ipc_addstat  ( benc_val_t *, int, tr_stat_t *, int );
159
160/* sets errno to EINVAL on parse error or
161   EPERM for unsupported protocol version */
162ssize_t      ipc_parse    ( struct ipc_info *, uint8_t *, ssize_t, void * );
163
164/* misc info functions, these will always succeed */
165int          ipc_havemsg  ( struct ipc_info *, enum ipc_msg );
166enum ipc_msg ipc_msgid    ( struct ipc_info *, const char * );
167int          ipc_ishandled( struct ipc_info *, enum ipc_msg );
168int          ipc_havetags ( struct ipc_info * );
169int          ipc_infotypes( enum ipc_msg, benc_val_t * );
170const char * ipc_infoname ( enum ipc_msg, int );
171
172#endif /* TR_DAEMON_IPC_H */
Note: See TracBrowser for help on using the repository browser.