lib/silcclient/command_reply.h

   1 /*
   2
   3   command_reply.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 1997 - 2001 Pekka Riikonen
   8
   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; version 2 of the License.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18 */
  19
  20 #ifndef COMMAND_REPLY_H
  21 #define COMMAND_REPLY_H
  22
  23 /* Structure holding one command reply and pointer to its function. */
  24 typedef struct {
  25   SilcCommandCb cb;
  26   SilcCommand cmd;
  27 } SilcClientCommandReply;
  28
  29 /* Context sent as argument to all command reply functions */
  30 struct SilcClientCommandReplyContextStruct {
  31   SilcClient client;
  32   SilcSocketConnection sock;
  33   SilcCommandPayload payload;
  34   SilcCommandStatus status;
  35   SilcCommandStatus error;
  36   SilcArgumentPayload args;
  37   SilcPacketContext *packet;
  38
  39   /* If defined this executes the pending command. */
  40   SilcCommandCb callback;
  41   void *context;
  42   SilcUInt16 ident;
  43 };
  44
  45 /* Macros */
  46
  47 /* Command reply operation that is called at the end of all command replys.
  48    Usage: COMMAND_REPLY((ARGS, argument1, argument2, etc...)), */
  49 #define COMMAND_REPLY(args) cmd->client->internal->ops->command_reply args
  50 #define ARGS cmd->client, cmd->sock->user_data,                         \
  51              cmd->payload, TRUE, silc_command_get(cmd->payload), cmd->status
  52
  53 /* Error reply to application. Usage: COMMAND_REPLY_ERROR; */
  54 #define COMMAND_REPLY_ERROR cmd->client->internal->ops->                \
  55   command_reply(cmd->client, cmd->sock->user_data, cmd->payload,        \
  56   FALSE, silc_command_get(cmd->payload), cmd->status)
  57
  58 /* Macro used to declare command reply functions */
  59 #define SILC_CLIENT_CMD_REPLY_FUNC(func)                                \
  60 void silc_client_command_reply_##func(void *context, void *context2)
  61
  62 /* Status message structure. Messages are defined below. */
  63 typedef struct {
  64   SilcCommandStatus status;
  65   char *message;
  66 } SilcCommandStatusMessage;
  67
  68 /* Status messages returned by the server */
  69 #define STAT(x) SILC_STATUS_ERR_##x
  70 DLLAPI extern const SilcCommandStatusMessage silc_command_status_messages[];
  71
  72 /* Prototypes */
  73
  74 void silc_client_command_reply_process(SilcClient client,
  75                                        SilcSocketConnection sock,
  76                                        SilcPacketContext *packet);
  77 char *silc_client_command_status_message(SilcCommandStatus status);
  78 void silc_client_command_reply_free(SilcClientCommandReplyContext cmd);
  79 SILC_CLIENT_CMD_REPLY_FUNC(whois);
  80 SILC_CLIENT_CMD_REPLY_FUNC(whowas);
  81 SILC_CLIENT_CMD_REPLY_FUNC(identify);
  82 SILC_CLIENT_CMD_REPLY_FUNC(nick);
  83 SILC_CLIENT_CMD_REPLY_FUNC(list);
  84 SILC_CLIENT_CMD_REPLY_FUNC(topic);
  85 SILC_CLIENT_CMD_REPLY_FUNC(invite);
  86 SILC_CLIENT_CMD_REPLY_FUNC(kill);
  87 SILC_CLIENT_CMD_REPLY_FUNC(info);
  88 SILC_CLIENT_CMD_REPLY_FUNC(stats);
  89 SILC_CLIENT_CMD_REPLY_FUNC(ping);
  90 SILC_CLIENT_CMD_REPLY_FUNC(oper);
  91 SILC_CLIENT_CMD_REPLY_FUNC(join);
  92 SILC_CLIENT_CMD_REPLY_FUNC(motd);
  93 SILC_CLIENT_CMD_REPLY_FUNC(umode);
  94 SILC_CLIENT_CMD_REPLY_FUNC(cmode);
  95 SILC_CLIENT_CMD_REPLY_FUNC(cumode);
  96 SILC_CLIENT_CMD_REPLY_FUNC(kick);
  97 SILC_CLIENT_CMD_REPLY_FUNC(ban);
  98 SILC_CLIENT_CMD_REPLY_FUNC(detach);
  99 SILC_CLIENT_CMD_REPLY_FUNC(silcoper);
 100 SILC_CLIENT_CMD_REPLY_FUNC(leave);
 101 SILC_CLIENT_CMD_REPLY_FUNC(users);
 102 SILC_CLIENT_CMD_REPLY_FUNC(getkey);
 103 SILC_CLIENT_CMD_REPLY_FUNC(quit);
 104
 105 /* Internal command reply functions */
 106 SILC_CLIENT_CMD_REPLY_FUNC(whois_i);
 107 SILC_CLIENT_CMD_REPLY_FUNC(identify_i);
 108 SILC_CLIENT_CMD_REPLY_FUNC(info_i);
 109 SILC_CLIENT_CMD_REPLY_FUNC(users_i);
 110
 111 SILC_CLIENT_CMD_REPLY_FUNC(connect);
 112 SILC_CLIENT_CMD_REPLY_FUNC(close);
 113 SILC_CLIENT_CMD_REPLY_FUNC(shutdown);
 114
 115 #endif