MPD 0.17~git
src/client_message.h
Go to the documentation of this file.
00001 /*
00002  * Copyright (C) 2003-2011 The Music Player Daemon Project
00003  * http://www.musicpd.org
00004  *
00005  * This program is free software; you can redistribute it and/or modify
00006  * it under the terms of the GNU General Public License as published by
00007  * the Free Software Foundation; either version 2 of the License, or
00008  * (at your option) any later version.
00009  *
00010  * This program is distributed in the hope that it will be useful,
00011  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00013  * GNU General Public License for more details.
00014  *
00015  * You should have received a copy of the GNU General Public License along
00016  * with this program; if not, write to the Free Software Foundation, Inc.,
00017  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
00018  */
00019 
00020 #ifndef MPD_CLIENT_MESSAGE_H
00021 #define MPD_CLIENT_MESSAGE_H
00022 
00023 #include <assert.h>
00024 #include <stdbool.h>
00025 #include <stddef.h>
00026 #include <glib.h>
00027 
00031 struct client_message {
00032         char *channel;
00033 
00034         char *message;
00035 };
00036 
00037 G_GNUC_PURE
00038 bool
00039 client_message_valid_channel_name(const char *name);
00040 
00041 G_GNUC_PURE
00042 static inline bool
00043 client_message_defined(const struct client_message *msg)
00044 {
00045         assert(msg != NULL);
00046         assert((msg->channel == NULL) == (msg->message == NULL));
00047 
00048         return msg->channel != NULL;
00049 }
00050 
00051 void
00052 client_message_init_null(struct client_message *msg);
00053 
00054 void
00055 client_message_init(struct client_message *msg,
00056                     const char *channel, const char *message);
00057 
00058 void
00059 client_message_copy(struct client_message *dest,
00060                     const struct client_message *src);
00061 
00062 G_GNUC_MALLOC
00063 struct client_message *
00064 client_message_dup(const struct client_message *src);
00065 
00066 void
00067 client_message_deinit(struct client_message *msg);
00068 
00069 void
00070 client_message_free(struct client_message *msg);
00071 
00072 #endif