source: trunk/libtransmission/ipcparse.h @ 4404

Last change on this file since 4404 was 4404, checked in by charles, 15 years ago

set copyright info to 2008

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