gsocket.h File Reference

#include <gio/giotypes.h>

Go to the source code of this file.

Data Structures
struct	_GSocketClass
struct	_GSocket

Macros
#define	G_TYPE_SOCKET   (g_socket_get_type ())
#define	G_SOCKET(inst)
#define	G_SOCKET_CLASS(class)
#define	G_IS_SOCKET(inst)
#define	G_IS_SOCKET_CLASS(class)
#define	G_SOCKET_GET_CLASS(inst)

Typedefs
typedef struct _GSocketPrivate	GSocketPrivate
typedef struct _GSocketClass	GSocketClass

Functions
GIO_AVAILABLE_IN_ALL GType	g_socket_get_type (void) G_GNUC_CONST
GIO_AVAILABLE_IN_ALL GSocket *	g_socket_new (GSocketFamily family, GSocketType type, GSocketProtocol protocol, GError **error)
GIO_AVAILABLE_IN_ALL GSocket *	g_socket_new_from_fd (gint fd, GError **error)
GIO_AVAILABLE_IN_ALL int	g_socket_get_fd (GSocket *socket)
GIO_AVAILABLE_IN_ALL GSocketFamily	g_socket_get_family (GSocket *socket)
GIO_AVAILABLE_IN_ALL GSocketType	g_socket_get_socket_type (GSocket *socket)
GIO_AVAILABLE_IN_ALL GSocketProtocol	g_socket_get_protocol (GSocket *socket)
GIO_AVAILABLE_IN_ALL GSocketAddress *	g_socket_get_local_address (GSocket *socket, GError **error)
GIO_AVAILABLE_IN_ALL GSocketAddress *	g_socket_get_remote_address (GSocket *socket, GError **error)
GIO_AVAILABLE_IN_ALL void	g_socket_set_blocking (GSocket *socket, gboolean blocking)
GIO_AVAILABLE_IN_ALL gboolean	g_socket_get_blocking (GSocket *socket)
GIO_AVAILABLE_IN_ALL void	g_socket_set_keepalive (GSocket *socket, gboolean keepalive)
GIO_AVAILABLE_IN_ALL gboolean	g_socket_get_keepalive (GSocket *socket)
GIO_AVAILABLE_IN_ALL gint	g_socket_get_listen_backlog (GSocket *socket)
GIO_AVAILABLE_IN_ALL void	g_socket_set_listen_backlog (GSocket *socket, gint backlog)
GIO_AVAILABLE_IN_ALL guint	g_socket_get_timeout (GSocket *socket)
GIO_AVAILABLE_IN_ALL void	g_socket_set_timeout (GSocket *socket, guint timeout)
GIO_AVAILABLE_IN_2_32 guint	g_socket_get_ttl (GSocket *socket)
GIO_AVAILABLE_IN_2_32 void	g_socket_set_ttl (GSocket *socket, guint ttl)
GIO_AVAILABLE_IN_2_32 gboolean	g_socket_get_broadcast (GSocket *socket)
GIO_AVAILABLE_IN_2_32 void	g_socket_set_broadcast (GSocket *socket, gboolean broadcast)
GIO_AVAILABLE_IN_2_32 gboolean	g_socket_get_multicast_loopback (GSocket *socket)
GIO_AVAILABLE_IN_2_32 void	g_socket_set_multicast_loopback (GSocket *socket, gboolean loopback)
GIO_AVAILABLE_IN_2_32 guint	g_socket_get_multicast_ttl (GSocket *socket)
GIO_AVAILABLE_IN_2_32 void	g_socket_set_multicast_ttl (GSocket *socket, guint ttl)
GIO_AVAILABLE_IN_ALL gboolean	g_socket_is_connected (GSocket *socket)
GIO_AVAILABLE_IN_ALL gboolean	g_socket_bind (GSocket *socket, GSocketAddress *address, gboolean allow_reuse, GError **error)
GIO_AVAILABLE_IN_2_32 gboolean	g_socket_join_multicast_group (GSocket *socket, GInetAddress *group, gboolean source_specific, const gchar *iface, GError **error)
GIO_AVAILABLE_IN_2_32 gboolean	g_socket_leave_multicast_group (GSocket *socket, GInetAddress *group, gboolean source_specific, const gchar *iface, GError **error)
GIO_AVAILABLE_IN_2_56 gboolean	g_socket_join_multicast_group_ssm (GSocket *socket, GInetAddress *group, GInetAddress *source_specific, const gchar *iface, GError **error)
GIO_AVAILABLE_IN_2_56 gboolean	g_socket_leave_multicast_group_ssm (GSocket *socket, GInetAddress *group, GInetAddress *source_specific, const gchar *iface, GError **error)
GIO_AVAILABLE_IN_ALL gboolean	g_socket_connect (GSocket *socket, GSocketAddress *address, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_ALL gboolean	g_socket_check_connect_result (GSocket *socket, GError **error)
GIO_AVAILABLE_IN_ALL gssize	g_socket_get_available_bytes (GSocket *socket)
GIO_AVAILABLE_IN_ALL GIOCondition	g_socket_condition_check (GSocket *socket, GIOCondition condition)
GIO_AVAILABLE_IN_ALL gboolean	g_socket_condition_wait (GSocket *socket, GIOCondition condition, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_2_32 gboolean	g_socket_condition_timed_wait (GSocket *socket, GIOCondition condition, gint64 timeout_us, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_ALL GSocket *	g_socket_accept (GSocket *socket, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_ALL gboolean	g_socket_listen (GSocket *socket, GError **error)
GIO_AVAILABLE_IN_ALL gssize	g_socket_receive (GSocket *socket, gchar *buffer, gsize size, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_2_80 GBytes *	g_socket_receive_bytes (GSocket *socket, gsize size, gint64 timeout_us, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_ALL gssize	g_socket_receive_from (GSocket *socket, GSocketAddress **address, gchar *buffer, gsize size, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_2_80 GBytes *	g_socket_receive_bytes_from (GSocket *socket, GSocketAddress **address, gsize size, gint64 timeout_us, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_ALL gssize	g_socket_send (GSocket *socket, const gchar *buffer, gsize size, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_ALL gssize	g_socket_send_to (GSocket *socket, GSocketAddress *address, const gchar *buffer, gsize size, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_ALL gssize	g_socket_receive_message (GSocket *socket, GSocketAddress **address, GInputVector *vectors, gint num_vectors, GSocketControlMessage ***messages, gint *num_messages, gint *flags, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_ALL gssize	g_socket_send_message (GSocket *socket, GSocketAddress *address, GOutputVector *vectors, gint num_vectors, GSocketControlMessage **messages, gint num_messages, gint flags, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_2_48 gint	g_socket_receive_messages (GSocket *socket, GInputMessage *messages, guint num_messages, gint flags, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_2_44 gint	g_socket_send_messages (GSocket *socket, GOutputMessage *messages, guint num_messages, gint flags, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_ALL gboolean	g_socket_close (GSocket *socket, GError **error)
GIO_AVAILABLE_IN_ALL gboolean	g_socket_shutdown (GSocket *socket, gboolean shutdown_read, gboolean shutdown_write, GError **error)
GIO_AVAILABLE_IN_ALL gboolean	g_socket_is_closed (GSocket *socket)
GIO_AVAILABLE_IN_ALL GSource *	g_socket_create_source (GSocket *socket, GIOCondition condition, GCancellable *cancellable)
GIO_AVAILABLE_IN_ALL gboolean	g_socket_speaks_ipv4 (GSocket *socket)
GIO_AVAILABLE_IN_ALL GCredentials *	g_socket_get_credentials (GSocket *socket, GError **error)
GIO_AVAILABLE_IN_ALL gssize	g_socket_receive_with_blocking (GSocket *socket, gchar *buffer, gsize size, gboolean blocking, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_ALL gssize	g_socket_send_with_blocking (GSocket *socket, const gchar *buffer, gsize size, gboolean blocking, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_2_60 GPollableReturn	g_socket_send_message_with_timeout (GSocket *socket, GSocketAddress *address, const GOutputVector *vectors, gint num_vectors, GSocketControlMessage **messages, gint num_messages, gint flags, gint64 timeout_us, gsize *bytes_written, GCancellable *cancellable, GError **error)
GIO_AVAILABLE_IN_2_36 gboolean	g_socket_get_option (GSocket *socket, gint level, gint optname, gint *value, GError **error)
GIO_AVAILABLE_IN_2_36 gboolean	g_socket_set_option (GSocket *socket, gint level, gint optname, gint value, GError **error)

Macro Definition Documentation

G_IS_SOCKET

#define G_IS_SOCKET

(

inst

)

Value:

                                                             (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
                                                             G_TYPE_SOCKET))

Definition at line 41 of file gsocket.h.

#define G_IS_SOCKET(inst)                                   (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
                                                             G_TYPE_SOCKET))

G_IS_SOCKET_CLASS

#define G_IS_SOCKET_CLASS

(

class

)

Value:

                                                             (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
                                                             G_TYPE_SOCKET))

Definition at line 43 of file gsocket.h.

#define G_IS_SOCKET_CLASS(class)                            (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
                                                             G_TYPE_SOCKET))

G_SOCKET

#define G_SOCKET

(

inst

)

Value:

                                                             (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
                                                             G_TYPE_SOCKET, GSocket))

Definition at line 37 of file gsocket.h.

#define G_SOCKET(inst)                                      (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
                                                             G_TYPE_SOCKET, GSocket))

G_SOCKET_CLASS

#define G_SOCKET_CLASS

(

class

)

Value:

                                                             (G_TYPE_CHECK_CLASS_CAST ((class),                       \
                                                             G_TYPE_SOCKET, GSocketClass))

Definition at line 39 of file gsocket.h.

#define G_SOCKET_CLASS(class)                               (G_TYPE_CHECK_CLASS_CAST ((class),                       \
                                                             G_TYPE_SOCKET, GSocketClass))

G_SOCKET_GET_CLASS

#define G_SOCKET_GET_CLASS

(

inst

)

Value:

                                                             (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
                                                             G_TYPE_SOCKET, GSocketClass))

Definition at line 45 of file gsocket.h.

#define G_SOCKET_GET_CLASS(inst)                            (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
                                                             G_TYPE_SOCKET, GSocketClass))

G_TYPE_SOCKET

#define G_TYPE_SOCKET   (g_socket_get_type ())

Definition at line 36 of file gsocket.h.

Typedef Documentation

GSocketClass

typedef struct _GSocketClass GSocketClass

Definition at line 49 of file gsocket.h.

GSocketPrivate

typedef struct _GSocketPrivate GSocketPrivate

Definition at line 48 of file gsocket.h.

Function Documentation

g_socket_accept()

GIO_AVAILABLE_IN_ALL GSocket * g_socket_accept	(	GSocket *	socket,
		GCancellable *	cancellable,
		GError **	error )

g_socket_bind()

GIO_AVAILABLE_IN_ALL gboolean g_socket_bind	(	GSocket *	socket,
		GSocketAddress *	address,
		gboolean	allow_reuse,
		GError **	error )

g_socket_check_connect_result()

GIO_AVAILABLE_IN_ALL gboolean g_socket_check_connect_result	(	GSocket *	socket,
		GError **	error )

g_socket_close()

GIO_AVAILABLE_IN_ALL gboolean g_socket_close	(	GSocket *	socket,
		GError **	error )

g_socket_condition_check()

GIO_AVAILABLE_IN_ALL GIOCondition g_socket_condition_check	(	GSocket *	socket,
		GIOCondition	condition )

g_socket_condition_timed_wait()

GIO_AVAILABLE_IN_2_32 gboolean g_socket_condition_timed_wait	(	GSocket *	socket,
		GIOCondition	condition,
		gint64	timeout_us,
		GCancellable *	cancellable,
		GError **	error )

g_socket_condition_wait()

GIO_AVAILABLE_IN_ALL gboolean g_socket_condition_wait	(	GSocket *	socket,
		GIOCondition	condition,
		GCancellable *	cancellable,
		GError **	error )

g_socket_connect()

GIO_AVAILABLE_IN_ALL gboolean g_socket_connect	(	GSocket *	socket,
		GSocketAddress *	address,
		GCancellable *	cancellable,
		GError **	error )

g_socket_create_source()

GIO_AVAILABLE_IN_ALL GSource * g_socket_create_source	(	GSocket *	socket,
		GIOCondition	condition,
		GCancellable *	cancellable )

g_socket_get_available_bytes()

GIO_AVAILABLE_IN_ALL gssize g_socket_get_available_bytes

(

GSocket *

socket

)

g_socket_get_blocking()

GIO_AVAILABLE_IN_ALL gboolean g_socket_get_blocking

(

GSocket *

socket

)

g_socket_get_broadcast()

GIO_AVAILABLE_IN_2_32 gboolean g_socket_get_broadcast

(

GSocket *

socket

)

g_socket_get_credentials()

GIO_AVAILABLE_IN_ALL GCredentials * g_socket_get_credentials	(	GSocket *	socket,
		GError **	error )

g_socket_get_family()

GIO_AVAILABLE_IN_ALL GSocketFamily g_socket_get_family

(

GSocket *

socket

)

g_socket_get_fd()

GIO_AVAILABLE_IN_ALL int g_socket_get_fd

(

GSocket *

socket

)

g_socket_get_keepalive()

GIO_AVAILABLE_IN_ALL gboolean g_socket_get_keepalive

(

GSocket *

socket

)

g_socket_get_listen_backlog()

GIO_AVAILABLE_IN_ALL gint g_socket_get_listen_backlog

(

GSocket *

socket

)

g_socket_get_local_address()

GIO_AVAILABLE_IN_ALL GSocketAddress * g_socket_get_local_address	(	GSocket *	socket,
		GError **	error )

g_socket_get_multicast_loopback()

GIO_AVAILABLE_IN_2_32 gboolean g_socket_get_multicast_loopback

(

GSocket *

socket

)

g_socket_get_multicast_ttl()

GIO_AVAILABLE_IN_2_32 guint g_socket_get_multicast_ttl

(

GSocket *

socket

)

g_socket_get_option()

GIO_AVAILABLE_IN_2_36 gboolean g_socket_get_option	(	GSocket *	socket,
		gint	level,
		gint	optname,
		gint *	value,
		GError **	error )

g_socket_get_protocol()

GIO_AVAILABLE_IN_ALL GSocketProtocol g_socket_get_protocol

(

GSocket *

socket

)

g_socket_get_remote_address()

GIO_AVAILABLE_IN_ALL GSocketAddress * g_socket_get_remote_address	(	GSocket *	socket,
		GError **	error )

g_socket_get_socket_type()

GIO_AVAILABLE_IN_ALL GSocketType g_socket_get_socket_type

(

GSocket *

socket

)

g_socket_get_timeout()

GIO_AVAILABLE_IN_ALL guint g_socket_get_timeout

(

GSocket *

socket

)

g_socket_get_ttl()

GIO_AVAILABLE_IN_2_32 guint g_socket_get_ttl

(

GSocket *

socket

)

g_socket_get_type()

GIO_AVAILABLE_IN_ALL GType g_socket_get_type

(

void

)

g_socket_is_closed()

GIO_AVAILABLE_IN_ALL gboolean g_socket_is_closed

(

GSocket *

socket

)

g_socket_is_connected()

GIO_AVAILABLE_IN_ALL gboolean g_socket_is_connected

(

GSocket *

socket

)

g_socket_join_multicast_group()

GIO_AVAILABLE_IN_2_32 gboolean g_socket_join_multicast_group	(	GSocket *	socket,
		GInetAddress *	group,
		gboolean	source_specific,
		const gchar *	iface,
		GError **	error )

g_socket_join_multicast_group_ssm()

GIO_AVAILABLE_IN_2_56 gboolean g_socket_join_multicast_group_ssm	(	GSocket *	socket,
		GInetAddress *	group,
		GInetAddress *	source_specific,
		const gchar *	iface,
		GError **	error )

g_socket_leave_multicast_group()

GIO_AVAILABLE_IN_2_32 gboolean g_socket_leave_multicast_group	(	GSocket *	socket,
		GInetAddress *	group,
		gboolean	source_specific,
		const gchar *	iface,
		GError **	error )

g_socket_leave_multicast_group_ssm()

GIO_AVAILABLE_IN_2_56 gboolean g_socket_leave_multicast_group_ssm	(	GSocket *	socket,
		GInetAddress *	group,
		GInetAddress *	source_specific,
		const gchar *	iface,
		GError **	error )

g_socket_listen()

GIO_AVAILABLE_IN_ALL gboolean g_socket_listen	(	GSocket *	socket,
		GError **	error )

g_socket_new()

GIO_AVAILABLE_IN_ALL GSocket * g_socket_new	(	GSocketFamily	family,
		GSocketType	type,
		GSocketProtocol	protocol,
		GError **	error )

g_socket_new_from_fd()

GIO_AVAILABLE_IN_ALL GSocket * g_socket_new_from_fd	(	gint	fd,
		GError **	error )

g_socket_receive()

GIO_AVAILABLE_IN_ALL gssize g_socket_receive	(	GSocket *	socket,
		gchar *	buffer,
		gsize	size,
		GCancellable *	cancellable,
		GError **	error )

g_socket_receive_bytes()

GIO_AVAILABLE_IN_2_80 GBytes * g_socket_receive_bytes	(	GSocket *	socket,
		gsize	size,
		gint64	timeout_us,
		GCancellable *	cancellable,
		GError **	error )

g_socket_receive_bytes_from()

GIO_AVAILABLE_IN_2_80 GBytes * g_socket_receive_bytes_from	(	GSocket *	socket,
		GSocketAddress **	address,
		gsize	size,
		gint64	timeout_us,
		GCancellable *	cancellable,
		GError **	error )

g_socket_receive_from()

GIO_AVAILABLE_IN_ALL gssize g_socket_receive_from	(	GSocket *	socket,
		GSocketAddress **	address,
		gchar *	buffer,
		gsize	size,
		GCancellable *	cancellable,
		GError **	error )

g_socket_receive_message()

GIO_AVAILABLE_IN_ALL gssize g_socket_receive_message	(	GSocket *	socket,
		GSocketAddress **	address,
		GInputVector *	vectors,
		gint	num_vectors,
		GSocketControlMessage ***	messages,
		gint *	num_messages,
		gint *	flags,
		GCancellable *	cancellable,
		GError **	error )

g_socket_receive_messages()

GIO_AVAILABLE_IN_2_48 gint g_socket_receive_messages	(	GSocket *	socket,
		GInputMessage *	messages,
		guint	num_messages,
		gint	flags,
		GCancellable *	cancellable,
		GError **	error )

g_socket_receive_with_blocking()

GIO_AVAILABLE_IN_ALL gssize g_socket_receive_with_blocking	(	GSocket *	socket,
		gchar *	buffer,
		gsize	size,
		gboolean	blocking,
		GCancellable *	cancellable,
		GError **	error )

g_socket_send()

GIO_AVAILABLE_IN_ALL gssize g_socket_send	(	GSocket *	socket,
		const gchar *	buffer,
		gsize	size,
		GCancellable *	cancellable,
		GError **	error )

g_socket_send_message()

GIO_AVAILABLE_IN_ALL gssize g_socket_send_message	(	GSocket *	socket,
		GSocketAddress *	address,
		GOutputVector *	vectors,
		gint	num_vectors,
		GSocketControlMessage **	messages,
		gint	num_messages,
		gint	flags,
		GCancellable *	cancellable,
		GError **	error )

g_socket_send_message_with_timeout()

GIO_AVAILABLE_IN_2_60 GPollableReturn g_socket_send_message_with_timeout	(	GSocket *	socket,
		GSocketAddress *	address,
		const GOutputVector *	vectors,
		gint	num_vectors,
		GSocketControlMessage **	messages,
		gint	num_messages,
		gint	flags,
		gint64	timeout_us,
		gsize *	bytes_written,
		GCancellable *	cancellable,
		GError **	error )

g_socket_send_messages()

GIO_AVAILABLE_IN_2_44 gint g_socket_send_messages	(	GSocket *	socket,
		GOutputMessage *	messages,
		guint	num_messages,
		gint	flags,
		GCancellable *	cancellable,
		GError **	error )

g_socket_send_to()

GIO_AVAILABLE_IN_ALL gssize g_socket_send_to	(	GSocket *	socket,
		GSocketAddress *	address,
		const gchar *	buffer,
		gsize	size,
		GCancellable *	cancellable,
		GError **	error )

g_socket_send_with_blocking()

GIO_AVAILABLE_IN_ALL gssize g_socket_send_with_blocking	(	GSocket *	socket,
		const gchar *	buffer,
		gsize	size,
		gboolean	blocking,
		GCancellable *	cancellable,
		GError **	error )

g_socket_set_blocking()

GIO_AVAILABLE_IN_ALL void g_socket_set_blocking	(	GSocket *	socket,
		gboolean	blocking )

g_socket_set_broadcast()

GIO_AVAILABLE_IN_2_32 void g_socket_set_broadcast	(	GSocket *	socket,
		gboolean	broadcast )

g_socket_set_keepalive()

GIO_AVAILABLE_IN_ALL void g_socket_set_keepalive	(	GSocket *	socket,
		gboolean	keepalive )

g_socket_set_listen_backlog()

GIO_AVAILABLE_IN_ALL void g_socket_set_listen_backlog	(	GSocket *	socket,
		gint	backlog )

g_socket_set_multicast_loopback()

GIO_AVAILABLE_IN_2_32 void g_socket_set_multicast_loopback	(	GSocket *	socket,
		gboolean	loopback )

g_socket_set_multicast_ttl()

GIO_AVAILABLE_IN_2_32 void g_socket_set_multicast_ttl	(	GSocket *	socket,
		guint	ttl )

g_socket_set_option()

GIO_AVAILABLE_IN_2_36 gboolean g_socket_set_option	(	GSocket *	socket,
		gint	level,
		gint	optname,
		gint	value,
		GError **	error )

g_socket_set_timeout()

GIO_AVAILABLE_IN_ALL void g_socket_set_timeout	(	GSocket *	socket,
		guint	timeout )

g_socket_set_ttl()

GIO_AVAILABLE_IN_2_32 void g_socket_set_ttl	(	GSocket *	socket,
		guint	ttl )

g_socket_shutdown()

GIO_AVAILABLE_IN_ALL gboolean g_socket_shutdown	(	GSocket *	socket,
		gboolean	shutdown_read,
		gboolean	shutdown_write,
		GError **	error )

g_socket_speaks_ipv4()

GIO_AVAILABLE_IN_ALL gboolean g_socket_speaks_ipv4

(

GSocket *

socket

)