5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1997 - 2001 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
21 /****h* silccore/SILC Command Interface
25 * Implementation of the Command Payload. The Command Payload is used to
26 * send commands and also command replies usually between client and
34 /****f* silccore/SilcCommandAPI/SilcCommandCb
38 * typedef void (*SilcCommandCb)(void *context, void *context2);
42 * Command function callback. The actual command function pointer.
43 * This is generic command callback that the application may choose to
44 * use with its command routines. However, none of the generic
45 * routines depend on this callback so application may freely define
46 * their own command callback if desired.
49 typedef void (*SilcCommandCb)(void *context, void *context2);
51 /****s* silccore/SilcCommandAPI/SilcCommandPayload
55 * typedef struct SilcCommandPayloadStruct *SilcCommandPayload;
59 * This context is the actual Command Payload and is allocated
60 * by silc_command_payload_parse and given as argument usually to
61 * all silc_command_payload_* functions. It is freed by the
62 * silc_command_payload_free function.
65 typedef struct SilcCommandPayloadStruct *SilcCommandPayload;
67 /****d* silccore/SilcCommandAPI/SilcCommandFlags
71 * typedef enum { ... } SilcCommandFlags;
75 * Command flags that set how the commands behave on different
76 * situations. These can be OR'es together to set multiple flags.
77 * The application is resoponsible of implementing the behaviour
78 * of these flags. These are here just to define generic flags.
79 * The server usually makes use of these flags.
86 /* Command may only be used once per (about) 2 seconds. Bursts up
87 to 5 commands are allowed though. */
88 SILC_CF_LAG = (1L << 1),
90 /* Command may only be used once per (about) 2 seconds. No bursts
91 are allowed at all. */
92 SILC_CF_LAG_STRICT = (1L << 2),
94 /* Command is available for registered connections (connections
95 whose ID has been created. */
96 SILC_CF_REG = (1L << 3),
98 /* Command is available only for server operators */
99 SILC_CF_OPER = (1L << 4),
101 /* Command is available only for SILC (router) operators. If this
102 is set SILC_CF_OPER is not necessary to be set. */
103 SILC_CF_SILC_OPER = (1L << 5),
108 /****d* silccore/SilcCommandAPI/SilcCommand
112 * typedef unsigned char SilcCommand;
116 * The SilcCommand type definition and the commands. The commands
117 * listed here are the official SILC Commands and they have client
118 * and server counterparts.
122 typedef unsigned char SilcCommand;
124 /* All SILC commands. These are commands that have client and server
126 #define SILC_COMMAND_NONE 0
127 #define SILC_COMMAND_WHOIS 1
128 #define SILC_COMMAND_WHOWAS 2
129 #define SILC_COMMAND_IDENTIFY 3
130 #define SILC_COMMAND_NICK 4
131 #define SILC_COMMAND_LIST 5
132 #define SILC_COMMAND_TOPIC 6
133 #define SILC_COMMAND_INVITE 7
134 #define SILC_COMMAND_QUIT 8
135 #define SILC_COMMAND_KILL 9
136 #define SILC_COMMAND_INFO 10
137 #define SILC_COMMAND_STATS 11
138 #define SILC_COMMAND_PING 12
139 #define SILC_COMMAND_OPER 13
140 #define SILC_COMMAND_JOIN 14
141 #define SILC_COMMAND_MOTD 15
142 #define SILC_COMMAND_UMODE 16
143 #define SILC_COMMAND_CMODE 17
144 #define SILC_COMMAND_CUMODE 18
145 #define SILC_COMMAND_KICK 19
146 #define SILC_COMMAND_BAN 20
147 #define SILC_COMMAND_DETACH 21
148 #define SILC_COMMAND_WATCH 22
149 #define SILC_COMMAND_SILCOPER 23
150 #define SILC_COMMAND_LEAVE 24
151 #define SILC_COMMAND_USERS 25
152 #define SILC_COMMAND_GETKEY 26
153 #define SILC_COMMAND_SERVICE 27
155 /* Private range start */
156 #define SILC_COMMAND_PRIVATE 200
157 #define SILC_COMMAND_PRIV_CONNECT 200
158 #define SILC_COMMAND_PRIV_CLOSE 201
159 #define SILC_COMMAND_PRIV_SHUTDOWN 202
162 #define SILC_COMMAND_RESERVED 255
167 /****f* silccore/SilcCommandAPI/silc_command_payload_parse
172 * silc_command_payload_parse(const unsigned char *payload,
173 * SilcUInt32 payload_len);
177 * Parses command payload returning new command payload structure. The
178 * `buffer' is the raw payload.
181 SilcCommandPayload silc_command_payload_parse(const unsigned char *payload,
182 SilcUInt32 payload_len);
184 /****f* silccore/SilcCommandAPI/silc_command_payload_encode
188 * SilcBuffer silc_command_payload_encode(SilcCommand cmd,
190 * unsigned char **argv,
191 * SilcUInt32 *argv_lens,
192 * SilcUInt32 *argv_types,
197 * Encodes Command Payload returning it to SilcBuffer.
200 SilcBuffer silc_command_payload_encode(SilcCommand cmd,
202 unsigned char **argv,
203 SilcUInt32 *argv_lens,
204 SilcUInt32 *argv_types,
207 /****f* silccore/SilcCommandAPI/silc_command_payload_encode_payload
212 * silc_command_payload_encode_payload(SilcCommandPayload payload);
216 * Same as silc_command_payload_encode but encodes the buffer from
217 * SilcCommandPayload structure instead of raw data.
220 SilcBuffer silc_command_payload_encode_payload(SilcCommandPayload payload);
222 /****f* silccore/SilcCommandAPI/silc_command_payload_encode_va
226 * SilcBuffer silc_command_payload_encode_va(SilcCommand cmd,
228 * SilcUInt32 argc, ...);
232 * Encodes Command payload with variable argument list. The arguments
233 * must be: SilcUInt32, unsigned char *, unsigned int, ... One
234 * {SilcUInt32, unsigned char * and unsigned int} forms one argument,
235 * thus `argc' in case when sending one {SilcUInt32, unsigned char *
236 * and SilcUInt32} equals one (1) and when sending two of those it
237 * equals two (2), and so on. This has to be preserved or bad things
238 * will happen. The variable arguments is: {type, data, data_len}.
241 SilcBuffer silc_command_payload_encode_va(SilcCommand cmd,
243 SilcUInt32 argc, ...);
245 /****f* silccore/SilcCommandAPI/silc_command_payload_encode_vap
249 * SilcBuffer silc_command_payload_encode_vap(SilcCommand cmd,
251 * SilcUInt32 argc, va_list ap);
255 * This is equivalent to the silc_command_payload_encode_va except
256 * takes the va_list as argument.
259 SilcBuffer silc_command_payload_encode_vap(SilcCommand cmd,
261 SilcUInt32 argc, va_list ap);
263 /****f* silccore/SilcCommandAPI/silc_command_reply_payload_encode_va
268 * silc_command_reply_payload_encode_va(SilcCommand cmd,
272 * SilcUInt32 argc, ...);
276 * Same as silc_command_payload_encode_va except that this is used to
277 * encode strictly command reply packets. The `argc' must not count
278 * `status' and `error' as arguments. The `status' includes the
279 * command reply status. If single reply will be sent then it includes
280 * SILC_STATUS_OK if error did not occur. It includes an error value
281 * if error did occur. In this case `error' field is ignored. If
282 * there will be multiple successful command replies then the `status'
283 * includes a list value and `error' is ignored. If there will
284 * multiple error replies the `status' includes a list value, and
285 * the `error' includes an error value. Thus, the `error' value is
286 * specified only if there will be list of errors.
290 * Protocol defines that it is possible to send both list of successful
291 * and list of error replies at the same time, as long as the error
292 * replies are sent after the successful replies.
296 silc_command_reply_payload_encode_va(SilcCommand cmd,
300 SilcUInt32 argc, ...);
302 /****f* silccore/SilcCommandAPI/silc_command_reply_payload_encode_vap
307 * silc_command_reply_payload_encode_vap(SilcCommand cmd,
310 * SilcUInt16 ident, SilcUInt32 argc,
315 * This is equivalent to the silc_command_reply_payload_encode_va except
316 * takes the va_list as argument.
320 silc_command_reply_payload_encode_vap(SilcCommand cmd,
323 SilcUInt16 ident, SilcUInt32 argc,
326 /****f* silccore/SilcCommandAPI/silc_command_free
330 * void silc_command_payload_free(SilcCommandPayload payload);
334 * Frees the Command Payload and all data in it.
337 void silc_command_payload_free(SilcCommandPayload payload);
339 /****f* silccore/SilcCommandAPI/silc_command_get
343 * SilcCommand silc_command_get(SilcCommandPayload payload);
347 * Return the command from the payload.
350 SilcCommand silc_command_get(SilcCommandPayload payload);
352 /****f* silccore/SilcCommandAPI/silc_command_get_args
356 * SilcArgumentPayload silc_command_get_args(SilcCommandPayload payload);
360 * Return the Arguments Payload containing the arguments from the
361 * Command Payload. The caller must not free it.
364 SilcArgumentPayload silc_command_get_args(SilcCommandPayload payload);
366 /****f* silccore/SilcCommandAPI/silc_command_get_ident
370 * SilcUInt16 silc_command_get_ident(SilcCommandPayload payload);
374 * Return the command identifier from the payload. The identifier can
375 * be used to identify which command reply belongs to which command.
376 * The client sets the identifier to the payload and server must return
377 * the same identifier in the command reply.
380 SilcUInt16 silc_command_get_ident(SilcCommandPayload payload);
382 /****f* silccore/SilcCommandAPI/silc_command_get_status
386 * bool silc_command_get_status(SilcCommandPayload payload,
387 * SilcStatus *status,
388 * SilcStatus *error);
392 * This function returns the command reply status into `status' and
393 * error status, if error occurred into the `error'. The function
394 * returns TRUE if command reply status is not error, and FALSE if
395 * error occurred. In this case the `error' will include the actual
396 * error status. The `status' can be in this case some list value
397 * which indicates that there will be list of errors.
400 bool silc_command_get_status(SilcCommandPayload payload,
404 /****f* silccore/SilcCommandAPI/silc_command_set_ident
408 * void silc_command_set_ident(SilcCommandPayload payload,
413 * Function to set identifier to already allocated Command Payload. Command
414 * payloads are frequentlly resent in SILC and thusly this makes it easy
415 * to set the identifier without encoding new Command Payload.
418 void silc_command_set_ident(SilcCommandPayload payload, SilcUInt16 ident);
420 /****f* silccore/SilcCommandAPI/silc_command_set_command
424 * void silc_command_set_command(SilcCommandPayload payload,
425 * SilcCommand command);
429 * Function to set the command to already allocated Command Payload. This
430 * makes it easy to change the command in the payload without encoding new
434 void silc_command_set_command(SilcCommandPayload payload, SilcCommand command);