package ocgtk

You can search for identifiers within the package.

in-package search v0.2.0

ocgtk

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Wrappers.Socket`

type t = [ `socket | `object_ ] Gobject.obj

val new_ : 
  Gio_enums.socketfamily ->
  Gio_enums.sockettype ->
  Gio_enums.socketprotocol ->
  (t, GError.t) result

Create a new Socket

val new_from_fd : int -> (t, GError.t) result

Create a new Socket

val speaks_ipv4 : t -> bool

Checks if a socket is capable of speaking IPv4.

IPv4 sockets are capable of speaking IPv4. On some operating systems and under some combinations of circumstances IPv6 sockets are also capable of speaking IPv4. See RFC 3493 section 3.7 for more information.

No other types of sockets are currently considered as being capable of speaking IPv4.

val shutdown : t -> bool -> bool -> (bool, GError.t) result

Shut down part or all of a full-duplex connection.

If @shutdown_read is %TRUE then the receiving side of the connection is shut down, and further reading is disallowed.

If @shutdown_write is %TRUE then the sending side of the connection is shut down, and further writing is disallowed.

It is allowed for both @shutdown_read and @shutdown_write to be %TRUE.

One example where it is useful to shut down only one side of a connection is graceful disconnect for TCP connections where you close the sending side, then wait for the other side to close the connection, thus ensuring that the other side saw all sent data.

val set_ttl : t -> int -> unit

Sets the time-to-live for outgoing unicast packets on @socket. By default the platform-specific default value is used.

val set_timeout : t -> int -> unit

Sets the time in seconds after which I/O operations on @socket will time out if they have not yet completed.

On a blocking socket, this means that any blocking #GSocket operation will time out after @timeout seconds of inactivity, returning %G_IO_ERROR_TIMED_OUT.

On a non-blocking socket, calls to g_socket_condition_wait() will also fail with %G_IO_ERROR_TIMED_OUT after the given time. Sources created with g_socket_create_source() will trigger after @timeout seconds of inactivity, with the requested condition set, at which point calling g_socket_receive(), g_socket_send(), g_socket_check_connect_result(), etc, will fail with %G_IO_ERROR_TIMED_OUT.

If @timeout is 0 (the default), operations will never time out on their own.

Note that if an I/O operation is interrupted by a signal, this may cause the timeout to be reset.

val set_option : t -> int -> int -> int -> (bool, GError.t) result

Sets the value of an integer-valued option on @socket, as with setsockopt(). (If you need to set a non-integer-valued option, you will need to call setsockopt() directly.)

The <gio/gnetworking.h>gio-gnetworking.h header pulls in system headers that will define most of the standard/portable socket options. For unusual socket protocols or platform-dependent options, you may need to include additional headers.

val set_multicast_ttl : t -> int -> unit

Sets the time-to-live for outgoing multicast datagrams on @socket. By default, this is 1, meaning that multicast packets will not leave the local network.

val set_multicast_loopback : t -> bool -> unit

Sets whether outgoing multicast packets will be received by sockets listening on that multicast address on the same host. This is %TRUE by default.

val set_listen_backlog : t -> int -> unit

Sets the maximum number of outstanding connections allowed when listening on this socket. If more clients than this are connecting to the socket and the application is not handling them on time then the new connections will be refused.

Note that this must be called before g_socket_listen() and has no effect if called after that.

val set_keepalive : t -> bool -> unit

Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When this flag is set on a socket, the system will attempt to verify that the remote socket endpoint is still present if a sufficiently long period of time passes with no data being exchanged. If the system is unable to verify the presence of the remote endpoint, it will automatically close the connection.

This option is only functional on certain kinds of sockets. (Notably, %G_SOCKET_PROTOCOL_TCP sockets.)

The exact time between pings is system- and protocol-dependent, but will normally be at least two hours. Most commonly, you would set this flag on a server socket if you want to allow clients to remain idle for long periods of time, but also want to ensure that connections are eventually garbage-collected if clients crash or become unreachable.

val set_broadcast : t -> bool -> unit

Sets whether @socket should allow sending to broadcast addresses. This is %FALSE by default.

val set_blocking : t -> bool -> unit

Sets the blocking mode of the socket. In blocking mode all operations (which don’t take an explicit blocking parameter) block until they succeed or there is an error. In non-blocking mode all functions return results immediately or with a %G_IO_ERROR_WOULD_BLOCK error.

All sockets are created in blocking mode. However, note that the platform level socket is always non-blocking, and blocking mode is a GSocket level feature.

val send_messages : 
  t ->
  [ `output_message ] Gobject.obj array ->
  int ->
  int ->
  [ `cancellable | `object_ ] Gobject.obj option ->
  (int, GError.t) result

