luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-05 08:56:16 +01:00
Code Issues Packages Projects Releases Wiki Activity
21e049b253
glib/gio/gsocketclient.h

164 lines
10 KiB
C
Raw Normal View History

Import all the highlevel socket classes from gnio
2009-05-15 21:26:24 +02:00
/* GIO - GLib Input, Output and Streaming Library
*
* Copyright © 2008, 2009 Codethink Limited
* Copyright © 2009 Red Hat, Inc
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation; either version 2 of the licence 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307, USA.
*
* Authors: Ryan Lortie <desrt@desrt.ca>
* Alexander Larsson <alexl@redhat.com>
*/
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif
#ifndef __G_SOCKET_CLIENT_H__
#define __G_SOCKET_CLIENT_H__
#include <gio/giotypes.h>
G_BEGIN_DECLS
#define G_TYPE_SOCKET_CLIENT (g_socket_client_get_type ())
#define G_SOCKET_CLIENT(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
G_TYPE_SOCKET_CLIENT, GSocketClient))
#define G_SOCKET_CLIENT_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), \
G_TYPE_SOCKET_CLIENT, GSocketClientClass))
#define G_IS_SOCKET_CLIENT(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
G_TYPE_SOCKET_CLIENT))
#define G_IS_SOCKET_CLIENT_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), \
G_TYPE_SOCKET_CLIENT))
#define G_SOCKET_CLIENT_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), \
G_TYPE_SOCKET_CLIENT, GSocketClientClass))
typedef struct _GSocketClientPrivate GSocketClientPrivate;
typedef struct _GSocketClientClass GSocketClientClass;
struct _GSocketClientClass
{
GObjectClass parent_class;
Add GSocketClient::event, for tracking socket client status This can be used for debugging, or for progress UIs ("Connecting to example.com..."), or to do low-level tweaking on the connection at various points in the process. https://bugzilla.gnome.org/show_bug.cgi?id=665805
2010-08-20 19:04:19 +02:00
void (* event) (GSocketClient *client,
GSocketClientEvent event,
GSocketConnectable *connectable,
GIOStream *connection);
Import all the highlevel socket classes from gnio
2009-05-15 21:26:24 +02:00
/* Padding for future expansion */
void (*_g_reserved1) (void);
void (*_g_reserved2) (void);
void (*_g_reserved3) (void);
void (*_g_reserved4) (void);
};
struct _GSocketClient
{
GObject parent_instance;
GSocketClientPrivate *priv;
};
GType g_socket_client_get_type (void) G_GNUC_CONST;
GSocketClient *g_socket_client_new (void);
GSocketFamily g_socket_client_get_family (GSocketClient *client);
void g_socket_client_set_family (GSocketClient *client,
GSocketFamily family);
GSocketType g_socket_client_get_socket_type (GSocketClient *client);
void g_socket_client_set_socket_type (GSocketClient *client,
GSocketType type);
Remove protocol names, instead use an enum with common protocols The whole protocol name thing is pretty weird. The getprotobyname functions seem to only specify one mapping for name <-> ids, so all families/types must use the same values. Plus the values used for the protocols are standardized by IANA, so are always the same. So, we drop using names for protocols, intead introducing an enum with a few commonly availible and used protocols.
2009-05-20 12:01:29 +02:00
GSocketProtocol g_socket_client_get_protocol (GSocketClient *client);
Import all the highlevel socket classes from gnio
2009-05-15 21:26:24 +02:00
void g_socket_client_set_protocol (GSocketClient *client,
Remove protocol names, instead use an enum with common protocols The whole protocol name thing is pretty weird. The getprotobyname functions seem to only specify one mapping for name <-> ids, so all families/types must use the same values. Plus the values used for the protocols are standardized by IANA, so are always the same. So, we drop using names for protocols, intead introducing an enum with a few commonly availible and used protocols.
2009-05-20 12:01:29 +02:00
GSocketProtocol protocol);
Import all the highlevel socket classes from gnio
2009-05-15 21:26:24 +02:00
GSocketAddress *g_socket_client_get_local_address (GSocketClient *client);
void g_socket_client_set_local_address (GSocketClient *client,
GSocketAddress *address);
GSocketClient: add a timeout property GSocket has a timeout flag now, but when using GSocketClient there was no way to set the timeout until after connecting (or failing). Fix that by adding a timeout property to GSocketClient.
2010-08-14 21:04:24 +02:00
guint g_socket_client_get_timeout (GSocketClient *client);
void g_socket_client_set_timeout (GSocketClient *client,
guint timeout);
Hooked proxy enumeration into GSocketClient This functionnallity can be disabled using property enable-proxy. It enumerates addresses using GSocketConnectable::proxy_enumerate() instead of enumerate(). When the returned address is of type GProxyAddress (a type based on GInetSocketAddress), it gets the proxy protocol handler using g_proxy_get_default_for_protocol() and call connect() on it. Reviewed-by: Dan Winship <danw@gnome.org>
2010-08-10 22:48:45 +02:00
gboolean g_socket_client_get_enable_proxy (GSocketClient *client);
void g_socket_client_set_enable_proxy (GSocketClient *client,
gboolean enable);
Import all the highlevel socket classes from gnio
2009-05-15 21:26:24 +02:00
Add initial TLS (SSL) support to gio This adds an extension point for TLS connections to gio, with a gnutls-based implementation in glib-networking. Full TLS support is still a work in progress; the current API is missing some features, and parts of it may still be changed before 2.28. https://bugzilla.gnome.org/show_bug.cgi?id=588189
2009-12-21 20:50:32 +01:00
gboolean g_socket_client_get_tls (GSocketClient *client);
void g_socket_client_set_tls (GSocketClient *client,
gboolean tls);
GTlsCertificateFlags g_socket_client_get_tls_validation_flags (GSocketClient *client);
void g_socket_client_set_tls_validation_flags (GSocketClient *client,
GTlsCertificateFlags flags);
Import all the highlevel socket classes from gnio
2009-05-15 21:26:24 +02:00
GSocketConnection * g_socket_client_connect (GSocketClient *client,
GSocketConnectable *connectable,
GCancellable *cancellable,
GError **error);
GSocketConnection * g_socket_client_connect_to_host (GSocketClient *client,
Documentation and coding style fixups Lots of pedanic changes.
2009-05-28 00:20:08 +02:00
const gchar *host_and_port,
make all APIs that take inet port arguments take a guint16
2009-06-12 15:57:51 +02:00
guint16 default_port,
Import all the highlevel socket classes from gnio
2009-05-15 21:26:24 +02:00
GCancellable *cancellable,
GError **error);
Add helper functions for connecting to service (#583061)
2009-05-20 12:41:50 +02:00
GSocketConnection * g_socket_client_connect_to_service (GSocketClient *client,
Documentation and coding style fixups Lots of pedanic changes.
2009-05-28 00:20:08 +02:00
const gchar *domain,
const gchar *service,
Add helper functions for connecting to service (#583061)
2009-05-20 12:41:50 +02:00
GCancellable *cancellable,
GError **error);
Implemented g_socket_client_connect_to_uri() method Using this rather than g_socket_client_connect() or g_socket_client_connect_to_host() allows #GSocketClient to determine when to use application-specific proxy protocols. Reviewed-by: Dan Winship <danw@gnome.org>
2010-04-30 00:51:42 +02:00
GSocketConnection * g_socket_client_connect_to_uri (GSocketClient *client,
const gchar *uri,
guint16 default_port,
GCancellable *cancellable,
GError **error);
Import all the highlevel socket classes from gnio
2009-05-15 21:26:24 +02:00
void g_socket_client_connect_async (GSocketClient *client,
GSocketConnectable *connectable,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
GSocketConnection * g_socket_client_connect_finish (GSocketClient *client,
GAsyncResult *result,
GError **error);
void g_socket_client_connect_to_host_async (GSocketClient *client,
Documentation and coding style fixups Lots of pedanic changes.
2009-05-28 00:20:08 +02:00
const gchar *host_and_port,
make all APIs that take inet port arguments take a guint16
2009-06-12 15:57:51 +02:00
guint16 default_port,
Import all the highlevel socket classes from gnio
2009-05-15 21:26:24 +02:00
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
GSocketConnection * g_socket_client_connect_to_host_finish (GSocketClient *client,
GAsyncResult *result,
GError **error);
Add helper functions for connecting to service (#583061)
2009-05-20 12:41:50 +02:00
void g_socket_client_connect_to_service_async (GSocketClient *client,
Documentation and coding style fixups Lots of pedanic changes.
2009-05-28 00:20:08 +02:00
const gchar *domain,
const gchar *service,
Add helper functions for connecting to service (#583061)
2009-05-20 12:41:50 +02:00
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
GSocketConnection * g_socket_client_connect_to_service_finish (GSocketClient *client,
GAsyncResult *result,
GError **error);
Implemented g_socket_client_connect_to_uri() method Using this rather than g_socket_client_connect() or g_socket_client_connect_to_host() allows #GSocketClient to determine when to use application-specific proxy protocols. Reviewed-by: Dan Winship <danw@gnome.org>
2010-04-30 00:51:42 +02:00
void g_socket_client_connect_to_uri_async (GSocketClient *client,
const gchar *uri,
guint16 default_port,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
GSocketConnection * g_socket_client_connect_to_uri_finish (GSocketClient *client,
GAsyncResult *result,
GError **error);
Add support for g_socket_client_add_application_proxy() This allow application to take control over certain proxy protocol handling. When a proxy protocol must be used and is found in the application proxies, GSocketClient will simply TCP connect to the proxy server and return the connection. Reviewed-by: Dan Winship <danw@gnome.org>
2010-08-19 22:23:50 +02:00
void g_socket_client_add_application_proxy (GSocketClient *client,
const gchar *protocol);
Add helper functions for connecting to service (#583061)
2009-05-20 12:41:50 +02:00
Import all the highlevel socket classes from gnio
2009-05-15 21:26:24 +02:00
G_END_DECLS
#endif /* __G_SOCKET_CLIENT_H___ */
Reference in New Issue Copy Permalink