luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-02 07:36:17 +01:00
Code Issues Packages Projects Releases Wiki Activity
bc5fe41dec
glib/gio/gsocket.h

195 lines
9.5 KiB
C
Raw Normal View History

Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
/*
* Copyright © 2008 Christian Kellner, Samuel Cormier-Iijima
* Copyright © 2009 Codethink Limited
*
* This library 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 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
* 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: Christian Kellner <gicmo@gnome.org>
* Samuel Cormier-Iijima <sciyoshi@gmail.com>
* Ryan Lortie <desrt@desrt.ca>
*/
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif
#ifndef __G_SOCKET_H__
#define __G_SOCKET_H__
#include <gio/giotypes.h>
G_BEGIN_DECLS
#define G_TYPE_SOCKET (g_socket_get_type ())
#define G_SOCKET(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
G_TYPE_SOCKET, GSocket))
#define G_SOCKET_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), \
G_TYPE_SOCKET, GSocketClass))
#define G_IS_SOCKET(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
G_TYPE_SOCKET))
#define G_IS_SOCKET_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), \
G_TYPE_SOCKET))
#define G_SOCKET_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), \
G_TYPE_SOCKET, GSocketClass))
typedef struct _GSocketPrivate GSocketPrivate;
typedef struct _GSocketClass GSocketClass;
struct _GSocketClass
{
GObjectClass parent_class;
/*< private >*/
/* Padding for future expansion */
void (*_g_reserved1) (void);
void (*_g_reserved2) (void);
void (*_g_reserved3) (void);
void (*_g_reserved4) (void);
void (*_g_reserved5) (void);
void (*_g_reserved6) (void);
void (*_g_reserved7) (void);
void (*_g_reserved8) (void);
void (*_g_reserved9) (void);
void (*_g_reserved10) (void);
};
struct _GSocket
{
GObject parent_instance;
GSocketPrivate *priv;
};
GType g_socket_get_type (void) G_GNUC_CONST;
GSocket * g_socket_new (GSocketFamily family,
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 protocol,
Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
GError **error);
GSocket * g_socket_new_from_fd (gint fd,
GError **error);
int g_socket_get_fd (GSocket *socket);
GSocketFamily g_socket_get_family (GSocket *socket);
GSocketType g_socket_get_socket_type (GSocket *socket);
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_get_protocol (GSocket *socket);
Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
GSocketAddress * g_socket_get_local_address (GSocket *socket,
GError **error);
GSocketAddress * g_socket_get_remote_address (GSocket *socket,
GError **error);
void g_socket_set_blocking (GSocket *socket,
gboolean blocking);
gboolean g_socket_get_blocking (GSocket *socket);
void g_socket_set_keepalive (GSocket *socket,
gboolean keepalive);
gboolean g_socket_get_keepalive (GSocket *socket);
gint g_socket_get_listen_backlog (GSocket *socket);
void g_socket_set_listen_backlog (GSocket *socket,
gint backlog);
GSocket: add support for timeouts Also add options for testing timeouts to socket test programs https://bugzilla.gnome.org/show_bug.cgi?id=587898
2009-12-31 16:29:23 +01:00
guint g_socket_get_timeout (GSocket *socket);
void g_socket_set_timeout (GSocket *socket,
guint timeout);
Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
gboolean g_socket_is_connected (GSocket *socket);
gboolean g_socket_bind (GSocket *socket,
GSocketAddress *address,
gboolean allow_reuse,
GError **error);
gboolean g_socket_connect (GSocket *socket,
GSocketAddress *address,
Add GCancellables to GSocket ops Currently, to implement cancellability correctly, all synchronous calls to GSocket must be preceded by a g_socket_condition_wait() call, (even though GSocket does this internally as well) and all asynchronous calls must do occasional manual g_cancellable_is_cancelled() checks. Since it's trivial to do these checks inside GSocket instead, and we don't particularly want to encourage people to use the APIs non-cancellably, move the cancellation support into GSocket and simplify the existing callers. http://bugzilla.gnome.org/show_bug.cgi?id=586797
2009-06-23 23:42:01 +02:00
GCancellable *cancellable,
Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
GError **error);
Rename g_socket_check_pending_error to g_socket_check_connect_result This is only used for connect anyway, and this describes the operation better.
2009-05-19 10:57:58 +02:00
gboolean g_socket_check_connect_result (GSocket *socket,
Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
GError **error);
GIOCondition g_socket_condition_check (GSocket *socket,
GIOCondition condition);
gboolean g_socket_condition_wait (GSocket *socket,
GIOCondition condition,
GCancellable *cancellable,
GError **error);
GSocket * g_socket_accept (GSocket *socket,
Add GCancellables to GSocket ops Currently, to implement cancellability correctly, all synchronous calls to GSocket must be preceded by a g_socket_condition_wait() call, (even though GSocket does this internally as well) and all asynchronous calls must do occasional manual g_cancellable_is_cancelled() checks. Since it's trivial to do these checks inside GSocket instead, and we don't particularly want to encourage people to use the APIs non-cancellably, move the cancellation support into GSocket and simplify the existing callers. http://bugzilla.gnome.org/show_bug.cgi?id=586797
2009-06-23 23:42:01 +02:00
GCancellable *cancellable,
Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
GError **error);
gboolean g_socket_listen (GSocket *socket,
GError **error);
gssize g_socket_receive (GSocket *socket,
gchar *buffer,
gsize size,
Add GCancellables to GSocket ops Currently, to implement cancellability correctly, all synchronous calls to GSocket must be preceded by a g_socket_condition_wait() call, (even though GSocket does this internally as well) and all asynchronous calls must do occasional manual g_cancellable_is_cancelled() checks. Since it's trivial to do these checks inside GSocket instead, and we don't particularly want to encourage people to use the APIs non-cancellably, move the cancellation support into GSocket and simplify the existing callers. http://bugzilla.gnome.org/show_bug.cgi?id=586797
2009-06-23 23:42:01 +02:00
GCancellable *cancellable,
Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
GError **error);
gssize g_socket_receive_from (GSocket *socket,
GSocketAddress **address,
gchar *buffer,
gsize size,
Add GCancellables to GSocket ops Currently, to implement cancellability correctly, all synchronous calls to GSocket must be preceded by a g_socket_condition_wait() call, (even though GSocket does this internally as well) and all asynchronous calls must do occasional manual g_cancellable_is_cancelled() checks. Since it's trivial to do these checks inside GSocket instead, and we don't particularly want to encourage people to use the APIs non-cancellably, move the cancellation support into GSocket and simplify the existing callers. http://bugzilla.gnome.org/show_bug.cgi?id=586797
2009-06-23 23:42:01 +02:00
GCancellable *cancellable,
Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
GError **error);
gssize g_socket_send (GSocket *socket,
const gchar *buffer,
gsize size,
Add GCancellables to GSocket ops Currently, to implement cancellability correctly, all synchronous calls to GSocket must be preceded by a g_socket_condition_wait() call, (even though GSocket does this internally as well) and all asynchronous calls must do occasional manual g_cancellable_is_cancelled() checks. Since it's trivial to do these checks inside GSocket instead, and we don't particularly want to encourage people to use the APIs non-cancellably, move the cancellation support into GSocket and simplify the existing callers. http://bugzilla.gnome.org/show_bug.cgi?id=586797
2009-06-23 23:42:01 +02:00
GCancellable *cancellable,
Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
GError **error);
gssize g_socket_send_to (GSocket *socket,
GSocketAddress *address,
const gchar *buffer,
gsize size,
Add GCancellables to GSocket ops Currently, to implement cancellability correctly, all synchronous calls to GSocket must be preceded by a g_socket_condition_wait() call, (even though GSocket does this internally as well) and all asynchronous calls must do occasional manual g_cancellable_is_cancelled() checks. Since it's trivial to do these checks inside GSocket instead, and we don't particularly want to encourage people to use the APIs non-cancellably, move the cancellation support into GSocket and simplify the existing callers. http://bugzilla.gnome.org/show_bug.cgi?id=586797
2009-06-23 23:42:01 +02:00
GCancellable *cancellable,
Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
GError **error);
gssize g_socket_receive_message (GSocket *socket,
GSocketAddress **address,
GInputVector *vectors,
gint num_vectors,
GSocketControlMessage ***messages,
gint *num_messages,
gint *flags,
Add GCancellables to GSocket ops Currently, to implement cancellability correctly, all synchronous calls to GSocket must be preceded by a g_socket_condition_wait() call, (even though GSocket does this internally as well) and all asynchronous calls must do occasional manual g_cancellable_is_cancelled() checks. Since it's trivial to do these checks inside GSocket instead, and we don't particularly want to encourage people to use the APIs non-cancellably, move the cancellation support into GSocket and simplify the existing callers. http://bugzilla.gnome.org/show_bug.cgi?id=586797
2009-06-23 23:42:01 +02:00
GCancellable *cancellable,
Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
GError **error);
gssize g_socket_send_message (GSocket *socket,
GSocketAddress *address,
GOutputVector *vectors,
gint num_vectors,
GSocketControlMessage **messages,
gint num_messages,
gint flags,
Add GCancellables to GSocket ops Currently, to implement cancellability correctly, all synchronous calls to GSocket must be preceded by a g_socket_condition_wait() call, (even though GSocket does this internally as well) and all asynchronous calls must do occasional manual g_cancellable_is_cancelled() checks. Since it's trivial to do these checks inside GSocket instead, and we don't particularly want to encourage people to use the APIs non-cancellably, move the cancellation support into GSocket and simplify the existing callers. http://bugzilla.gnome.org/show_bug.cgi?id=586797
2009-06-23 23:42:01 +02:00
GCancellable *cancellable,
Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
GError **error);
gboolean g_socket_close (GSocket *socket,
GError **error);
Add g_socket_shutdown
2009-05-19 11:52:33 +02:00
gboolean g_socket_shutdown (GSocket *socket,
gboolean shutdown_read,
gboolean shutdown_write,
GError **error);
Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
gboolean g_socket_is_closed (GSocket *socket);
GSource * g_socket_create_source (GSocket *socket,
GIOCondition condition,
GCancellable *cancellable);
add g_socket_speaks_ipv4() Partial fix for Bug 585575.
2009-06-12 18:21:07 +02:00
gboolean g_socket_speaks_ipv4 (GSocket *socket);
Bug 617483 – Credentials passing - Make GCredentials instance and class structures private so it can't be subclassed and we don't have to worry about ABI compat issues. This also allows us to get rid of the GCredentialsPrivate struct. - Add a GCredentialsType enumeration that is used whenever exchanging pointers with the user. This allows us to support OSes with multiple native credential types. In particular, it allows supporting OSes where the native credential evolves or even changes over time. - Add g_socket_get_credentials() method. - Add tests for g_socket_get_credentials(). Right now this is in the GDBus peer-to-peer test case but we can change that later. - Move GTcpConnection into a separate gtk-doc page as was already half-done with GUnixConnection. Also finish the GUnixConnection move and ensure send_credentials() and receive_credentials() methods are in the docs. Also nuke comment about GTcpConnection being empty compared to its superclass. Signed-off-by: David Zeuthen <davidz@redhat.com>
2010-07-20 20:02:14 +02:00
GCredentials *g_socket_get_credentials (GSocket *socket,
GError **error);
Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
Always do async vs sync correctly in GSocketConnection streams Previously if a GSocketConnection had a blocking GSocket, it would sometimes block during asynchonous I/O, and if it had a non-blocking socket, it would sometimes return G_IO_ERROR_WOULD_BLOCK from synchronous I/O. This fixes the connection to not depend on the socket state. https://bugzilla.gnome.org/show_bug.cgi?id=616458
2010-06-24 19:09:14 +02:00
gssize g_socket_receive_with_blocking (GSocket *socket,
gchar *buffer,
gsize size,
gboolean blocking,
GCancellable *cancellable,
GError **error);
gssize g_socket_send_with_blocking (GSocket *socket,
const gchar *buffer,
gsize size,
gboolean blocking,
GCancellable *cancellable,
GError **error);
Import GInitable, GSocket and dependencies from gnio This adds: GInitable - failable object constructor interface GAsyncInitable - async failable object constructor interface GSocket - Platform independent lowlevel berkely socket style object GSocketControlMessage - For passing control messages over GSocket GUnixFDMessage - unix fd passing socket control message Some changes were done during the import from gnio to make things work in glib. For instance, types were moved to other headers, header file boiler plate were updated to glib style and gio.symbols stuff was added.
2009-05-14 15:26:37 +02:00
G_END_DECLS
#endif /* __G_SOCKET_H__ */
Reference in New Issue Copy Permalink