Send multiple data messages from @socket in one go. This is the most complicated and fully-featured version of this call. For easier use, see g_socket_send(), g_socket_send_to(), and g_socket_send_message().

@messages must point to an array of #GOutputMessage structs and @num_messages must be the length of this array. Each #GOutputMessage contains an address to send the data to, and a pointer to an array of #GOutputVector structs to describe the buffers that the data to be sent for each message will be gathered from. Using multiple #GOutputVectors is more memory-efficient than manually copying data from multiple sources into a single buffer, and more network-efficient than making multiple calls to g_socket_send(). Sending multiple messages in one go avoids the overhead of making a lot of syscalls in scenarios where a lot of data packets need to be sent (e.g. high-bandwidth video streaming over RTP/UDP), or where the same data needs to be sent to multiple recipients.

@flags modify how the message is sent. The commonly available arguments for this are available in the #GSocketMsgFlags enum, but the values there are the same as the system values, and the flags are passed in as-is, so you can pass in system-specific flags too.

If the socket is in blocking mode the call will block until there is space for all the data in the socket queue. If there is no space available and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error will be returned if no data was written at all, otherwise the number of messages sent will be returned. To be notified when space is available, wait for the %G_IO_OUT condition. Note though that you may still receive %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously notified of a %G_IO_OUT condition. (On Windows in particular, this is very common due to the way the underlying APIs work.)

On error -1 is returned and @error is set accordingly. An error will only be returned if zero messages could be sent; otherwise the number of messages successfully sent before the error will be returned.

val send_message_with_timeout : 
  t ->
  [ `socket_address | `object_ ] Gobject.obj option ->
  [ `output_vector ] Gobject.obj array ->
  int ->
  [ `socket_control_message | `object_ ] Gobject.obj array option ->
  int ->
  int ->
  int64 ->
  [ `cancellable | `object_ ] Gobject.obj option ->
  (Gio_enums.pollablereturn * Gsize.t, GError.t) result

This behaves exactly the same as g_socket_send_message(), except that the choice of timeout behavior is determined by the @timeout_us argument rather than by @socket's properties.

On error %G_POLLABLE_RETURN_FAILED is returned and @error is set accordingly, or if the socket is currently not writable %G_POLLABLE_RETURN_WOULD_BLOCK is returned. @bytes_written will contain 0 in both cases.

val send_message : 
  t ->
  [ `socket_address | `object_ ] Gobject.obj option ->
  [ `output_vector ] Gobject.obj array ->
  int ->
  [ `socket_control_message | `object_ ] Gobject.obj array option ->
  int ->
  int ->
  [ `cancellable | `object_ ] Gobject.obj option ->
  (int, GError.t) result

Send data to @address on @socket. For sending multiple messages see g_socket_send_messages(); for easier use, see g_socket_send() and g_socket_send_to().

If @address is %NULL then the message is sent to the default receiver (set by g_socket_connect()).

@vectors must point to an array of #GOutputVector structs and @num_vectors must be the length of this array. (If @num_vectors is -1, then @vectors is assumed to be terminated by a #GOutputVector with a %NULL buffer pointer.) The #GOutputVector structs describe the buffers that the sent data will be gathered from. Using multiple #GOutputVectors is more memory-efficient than manually copying data from multiple sources into a single buffer, and more network-efficient than making multiple calls to g_socket_send().

@messages, if non-%NULL, is taken to point to an array of @num_messages #GSocketControlMessage instances. These correspond to the control messages to be sent on the socket. If @num_messages is -1 then @messages is treated as a %NULL-terminated array.

If the socket is in blocking mode the call will block until there is space for the data in the socket queue. If there is no space available and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error will be returned. To be notified when space is available, wait for the %G_IO_OUT condition. Note though that you may still receive %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously notified of a %G_IO_OUT condition. (On Windows in particular, this is very common due to the way the underlying APIs work.)

The sum of the sizes of each #GOutputVector in vectors must not be greater than %G_MAXSSIZE. If the message can be larger than this, then it is mandatory to use the g_socket_send_message_with_timeout() function.

On error -1 is returned and @error is set accordingly.

