source: trunk/libtransmission/ipcparse.h @ 3578

Last change on this file since 3578 was 3578, checked in by joshe, 15 years ago

Add IPC messages to set and retrieve the encryption mode.
Implement encryption mode messages in -daemon and -remote.

  • Property svn:keywords set to Date Rev Author Id
File size: 6.4 KB
Line 
1/******************************************************************************
2 * $Id: ipcparse.h 3578 2007-10-26 03:43:27Z joshe $
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
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_CRYPTO,
46    IPC_MSG_DIR,
47    IPC_MSG_DOWNLIMIT,
48    IPC_MSG_FAIL,
49    IPC_MSG_GETAUTOMAP,
50    IPC_MSG_GETAUTOSTART,
51    IPC_MSG_GETCRYPTO,
52    IPC_MSG_GETDIR,
53    IPC_MSG_GETDOWNLIMIT,
54    IPC_MSG_GETINFO,
55    IPC_MSG_GETINFOALL,
56    IPC_MSG_GETPEX,
57    IPC_MSG_GETPORT,
58    IPC_MSG_GETSTAT,
59    IPC_MSG_GETSTATALL,
60    IPC_MSG_GETSUP,
61    IPC_MSG_GETUPLIMIT,
62    IPC_MSG_LOOKUP,
63    IPC_MSG_INFO,
64    IPC_MSG_NOOP,
65    IPC_MSG_NOTSUP,
66    IPC_MSG_PEX,
67    IPC_MSG_PORT,
68    IPC_MSG_QUIT,
69    IPC_MSG_REMOVE,
70    IPC_MSG_REMOVEALL,
71    IPC_MSG_START,
72    IPC_MSG_STARTALL,
73    IPC_MSG_STAT,
74    IPC_MSG_STOP,
75    IPC_MSG_STOPALL,
76    IPC_MSG_OK,
77    IPC_MSG_SUP,
78    IPC_MSG_UPLIMIT,
79    IPC_MSG_VERSION,
80    IPC__MSG_COUNT,
81    IPC__MSG_UNKNOWN
82};
83
84/* If you add or delete a constant here then you need to renumber the
85   ones after it. They need to be in ascending order starting at zero,
86   with no gaps. */
87#define IPC_INF_COMMENT         ( 1 << 0 )
88#define IPC_INF_CREATOR         ( 1 << 1 )
89#define IPC_INF_DATE            ( 1 << 2 )
90#define IPC_INF_FILES           ( 1 << 3 )
91#define IPC_INF_HASH            ( 1 << 4 )
92#define IPC_INF_ID              ( 1 << 5 )
93#define IPC_INF_NAME            ( 1 << 6 )
94#define IPC_INF_PATH            ( 1 << 7 )
95#define IPC_INF_PRIVATE         ( 1 << 8 )
96#define IPC_INF_SIZE            ( 1 << 9 )
97#define IPC_INF_TRACKERS        ( 1 << 10 )
98#define IPC_INF__MAX            ( 1 << 11 )
99
100/* Ditto for these */
101#define IPC_ST_COMPLETED        ( 1 << 0 )
102#define IPC_ST_DOWNSPEED        ( 1 << 1 )
103#define IPC_ST_DOWNTOTAL        ( 1 << 2 )
104#define IPC_ST_DOWNVALID        ( 1 << 3 )
105#define IPC_ST_ERROR            ( 1 << 4 )
106#define IPC_ST_ERRMSG           ( 1 << 5 )
107#define IPC_ST_ETA              ( 1 << 6 )
108#define IPC_ST_ID               ( 1 << 7 )
109#define IPC_ST_PEERDOWN         ( 1 << 8 )
110#define IPC_ST_PEERFROM         ( 1 << 9 )
111#define IPC_ST_PEERTOTAL        ( 1 << 10 )
112#define IPC_ST_PEERUP           ( 1 << 11 )
113#define IPC_ST_RUNNING          ( 1 << 12 )
114#define IPC_ST_STATE            ( 1 << 13 )
115#define IPC_ST_SWARM            ( 1 << 14 )
116#define IPC_ST_TRACKER          ( 1 << 15 )
117#define IPC_ST_TKDONE           ( 1 << 16 )
118#define IPC_ST_TKLEECH          ( 1 << 17 )
119#define IPC_ST_TKSEED           ( 1 << 18 )
120#define IPC_ST_UPSPEED          ( 1 << 19 )
121#define IPC_ST_UPTOTAL          ( 1 << 20 )
122#define IPC_ST__MAX             ( 1 << 21 )
123
124struct ipc_funcs;
125struct ipc_info;
126struct strlist;
127
128struct ipc_info
129{
130    struct ipc_funcs * funcs;
131    int                vers;
132    char             * label;
133};
134
135#define HASVERS( info )         ( 0 < (info)->vers )
136#define VERSLABEL( info )       ( (info)->label )
137
138#define TORRENT_ID_VALID( id )  ( 0 < (id) && INT_MAX > (id) )
139
140typedef void ( *trd_msgfunc )( enum ipc_msg, benc_val_t *, int64_t, void * );
141
142/* any of these functions that can fail may set errno for any of the
143   errors set by malloc() or calloc() */
144
145/* setup */
146struct ipc_funcs * ipc_initmsgs ( void );
147int          ipc_addmsg   ( struct ipc_funcs *, enum ipc_msg, trd_msgfunc );
148void         ipc_setdefmsg( struct ipc_funcs *, trd_msgfunc );
149void         ipc_freemsgs ( struct ipc_funcs * );
150struct ipc_info * ipc_newcon( struct ipc_funcs * );
151void         ipc_freecon  ( struct ipc_info * );
152
153/* message creation */
154/* sets errno to EPERM if requested message not supported by protocol vers */
155benc_val_t * ipc_initval  ( struct ipc_info *, enum ipc_msg, int64_t,
156                            benc_val_t *, int );
157uint8_t *    ipc_mkval    ( benc_val_t *, size_t * );
158uint8_t *    ipc_mkempty  ( struct ipc_info *, size_t *, enum ipc_msg,
159                            int64_t );
160uint8_t *    ipc_mkint    ( struct ipc_info *, size_t *, enum ipc_msg, int64_t,
161                            int64_t );
162uint8_t *    ipc_mkstr    ( struct ipc_info *, size_t *, enum ipc_msg, int64_t,
163                            const char * );
164uint8_t *    ipc_mkvers   ( size_t *, const char * );
165uint8_t *    ipc_mkgetinfo( struct ipc_info *, size_t *, enum ipc_msg, int64_t,
166                            int, const int * );
167int          ipc_addinfo  ( benc_val_t *, int, const tr_info *, int );
168int          ipc_addstat  ( benc_val_t *, int, const tr_stat *, int );
169
170/* sets errno to EINVAL on parse error or
171   EPERM for unsupported protocol version */
172ssize_t      ipc_parse    ( struct ipc_info *, uint8_t *, ssize_t, void * );
173
174/* misc info functions, these will always succeed */
175int          ipc_havemsg  ( struct ipc_info *, enum ipc_msg );
176enum ipc_msg ipc_msgid    ( struct ipc_info *, const char * );
177int          ipc_ishandled( struct ipc_info *, enum ipc_msg );
178int          ipc_havetags ( struct ipc_info * );
179int          ipc_infotypes( enum ipc_msg, benc_val_t * );
180const char * ipc_infoname ( enum ipc_msg, int );
181
182#endif /* TR_DAEMON_IPC_H */
Note: See TracBrowser for help on using the repository browser.