mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-01 14:11:15 +00:00
Code Issues 1 Projects Releases Wiki Activity
gstreamer/libs/gst/net/gstnetcontrolmessagemeta.h

70 lines
2.1 KiB
C
Raw Normal View History

meta: Add `GstNetControlMessageMeta` GstNetAddress can be used to store ancillary data which was received with or is to be sent alongside the buffer data. When used with socket sinks and sources which understand this meta it allows sending and receiving ancillary data such as unix credentials (See `GUnixCredentialsMessage`) and Unix file descriptions (See `GUnixFDMessage`). This will be useful for implementing protocols which use file-descriptor passing in payloaders/depayloaders without having to re-implement all the socket handling code already present in elements such as multisocketsink, etc. This, in turn, will be useful for implementing zero-copy video IPC. This meta uses the platform independent `GSocketControlMessage` API provided by GLib as a part of GIO. As a result this new meta does not require any new dependencies or any conditional compliation for portablility, although it is unlikely to do anything useful on non-UNIX platforms.
2014-10-30 15:39:21 +00:00
/* GStreamer
* Copyright (C) <2014> William Manley <will@williammanley.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GST_NET_CONTROL_MESSAGE_META_H__
#define __GST_NET_CONTROL_MESSAGE_META_H__
#include <gst/gst.h>
#include <gio/gio.h>
net: GST_EXPORT -> GST_NET_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
#include <gst/net/net-prelude.h>
meta: Add `GstNetControlMessageMeta` GstNetAddress can be used to store ancillary data which was received with or is to be sent alongside the buffer data. When used with socket sinks and sources which understand this meta it allows sending and receiving ancillary data such as unix credentials (See `GUnixCredentialsMessage`) and Unix file descriptions (See `GUnixFDMessage`). This will be useful for implementing protocols which use file-descriptor passing in payloaders/depayloaders without having to re-implement all the socket handling code already present in elements such as multisocketsink, etc. This, in turn, will be useful for implementing zero-copy video IPC. This meta uses the platform independent `GSocketControlMessage` API provided by GLib as a part of GIO. As a result this new meta does not require any new dependencies or any conditional compliation for portablility, although it is unlikely to do anything useful on non-UNIX platforms.
2014-10-30 15:39:21 +00:00
G_BEGIN_DECLS
typedef struct _GstNetControlMessageMeta GstNetControlMessageMeta;
/**
* GstNetControlMessageMeta:
* @meta: the parent type
doc: Various doc fixes for libgstreamer-base * Fix function name in sections.txt * Add few missing or fix miss-named * Workaround gtk-doc being confused with non typedef types (loose track of public/private
2015-06-14 14:56:28 +00:00
* @message: a #GSocketControlMessage stored as metadata
meta: Add `GstNetControlMessageMeta` GstNetAddress can be used to store ancillary data which was received with or is to be sent alongside the buffer data. When used with socket sinks and sources which understand this meta it allows sending and receiving ancillary data such as unix credentials (See `GUnixCredentialsMessage`) and Unix file descriptions (See `GUnixFDMessage`). This will be useful for implementing protocols which use file-descriptor passing in payloaders/depayloaders without having to re-implement all the socket handling code already present in elements such as multisocketsink, etc. This, in turn, will be useful for implementing zero-copy video IPC. This meta uses the platform independent `GSocketControlMessage` API provided by GLib as a part of GIO. As a result this new meta does not require any new dependencies or any conditional compliation for portablility, although it is unlikely to do anything useful on non-UNIX platforms.
2014-10-30 15:39:21 +00:00
*
* Buffer metadata for GSocket control messages, AKA ancillary data attached to
* data sent across a socket.
*/
struct _GstNetControlMessageMeta {
GstMeta meta;
GSocketControlMessage *message;
};
net: GST_EXPORT -> GST_NET_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
GST_NET_API
meta: Add `GstNetControlMessageMeta` GstNetAddress can be used to store ancillary data which was received with or is to be sent alongside the buffer data. When used with socket sinks and sources which understand this meta it allows sending and receiving ancillary data such as unix credentials (See `GUnixCredentialsMessage`) and Unix file descriptions (See `GUnixFDMessage`). This will be useful for implementing protocols which use file-descriptor passing in payloaders/depayloaders without having to re-implement all the socket handling code already present in elements such as multisocketsink, etc. This, in turn, will be useful for implementing zero-copy video IPC. This meta uses the platform independent `GSocketControlMessage` API provided by GLib as a part of GIO. As a result this new meta does not require any new dependencies or any conditional compliation for portablility, although it is unlikely to do anything useful on non-UNIX platforms.
2014-10-30 15:39:21 +00:00
GType gst_net_control_message_meta_api_get_type (void);
libs: net: mark symbols explicitly for export with GST_EXPORT
2017-05-09 15:01:46 +00:00
meta: Add `GstNetControlMessageMeta` GstNetAddress can be used to store ancillary data which was received with or is to be sent alongside the buffer data. When used with socket sinks and sources which understand this meta it allows sending and receiving ancillary data such as unix credentials (See `GUnixCredentialsMessage`) and Unix file descriptions (See `GUnixFDMessage`). This will be useful for implementing protocols which use file-descriptor passing in payloaders/depayloaders without having to re-implement all the socket handling code already present in elements such as multisocketsink, etc. This, in turn, will be useful for implementing zero-copy video IPC. This meta uses the platform independent `GSocketControlMessage` API provided by GLib as a part of GIO. As a result this new meta does not require any new dependencies or any conditional compliation for portablility, although it is unlikely to do anything useful on non-UNIX platforms.
2014-10-30 15:39:21 +00:00
#define GST_NET_CONTROL_MESSAGE_META_API_TYPE \
(gst_net_control_message_meta_api_get_type())
#define gst_buffer_get_net_control_message_meta(b) ((GstNetControlMessageMeta*)\
gst_buffer_get_meta((b),GST_NET_CONTROL_MESSAGE_META_API_TYPE))
/* implementation */
libs: net: mark symbols explicitly for export with GST_EXPORT
2017-05-09 15:01:46 +00:00
net: GST_EXPORT -> GST_NET_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
GST_NET_API
meta: Add `GstNetControlMessageMeta` GstNetAddress can be used to store ancillary data which was received with or is to be sent alongside the buffer data. When used with socket sinks and sources which understand this meta it allows sending and receiving ancillary data such as unix credentials (See `GUnixCredentialsMessage`) and Unix file descriptions (See `GUnixFDMessage`). This will be useful for implementing protocols which use file-descriptor passing in payloaders/depayloaders without having to re-implement all the socket handling code already present in elements such as multisocketsink, etc. This, in turn, will be useful for implementing zero-copy video IPC. This meta uses the platform independent `GSocketControlMessage` API provided by GLib as a part of GIO. As a result this new meta does not require any new dependencies or any conditional compliation for portablility, although it is unlikely to do anything useful on non-UNIX platforms.
2014-10-30 15:39:21 +00:00
const GstMetaInfo *gst_net_control_message_meta_get_info (void);
libs: net: mark symbols explicitly for export with GST_EXPORT
2017-05-09 15:01:46 +00:00
meta: Add `GstNetControlMessageMeta` GstNetAddress can be used to store ancillary data which was received with or is to be sent alongside the buffer data. When used with socket sinks and sources which understand this meta it allows sending and receiving ancillary data such as unix credentials (See `GUnixCredentialsMessage`) and Unix file descriptions (See `GUnixFDMessage`). This will be useful for implementing protocols which use file-descriptor passing in payloaders/depayloaders without having to re-implement all the socket handling code already present in elements such as multisocketsink, etc. This, in turn, will be useful for implementing zero-copy video IPC. This meta uses the platform independent `GSocketControlMessage` API provided by GLib as a part of GIO. As a result this new meta does not require any new dependencies or any conditional compliation for portablility, although it is unlikely to do anything useful on non-UNIX platforms.
2014-10-30 15:39:21 +00:00
#define GST_NET_CONTROL_MESSAGE_META_INFO \
(gst_net_control_message_meta_get_info())
net: GST_EXPORT -> GST_NET_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
GST_NET_API
libs: more doc scanner fixes gstbasetransform.h:196: Warning: GstBase: "@submit_input_buffer" parameter unexpected at this location: * @submit_input_buffer: Function which accepts a new input buffer and pre-processes it. gstnetcontrolmessagemeta.c:103: Warning: GstNet: gst_buffer_add_net_control_message_meta: unknown parameter 'message' in documentation comment, should be 'addr'
2015-06-13 14:05:05 +00:00
GstNetControlMessageMeta * gst_buffer_add_net_control_message_meta (GstBuffer * buffer,
GSocketControlMessage * message);
meta: Add `GstNetControlMessageMeta` GstNetAddress can be used to store ancillary data which was received with or is to be sent alongside the buffer data. When used with socket sinks and sources which understand this meta it allows sending and receiving ancillary data such as unix credentials (See `GUnixCredentialsMessage`) and Unix file descriptions (See `GUnixFDMessage`). This will be useful for implementing protocols which use file-descriptor passing in payloaders/depayloaders without having to re-implement all the socket handling code already present in elements such as multisocketsink, etc. This, in turn, will be useful for implementing zero-copy video IPC. This meta uses the platform independent `GSocketControlMessage` API provided by GLib as a part of GIO. As a result this new meta does not require any new dependencies or any conditional compliation for portablility, although it is unlikely to do anything useful on non-UNIX platforms.
2014-10-30 15:39:21 +00:00
G_END_DECLS
#endif /* __GST_NET_CONTROL_MESSAGE_META_H__ */
Reference in a new issue Copy permalink