val receive_messages : 
  t ->
  [ `input_message ] Gobject.obj array ->
  int ->
  int ->
  [ `cancellable | `object_ ] Gobject.obj option ->
  (int, GError.t) result

Receive multiple data messages from @socket in one go. This is the most complicated and fully-featured version of this call. For easier use, see g_socket_receive(), g_socket_receive_from(), and g_socket_receive_message().

@messages must point to an array of #GInputMessage structs and @num_messages must be the length of this array. Each #GInputMessage contains a pointer to an array of #GInputVector structs describing the buffers that the data received in each message will be written to. Using multiple #GInputVectors is more memory-efficient than manually copying data out of a single buffer to multiple sources, and more system-call-efficient than making multiple calls to g_socket_receive(), such as in scenarios where a lot of data packets need to be received (e.g. high-bandwidth video streaming over RTP/UDP).

@flags modify how all messages are received. The commonly available arguments for this are available in the #GSocketMsgFlags enum, but the values there are the same as the system values, and the flags are passed in as-is, so you can pass in system-specific flags too. These flags affect the overall receive operation. Flags affecting individual messages are returned in #GInputMessage.flags.

The other members of #GInputMessage are treated as described in its documentation.

If #GSocket:blocking is %TRUE the call will block until @num_messages have been received, or the end of the stream is reached.

If #GSocket:blocking is %FALSE the call will return up to @num_messages without blocking, or %G_IO_ERROR_WOULD_BLOCK if no messages are queued in the operating system to be received.

In blocking mode, if #GSocket:timeout is positive and is reached before any messages are received, %G_IO_ERROR_TIMED_OUT is returned, otherwise up to @num_messages are returned. (Note: This is effectively the behaviour of `MSG_WAITFORONE` with recvmmsg().)

To be notified when messages are available, wait for the %G_IO_IN condition. Note though that you may still receive %G_IO_ERROR_WOULD_BLOCK from g_socket_receive_messages() even if you were previously notified of a %G_IO_IN condition.

If the remote peer closes the connection, any messages queued in the operating system will be returned, and subsequent calls to g_socket_receive_messages() will return 0 (with no error set).

On error -1 is returned and @error is set accordingly. An error will only be returned if zero messages could be received; otherwise the number of messages successfully received before the error will be returned.

val receive_bytes : 
  t ->
  Gsize.t ->
  int64 ->
  [ `cancellable | `object_ ] Gobject.obj option ->
  (Glib_bytes.t, GError.t) result

Receives data (up to @size bytes) from a socket.

This function is a variant of method@Gio.Socket.receive which returns a struct@GLib.Bytes rather than a plain buffer.

Pass `-1` to @timeout_us to block indefinitely until data is received (or the connection is closed, or there is an error). Pass `0` to use the default timeout from property@Gio.Socket:timeout, or pass a positive number to wait for that many microseconds for data before returning `G_IO_ERROR_TIMED_OUT`.

val listen : t -> (bool, GError.t) result

Marks the socket as a server socket, i.e. a socket that is used to accept incoming requests using g_socket_accept().

Before calling this the socket must be bound to a local address using g_socket_bind().

To set the maximum amount of outstanding clients, use g_socket_set_listen_backlog().

val leave_multicast_group_ssm : 
  t ->
  [ `inet_address | `object_ ] Gobject.obj ->
  [ `inet_address | `object_ ] Gobject.obj option ->
  string option ->
  (bool, GError.t) result

Removes @socket from the multicast group defined by @group, @iface, and @source_specific (which must all have the same values they had when you joined the group).

@socket remains bound to its address and port, and can still receive unicast messages after calling this.

val leave_multicast_group : 
  t ->
  [ `inet_address | `object_ ] Gobject.obj ->
  bool ->
  string option ->
  (bool, GError.t) result

Removes @socket from the multicast group defined by @group, @iface, and @source_specific (which must all have the same values they had when you joined the group).

@socket remains bound to its address and port, and can still receive unicast messages after calling this.

To unbind to a given source-specific multicast address, use g_socket_leave_multicast_group_ssm() instead.

val join_multicast_group_ssm : 
  t ->
  [ `inet_address | `object_ ] Gobject.obj ->
  [ `inet_address | `object_ ] Gobject.obj option ->
  string option ->
  (bool, GError.t) result

Registers @socket to receive multicast messages sent to @group. @socket must be a %G_SOCKET_TYPE_DATAGRAM socket, and must have been bound to an appropriate interface and port with g_socket_bind().

If @iface is %NULL, the system will automatically pick an interface to bind to based on @group.

If @source_specific is not %NULL, use source-specific multicast as defined in RFC 4604. Note that on older platforms this may fail with a %G_IO_ERROR_NOT_SUPPORTED error.

Note that this function can be called multiple times for the same @group with different @source_specific in order to receive multicast packets from more than one source.

val join_multicast_group : 
  t ->
  [ `inet_address | `object_ ] Gobject.obj ->
  bool ->
  string option ->
  (bool, GError.t) result

Registers @socket to receive multicast messages sent to @group. @socket must be a %G_SOCKET_TYPE_DATAGRAM socket, and must have been bound to an appropriate interface and port with g_socket_bind().

If @iface is %NULL, the system will automatically pick an interface to bind to based on @group.

If @source_specific is %TRUE, source-specific multicast as defined in RFC 4604 is used. Note that on older platforms this may fail with a %G_IO_ERROR_NOT_SUPPORTED error.

To bind to a given source-specific multicast address, use g_socket_join_multicast_group_ssm() instead.

val is_connected : t -> bool

Check whether the socket is connected. This is only useful for connection-oriented sockets.

If using g_socket_shutdown(), this function will return %TRUE until the socket has been shut down for reading and writing. If you do a non-blocking connect, this function will not return %TRUE until after you call g_socket_check_connect_result().

val is_closed : t -> bool

Checks whether a socket is closed.

val get_ttl : t -> int

Gets the unicast time-to-live setting on @socket; see g_socket_set_ttl() for more details.

val get_timeout : t -> int

Gets the timeout setting of the socket. For details on this, see g_socket_set_timeout().

val get_socket_type : t -> Gio_enums.sockettype

Gets the socket type of the socket.

val get_remote_address : 
  t ->
  ([ `socket_address | `object_ ] Gobject.obj, GError.t) result

Try to get the remote address of a connected socket. This is only useful for connection oriented sockets that have been connected.

val get_protocol : t -> Gio_enums.socketprotocol

Gets the socket protocol id the socket was created with. In case the protocol is unknown, -1 is returned.

val get_option : t -> int -> int -> (bool * int, GError.t) result

Gets the value of an integer-valued option on @socket, as with getsockopt(). (If you need to fetch a non-integer-valued option, you will need to call getsockopt() directly.)

Note that even for socket options that are a single byte in size, @value is still a pointer to a #gint variable, not a #guchar; g_socket_get_option() will handle the conversion internally.

val get_multicast_ttl : t -> int

Gets the multicast time-to-live setting on @socket; see g_socket_set_multicast_ttl() for more details.

val get_multicast_loopback : t -> bool

Gets the multicast loopback setting on @socket; if %TRUE (the default), outgoing multicast packets will be looped back to multicast listeners on the same host.

val get_local_address : 
  t ->
  ([ `socket_address | `object_ ] Gobject.obj, GError.t) result

Try to get the local address of a bound socket. This is only useful if the socket has been bound to a local address, either explicitly or implicitly when connecting.

val get_listen_backlog : t -> int

Gets the listen backlog setting of the socket. For details on this, see g_socket_set_listen_backlog().

val get_keepalive : t -> bool

Gets the keepalive mode of the socket. For details on this, see g_socket_set_keepalive().

val get_fd : t -> int

Returns the underlying OS socket object. On unix this is a socket file descriptor, and on Windows this is a Winsock2 SOCKET handle. This may be useful for doing platform specific or otherwise unusual operations on the socket.

val get_family : t -> Gio_enums.socketfamily

Gets the socket family of the socket.

val get_credentials : 
  t ->
  ([ `credentials | `object_ ] Gobject.obj, GError.t) result

Returns the credentials of the foreign process connected to this socket, if any (e.g. it is only supported for %G_SOCKET_FAMILY_UNIX sockets).

If this operation isn't supported on the OS, the method fails with the %G_IO_ERROR_NOT_SUPPORTED error. On Linux this is implemented by reading the %SO_PEERCRED option on the underlying socket.

This method can be expected to be available on the following platforms:

Linux since GLib 2.26
OpenBSD since GLib 2.30
Solaris, Illumos and OpenSolaris since GLib 2.40
NetBSD since GLib 2.42
macOS, tvOS, iOS since GLib 2.66

Other ways to obtain credentials from a foreign peer includes the #GUnixCredentialsMessage type and g_unix_connection_send_credentials() / g_unix_connection_receive_credentials() functions.

val get_broadcast : t -> bool

Gets the broadcast setting on @socket; if %TRUE, it is possible to send packets to broadcast addresses.

val get_blocking : t -> bool

Gets the blocking mode of the socket. For details on blocking I/O, see g_socket_set_blocking().

val get_available_bytes : t -> int

Get the amount of data pending in the OS input buffer, without blocking.

If @socket is a UDP or SCTP socket, this will return the size of just the next packet, even if additional packets are buffered after that one.

Note that on Windows, this function is rather inefficient in the UDP case, and so if you know any plausible upper bound on the size of the incoming packet, it is better to just do a g_socket_receive() with a buffer of that size, rather than calling g_socket_get_available_bytes() first and then doing a receive of exactly the right size.

val connection_factory_create_connection : 
  t ->
  [ `socket_connection | `io_stream | `object_ ] Gobject.obj

