212c09a70e
According to W3C specification (https://w3c.github.io/webrtc-pc/#datachannel-send) we should return InvalidStateError exception when trying to send when the channel is not open. In the world of C/glib/gstreamer we don't have exceptions but have to rely on gboolean/GError instead. Introducing these calls for a change in function signature of the action signals used to send data on the datachannel. Changing the signature of the existing "send-string" and "send-data" signals would mean an immediate breaking change so instead we deprecate them. Furthermore, there is no way to express GError** as an argument to an action signal in a way that fits language bindings (pointer-to-pointer simply does not work) and we have to use regular functions instead. Therefore we introduce gst_webrtc_data_channel_send_data_full() and gst_webrtc_data_channel_send_string_full() while deprecating the old functions and corresponding signals. Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1958>
61 lines
2.6 KiB
C
61 lines
2.6 KiB
C
/* GStreamer
|
|
* Copyright (C) 2018 Matthew Waters <matthew@centricular.com>
|
|
* Copyright (C) 2020 Sebastian Dröge <sebastian@centricular.com>
|
|
*
|
|
* 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_WEBRTC_DATA_CHANNEL_H__
|
|
#define __GST_WEBRTC_DATA_CHANNEL_H__
|
|
|
|
#include <gst/gst.h>
|
|
#include <gst/webrtc/webrtc_fwd.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
GST_WEBRTC_API
|
|
GType gst_webrtc_data_channel_get_type(void);
|
|
|
|
#define GST_TYPE_WEBRTC_DATA_CHANNEL (gst_webrtc_data_channel_get_type())
|
|
#define GST_WEBRTC_DATA_CHANNEL(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_WEBRTC_DATA_CHANNEL,GstWebRTCDataChannel))
|
|
#define GST_IS_WEBRTC_DATA_CHANNEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_WEBRTC_DATA_CHANNEL))
|
|
#define GST_WEBRTC_DATA_CHANNEL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass) ,GST_TYPE_WEBRTC_DATA_CHANNEL,GstWebRTCDataChannelClass))
|
|
#define GST_IS_WEBRTC_DATA_CHANNEL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass) ,GST_TYPE_WEBRTC_DATA_CHANNEL))
|
|
#define GST_WEBRTC_DATA_CHANNEL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj) ,GST_TYPE_WEBRTC_DATA_CHANNEL,GstWebRTCDataChannelClass))
|
|
|
|
GST_WEBRTC_API
|
|
gboolean gst_webrtc_data_channel_send_data_full (GstWebRTCDataChannel * channel, GBytes * data, GError ** error);
|
|
|
|
GST_WEBRTC_API
|
|
gboolean gst_webrtc_data_channel_send_string_full (GstWebRTCDataChannel * channel, const gchar * str, GError ** error);
|
|
|
|
GST_WEBRTC_API
|
|
void gst_webrtc_data_channel_close (GstWebRTCDataChannel * channel);
|
|
|
|
#ifndef GST_REMOVE_DEPRECATED
|
|
GST_WEBRTC_DEPRECATED_FOR(gst_webrtc_data_channel_send_data_full)
|
|
void gst_webrtc_data_channel_send_data (GstWebRTCDataChannel * channel, GBytes * data);
|
|
|
|
GST_WEBRTC_DEPRECATED_FOR(gst_webrtc_data_channel_send_string_full)
|
|
void gst_webrtc_data_channel_send_string (GstWebRTCDataChannel * channel, const gchar * str);
|
|
#endif
|
|
|
|
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstWebRTCDataChannel, g_object_unref)
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GST_WEBRTC_DATA_CHANNEL_H__ */
|