src/messages.h

   1 /* Copyright (C) 2009, Martin Johansson <martin@fatbob.nu>
   2    Copyright (C) 2005-2009, Thorvald Natvig <thorvald@natvig.com>
   3
   4    All rights reserved.
   5
   6    Redistribution and use in source and binary forms, with or without
   7    modification, are permitted provided that the following conditions
   8    are met:
   9
  10    - Redistributions of source code must retain the above copyright notice,
  11      this list of conditions and the following disclaimer.
  12    - Redistributions in binary form must reproduce the above copyright notice,
  13      this list of conditions and the following disclaimer in the documentation
  14      and/or other materials provided with the distribution.
  15    - Neither the name of the Developers nor the names of its contributors may
  16      be used to endorse or promote products derived from this software without
  17      specific prior written permission.
  18
  19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
  23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 */
  31 #ifndef MESSAGES_H_89768
  32 #define MESSAGES_H_89768
  33
  34 #include <stdint.h>
  35 #include "Mumble.pb-c.h"
  36 #include "list.h"
  37 #include "types.h"
  38
  39 #define MAX_TEXT 256
  40 #define MESSAGE_STREAM_VERSION 4
  41
  42 typedef enum {
  43         Version,
  44         UDPTunnel,
  45         Authenticate,
  46         Ping,
  47         Reject,
  48         ServerSync,
  49         ChannelRemove,
  50         ChannelState,
  51         UserRemove,
  52         UserState,
  53         BanList,
  54         TextMessage,
  55         PermissionDenied,
  56         ACL,
  57         QueryUsers,
  58         CryptSetup,
  59         ContextActionAdd,
  60         ContextAction,
  61         UserList,
  62         VoiceTarget,
  63         PermissionQuery,
  64         CodecVersion,
  65 } messageType_t;
  66
  67 typedef enum {
  68         UDPVoiceCELTAlpha,
  69         UDPPing,
  70         UDPVoiceSpeex,
  71         UDPVoiceCELTBeta,
  72 } UDPMessageType_t;
  73
  74
  75 typedef union payload {
  76         struct  _MumbleProto__Version *version;
  77         struct  _MumbleProto__UDPTunnel *UDPTunnel;
  78         struct  _MumbleProto__Authenticate *authenticate;
  79         struct  _MumbleProto__Ping *ping;
  80         struct  _MumbleProto__Reject *reject;
  81         struct  _MumbleProto__ServerSync *serverSync;
  82         struct  _MumbleProto__ChannelRemove *channelRemove;
  83         struct  _MumbleProto__ChannelState *channelState;
  84         struct  _MumbleProto__UserRemove *userRemove;
  85         struct  _MumbleProto__UserState *userState;
  86         /* BanEntry not supported */
  87         /* BanList not supported */
  88         struct  _MumbleProto__TextMessage *textMessage;
  89         struct  _MumbleProto__PermissionDenied *permissionDenied;
  90         /* ChanACL not supported */
  91         /* ACL not supported */
  92         struct  _MumbleProto__QueryUsers *queryUsers;
  93         struct  _MumbleProto__CryptSetup *cryptSetup;
  94         /* ContextActionAdd not supported */
  95         /* ContextAction not supported */
  96         struct  _MumbleProto__UserList__User *userList_user;
  97         struct  _MumbleProto__UserList *userList;
  98         struct  _MumbleProto__VoiceTarget__Target *voiceTarget_target;
  99         struct  _MumbleProto__VoiceTarget *voiceTarget;
 100         /* PermissionQuery not supported */
 101         struct  _MumbleProto__CodecVersion *codecVersion;
 102 } payload_t;
 103
 104 typedef struct message {
 105         messageType_t messageType;
 106         int refcount;
 107         struct dlist node;
 108         bool_t unpacked;
 109         payload_t payload;
 110 } message_t;
 111
 112
 113
 114 int Msg_messageToNetwork(message_t *msg, uint8_t *buffer);
 115 message_t *Msg_networkToMessage(uint8_t *data, int size);
 116 void Msg_free(message_t *msg);
 117 void Msg_inc_ref(message_t *msg);
 118
 119 message_t *Msg_create(messageType_t messageType);
 120
 121 #endif