Creates a #GSocketConnection subclass of the right type for @socket.

val connect : 
  t ->
  [ `socket_address | `object_ ] Gobject.obj ->
  [ `cancellable | `object_ ] Gobject.obj option ->
  (bool, GError.t) result

Connect the socket to the specified remote address.

For connection oriented socket this generally means we attempt to make a connection to the @address. For a connection-less socket it sets the default address for g_socket_send() and discards all incoming datagrams from other sources.

Generally connection oriented sockets can only connect once, but connection-less sockets can connect multiple times to change the default address.

If the connect call needs to do network I/O it will block, unless non-blocking I/O is enabled. Then %G_IO_ERROR_PENDING is returned and the user can be notified of the connection finishing by waiting for the G_IO_OUT condition. The result of the connection must then be checked with g_socket_check_connect_result().

val close : t -> (bool, GError.t) result

Closes the socket, shutting down any active connection.

Closing a socket does not wait for all outstanding I/O operations to finish, so the caller should not rely on them to be guaranteed to complete even if the close returns with no error.

Once the socket is closed, all other operations will return %G_IO_ERROR_CLOSED. Closing a socket multiple times will not return an error.

Sockets will be automatically closed when the last reference is dropped, but you might want to call this function to make sure resources are released as early as possible.

Beware that due to the way that TCP works, it is possible for recently-sent data to be lost if either you close a socket while the %G_IO_IN condition is set, or else if the remote connection tries to send something to you after you close the socket but before it has finished reading all of the data you sent. There is no easy generic way to avoid this problem; the easiest fix is to design the network protocol such that the client will never send data "out of turn". Another solution is for the server to half-close the connection by calling g_socket_shutdown() with only the @shutdown_write flag set, and then wait for the client to notice this and close its side of the connection, after which the server can safely call g_socket_close(). (This is what #GTcpConnection does if you call g_tcp_connection_set_graceful_disconnect(). But of course, this only works if the client will close its connection after the server does.)

val check_connect_result : t -> (bool, GError.t) result

Checks and resets the pending connect error for the socket. This is used to check for errors when g_socket_connect() is used in non-blocking mode.

val bind : 
  t ->
  [ `socket_address | `object_ ] Gobject.obj ->
  bool ->
  (bool, GError.t) result

When a socket is created it is attached to an address family, but it doesn't have an address in this family. g_socket_bind() assigns the address (sometimes called name) of the socket.

It is generally required to bind to a local address before you can receive connections. (See g_socket_listen() and g_socket_accept() ). In certain situations, you may also want to bind a socket that will be used to initiate connections, though this is not normally required.

If @socket is a TCP socket, then @allow_reuse controls the setting of the `SO_REUSEADDR` socket option; normally it should be %TRUE for server sockets (sockets that you will eventually call g_socket_accept() on), and %FALSE for client sockets. (Failing to set this flag on a server socket may cause g_socket_bind() to return %G_IO_ERROR_ADDRESS_IN_USE if the server program is stopped and then immediately restarted.)

If @socket is a UDP socket, then @allow_reuse determines whether or not other UDP sockets can be bound to the same address at the same time. In particular, you can have several UDP sockets bound to the same address, and they will all receive all of the multicast and broadcast packets sent to that address. (The behavior of unicast UDP packets to an address with multiple listeners is not defined.)

val accept : 
  t ->
  [ `cancellable | `object_ ] Gobject.obj option ->
  (t, GError.t) result

Accept incoming connections on a connection-based socket. This removes the first outstanding connection request from the listening socket and creates a #GSocket object for it.

The @socket must be bound to a local address with g_socket_bind() and must be listening for incoming connections (g_socket_listen()).

If there are no outstanding connections then the operation will block or return %G_IO_ERROR_WOULD_BLOCK if non-blocking I/O is enabled. To be notified of an incoming connection, wait for the %G_IO_IN condition.

val get_type : t -> Gio_enums.sockettype

Get property: type

package ocgtk

Module Wrappers.Socket

Module `Wrappers.Socket`