Blame gio/gtcpwrapperconnection.c

Packit ae235b
/* GIO - GLib Input, Output and Streaming Library
Packit ae235b
 *
Packit ae235b
 * Copyright © 2010 Collabora Ltd.
Packit ae235b
 *
Packit ae235b
 * This library is free software; you can redistribute it and/or
Packit ae235b
 * modify it under the terms of the GNU Lesser General Public
Packit ae235b
 * License as published by the Free Software Foundation; either
Packit ae235b
 * version 2.1 of the License, or (at your option) any later version.
Packit ae235b
 *
Packit ae235b
 * This library is distributed in the hope that it will be useful,
Packit ae235b
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit ae235b
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit ae235b
 * Lesser General Public License for more details.
Packit ae235b
 *
Packit ae235b
 * You should have received a copy of the GNU Lesser General
Packit ae235b
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
Packit ae235b
 *
Packit ae235b
 * Authors: Nicolas Dufresne <nicolas.dufresne@colllabora.co.uk>
Packit ae235b
 */
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * SECTION:gtcpwrapperconnection
Packit ae235b
 * @title: GTcpWrapperConnection
Packit ae235b
 * @short_description: Wrapper for non-GSocketConnection-based,
Packit ae235b
 *     GSocket-based GIOStreams
Packit ae235b
 * @include: gio/gio.h
Packit ae235b
 * @see_also: #GSocketConnection.
Packit ae235b
 *
Packit ae235b
 * A #GTcpWrapperConnection can be used to wrap a #GIOStream that is
Packit ae235b
 * based on a #GSocket, but which is not actually a
Packit ae235b
 * #GSocketConnection. This is used by #GSocketClient so that it can
Packit ae235b
 * always return a #GSocketConnection, even when the connection it has
Packit ae235b
 * actually created is not directly a #GSocketConnection.
Packit ae235b
 *
Packit ae235b
 * Since: 2.28
Packit ae235b
 */
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * GTcpWrapperConnection:
Packit ae235b
 *
Packit ae235b
 * #GTcpWrapperConnection is an opaque data structure and can only be accessed
Packit ae235b
 * using the following functions.
Packit ae235b
 **/
