libs: more doc scanner fixes
[platform/upstream/gstreamer.git] / libs / gst / net / gstnetcontrolmessagemeta.h
1 /* GStreamer
2  * Copyright (C) <2014> William Manley <will@williammanley.net>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 #ifndef __GST_NET_CONTROL_MESSAGE_META_H__
21 #define __GST_NET_CONTROL_MESSAGE_META_H__
22
23 #include <gst/gst.h>
24 #include <gio/gio.h>
25
26 G_BEGIN_DECLS
27
28 typedef struct _GstNetControlMessageMeta GstNetControlMessageMeta;
29
30 /**
31  * GstNetControlMessageMeta:
32  * @meta: the parent type
33  * @addr: a #GSocketControlMessage stored as metadata
34  *
35  * Buffer metadata for GSocket control messages, AKA ancillary data attached to
36  * data sent across a socket.
37  */
38 struct _GstNetControlMessageMeta {
39   GstMeta       meta;
40
41   GSocketControlMessage *message;
42 };
43
44 GType gst_net_control_message_meta_api_get_type (void);
45 #define GST_NET_CONTROL_MESSAGE_META_API_TYPE \
46   (gst_net_control_message_meta_api_get_type())
47
48 #define gst_buffer_get_net_control_message_meta(b) ((GstNetControlMessageMeta*)\
49   gst_buffer_get_meta((b),GST_NET_CONTROL_MESSAGE_META_API_TYPE))
50
51 /* implementation */
52 const GstMetaInfo *gst_net_control_message_meta_get_info (void);
53 #define GST_NET_CONTROL_MESSAGE_META_INFO \
54   (gst_net_control_message_meta_get_info())
55
56 GstNetControlMessageMeta * gst_buffer_add_net_control_message_meta (GstBuffer             * buffer,
57                                                                     GSocketControlMessage * message);
58
59 G_END_DECLS
60
61 #endif /* __GST_NET_CONTROL_MESSAGE_META_H__ */
62