Packit ae235b
Packit ae235b
#include "config.h"
Packit ae235b
Packit ae235b
#include "gtcpwrapperconnection.h"
Packit ae235b
Packit ae235b
#include "gtcpconnection.h"
Packit ae235b
#include "glibintl.h"
Packit ae235b
Packit ae235b
struct _GTcpWrapperConnectionPrivate
Packit ae235b
{
Packit ae235b
  GIOStream *base_io_stream;
Packit ae235b
};
Packit ae235b
Packit ae235b
G_DEFINE_TYPE_WITH_PRIVATE (GTcpWrapperConnection, g_tcp_wrapper_connection, G_TYPE_TCP_CONNECTION)
Packit ae235b
Packit ae235b
enum
Packit ae235b
{
Packit ae235b
  PROP_NONE,
Packit ae235b
  PROP_BASE_IO_STREAM
Packit ae235b
};
Packit ae235b
Packit ae235b
static GInputStream *
Packit ae235b
g_tcp_wrapper_connection_get_input_stream (GIOStream *io_stream)
Packit ae235b
{
Packit ae235b
  GTcpWrapperConnection *connection = G_TCP_WRAPPER_CONNECTION (io_stream);
Packit ae235b
Packit ae235b
  return g_io_stream_get_input_stream (connection->priv->base_io_stream);
Packit ae235b
}
Packit ae235b
Packit ae235b
static GOutputStream *
Packit ae235b
g_tcp_wrapper_connection_get_output_stream (GIOStream *io_stream)
Packit ae235b
{
Packit ae235b
  GTcpWrapperConnection *connection = G_TCP_WRAPPER_CONNECTION (io_stream);
Packit ae235b
Packit ae235b
  return g_io_stream_get_output_stream (connection->priv->base_io_stream);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_tcp_wrapper_connection_get_property (GObject    *object,
Packit ae235b
				       guint       prop_id,
Packit ae235b
				       GValue     *value,
Packit ae235b
				       GParamSpec *pspec)
Packit ae235b
{
Packit ae235b
  GTcpWrapperConnection *connection = G_TCP_WRAPPER_CONNECTION (object);
Packit ae235b
Packit ae235b
  switch (prop_id)
Packit ae235b
    {
Packit ae235b
     case PROP_BASE_IO_STREAM:
Packit ae235b
      g_value_set_object (value, connection->priv->base_io_stream);
Packit ae235b
      break;
Packit ae235b
Packit ae235b
     default:
Packit ae235b
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_tcp_wrapper_connection_set_property (GObject      *object,
Packit ae235b
                                        guint         prop_id,
Packit ae235b
                                        const GValue *value,
Packit ae235b
                                        GParamSpec   *pspec)
Packit ae235b
{
Packit ae235b
  GTcpWrapperConnection *connection = G_TCP_WRAPPER_CONNECTION (object);
Packit ae235b
Packit ae235b
  switch (prop_id)
Packit ae235b
    {
Packit ae235b
     case PROP_BASE_IO_STREAM:
Packit ae235b
      connection->priv->base_io_stream = g_value_dup_object (value);
Packit ae235b
      break;
Packit ae235b
Packit ae235b
     default:
Packit ae235b
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_tcp_wrapper_connection_finalize (GObject *object)
Packit ae235b
{
Packit ae235b
  GTcpWrapperConnection *connection = G_TCP_WRAPPER_CONNECTION (object);
Packit ae235b
Packit ae235b
  if (connection->priv->base_io_stream)
Packit ae235b
    g_object_unref (connection->priv->base_io_stream);
Packit ae235b
Packit ae235b
  G_OBJECT_CLASS (g_tcp_wrapper_connection_parent_class)->finalize (object);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_tcp_wrapper_connection_class_init (GTcpWrapperConnectionClass *klass)
Packit ae235b
{
Packit ae235b
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
Packit ae235b
  GIOStreamClass *stream_class = G_IO_STREAM_CLASS (klass);
Packit ae235b
Packit ae235b
  gobject_class->set_property = g_tcp_wrapper_connection_set_property;
Packit ae235b
  gobject_class->get_property = g_tcp_wrapper_connection_get_property;
Packit ae235b
  gobject_class->finalize = g_tcp_wrapper_connection_finalize;
Packit ae235b
Packit ae235b
  stream_class->get_input_stream = g_tcp_wrapper_connection_get_input_stream;
Packit ae235b
  stream_class->get_output_stream = g_tcp_wrapper_connection_get_output_stream;
Packit ae235b
Packit ae235b
  g_object_class_install_property (gobject_class,
Packit ae235b
                                   PROP_BASE_IO_STREAM,
Packit ae235b
                                   g_param_spec_object ("base-io-stream",
Packit ae235b
			                                P_("Base IO Stream"),
Packit ae235b
			                                P_("The wrapped GIOStream"),
Packit ae235b
                                                        G_TYPE_IO_STREAM,
Packit ae235b
                                                        G_PARAM_CONSTRUCT_ONLY |
Packit ae235b
                                                        G_PARAM_READWRITE |
Packit ae235b
                                                        G_PARAM_STATIC_STRINGS));
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_tcp_wrapper_connection_init (GTcpWrapperConnection *connection)
Packit ae235b
{
Packit ae235b
  connection->priv = g_tcp_wrapper_connection_get_instance_private (connection);
Packit ae235b
}
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * g_tcp_wrapper_connection_new:
Packit ae235b
 * @base_io_stream: the #GIOStream to wrap
Packit ae235b
 * @socket: the #GSocket associated with @base_io_stream
Packit ae235b
 *
Packit ae235b
 * Wraps @base_io_stream and @socket together as a #GSocketConnection.
Packit ae235b
 *
Packit ae235b
 * Returns: the new #GSocketConnection.
Packit ae235b
 *
Packit ae235b
 * Since: 2.28
Packit ae235b
 */
Packit ae235b
GSocketConnection *
Packit ae235b
g_tcp_wrapper_connection_new (GIOStream *base_io_stream,
Packit ae235b
			      GSocket   *socket)
Packit ae235b
{
Packit ae235b
  g_return_val_if_fail (G_IS_IO_STREAM (base_io_stream), NULL);
Packit ae235b
  g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
Packit ae235b
  g_return_val_if_fail (g_socket_get_family (socket) == G_SOCKET_FAMILY_IPV4 ||
Packit ae235b
			g_socket_get_family (socket) == G_SOCKET_FAMILY_IPV6, NULL);
Packit ae235b
  g_return_val_if_fail (g_socket_get_socket_type (socket) == G_SOCKET_TYPE_STREAM, NULL);
Packit ae235b
Packit ae235b
  return g_object_new (G_TYPE_TCP_WRAPPER_CONNECTION,
Packit ae235b
		       "base-io-stream", base_io_stream,
Packit ae235b
		       "socket", socket,
Packit ae235b
		       NULL);
Packit ae235b
}
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * g_tcp_wrapper_connection_get_base_io_stream:
Packit ae235b
 * @conn: a #GTcpWrapperConnection
Packit ae235b
 *
Packit ae235b
 * Get's @conn's base #GIOStream
Packit ae235b
 *
Packit ae235b
 * Returns: (transfer none): @conn's base #GIOStream
Packit ae235b
 */
Packit ae235b
GIOStream *
Packit ae235b
g_tcp_wrapper_connection_get_base_io_stream (GTcpWrapperConnection *conn)
Packit ae235b
{
Packit ae235b
  g_return_val_if_fail (G_IS_TCP_WRAPPER_CONNECTION (conn), NULL);
Packit ae235b
Packit ae235b
  return conn->priv->base_io_stream;
Packit ae235b
}