Class Socket

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.gobject.TypeInstance
org.gnome.gobject.GObject
org.gnome.gio.Socket
All Implemented Interfaces:
DatagramBased, Initable, Proxy
@Generated("org.javagi.JavaGI") public class Socket extends GObject implements DatagramBased, Initable

A GSocket is a low-level networking primitive. It is a more or less direct mapping of the BSD socket API in a portable GObject based API. It supports both the UNIX socket implementations and winsock2 on Windows.

GSocket is the platform independent base upon which the higher level network primitives are based. Applications are not typically meant to use it directly, but rather through classes like SocketClient, SocketService and SocketConnection. However there may be cases where direct use of GSocket is useful.

GSocket implements the Initable interface, so if it is manually constructed by e.g. GObject() you must call Initable.init(Cancellable) and check the results before using the object. This is done automatically in Socket() and fromFd(int), so these functions can return NULL.

Sockets operate in two general modes, blocking or non-blocking. When in blocking mode all operations (which don’t take an explicit blocking parameter) block until the requested operation is finished or there is an error. In non-blocking mode all calls that would block return immediately with a G_IO_ERROR_WOULD_BLOCK error. To know when a call would successfully run you can call conditionCheck(Set), or conditionWait(Set, Cancellable). You can also use createSource(Set, Cancellable) and attach it to a GLib.MainContext to get callbacks when I/O is possible. Note that all sockets are always set to non blocking mode in the system, and blocking mode is emulated in GSocket.

When working in non-blocking mode applications should always be able to handle getting a G_IO_ERROR_WOULD_BLOCK error even when some other function said that I/O was possible. This can easily happen in case of a race condition in the application, but it can also happen for other reasons. For instance, on Windows a socket is always seen as writable until a write returns G_IO_ERROR_WOULD_BLOCK.

GSockets can be either connection oriented or datagram based. For connection oriented types you must first establish a connection by either connecting to an address or accepting a connection from another address. For connectionless socket types the target/source address is specified or received in each I/O operation.

All socket file descriptors are set to be close-on-exec.

Note that creating a GSocket causes the signal SIGPIPE to be ignored for the remainder of the program. If you are writing a command-line utility that uses GSocket, you may need to take into account the fact that your program will not automatically be killed if it tries to write to stdout after it has been closed.

Like most other APIs in GLib, GSocket is not inherently thread safe. To use a GSocket concurrently from multiple threads, you must implement your own locking.

Nagle’s algorithm

Since GLib 2.80, GSocket will automatically set the TCP_NODELAY option on all G_SOCKET_TYPE_STREAM sockets. This disables Nagle’s algorithm as it typically does more harm than good on modern networks.

If your application needs Nagle’s algorithm enabled, call setOption(int, int, int) after constructing a GSocket to enable it:

socket = g_socket_new (…, G_SOCKET_TYPE_STREAM, …);
if (socket != NULL)
  {
    g_socket_set_option (socket, IPPROTO_TCP, TCP_NODELAY, FALSE, &local_error);
    // handle error if needed
  }
Since:
2.22

  • Constructor Details

    • Socket

      public Socket(MemorySegment address)
      Create a Socket instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • Socket

      public Socket(SocketFamily family, SocketType type, SocketProtocol protocol) throws GErrorException

      Creates a new GSocket with the defined family, type and protocol. If protocol is 0 (SocketProtocol.DEFAULT) the default protocol type for the family and type is used.

      The protocol is a family and type specific int that specifies what kind of protocol to use. GSocketProtocol lists several common ones. Many families only support one protocol, and use 0 for this, others support several and using 0 means to use the default protocol for the family and type.

      The protocol id is passed directly to the operating system, so you can use protocols not listed in GSocketProtocol if you know the protocol number used for it.

      Parameters:
      family - the socket family to use, e.g. SocketFamily.IPV4.
      type - the socket type to use.
      protocol - the id of the protocol to use, or 0 for default.
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • Socket

      public Socket()
      Create a new Socket.

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the Socket class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • asParent

      protected Socket asParent()
      Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.
      Overrides:
      asParent in class GObject
      Returns:
      the instance as if it were its parent type

    • fromFd

      public static Socket fromFd(int fd) throws GErrorException

      Creates a new GSocket from a native file descriptor or winsock SOCKET handle.

      This reads all the settings from the file descriptor so that all properties should work. Note that the file descriptor will be set to non-blocking mode, independent on the blocking mode of the GSocket.

      On success, the returned GSocket takes ownership of fd. On failure, the caller must close fd themselves.

      Since GLib 2.46, it is no longer a fatal error to call this on a non-socket descriptor. Instead, a GError will be set with code IOErrorEnum.FAILED

      Parameters:
      fd - a native socket file descriptor.
      Returns:
      a GSocket or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • accept

      public Socket accept(@Nullable Cancellable cancellable) throws GErrorException

      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 this 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 IOErrorEnum.WOULD_BLOCK if non-blocking I/O is enabled. To be notified of an incoming connection, wait for the IOCondition.IN condition.

      Parameters:
      cancellable - a GCancellable or null
      Returns:
      a new GSocket, or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • bind

      public boolean bind(SocketAddress address, boolean allowReuse) throws GErrorException

      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 this Socket is a TCP socket, then allowReuse 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 IOErrorEnum.ADDRESS_IN_USE if the server program is stopped and then immediately restarted.)

      If this Socket is a UDP socket, then allowReuse 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.)

      Parameters:
      address - a GSocketAddress specifying the local address.
      allowReuse - whether to allow reusing this address
      Returns:
      true on success, false on error.
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • checkConnectResult

      public boolean checkConnectResult() throws GErrorException
      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.
      Returns:
      true if no error, false otherwise, setting error to the error
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • close

      public boolean close() throws GErrorException

      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 IOErrorEnum.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 IOCondition.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 shutdownWrite 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.)

      Returns:
      true on success, false on error
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • conditionCheck

      public Set<IOCondition> conditionCheck(Set<IOCondition> condition)

      Checks on the readiness of this Socket to perform operations. The operations specified in condition are checked for and masked against the currently-satisfied conditions on socket. The result is returned.

      Note that on Windows, it is possible for an operation to return IOErrorEnum.WOULD_BLOCK even immediately after g_socket_condition_check() has claimed that the socket is ready for writing. Rather than calling g_socket_condition_check() and then writing to the socket if it succeeds, it is generally better to simply try writing to the socket right away, and try again later if the initial attempt returns IOErrorEnum.WOULD_BLOCK.

      It is meaningless to specify IOCondition.ERR or IOCondition.HUP in condition; these conditions will always be set in the output if they are true.

      This call never blocks.

      Specified by:
      conditionCheck in interface DatagramBased
      Parameters:
      condition - a GIOCondition mask to check
      Returns:
      the GIOCondition mask of the current state
      Since:
      2.22

    • conditionCheck

      public Set<IOCondition> conditionCheck(IOCondition... condition)

      Checks on the readiness of this Socket to perform operations. The operations specified in condition are checked for and masked against the currently-satisfied conditions on socket. The result is returned.

      Note that on Windows, it is possible for an operation to return IOErrorEnum.WOULD_BLOCK even immediately after g_socket_condition_check() has claimed that the socket is ready for writing. Rather than calling g_socket_condition_check() and then writing to the socket if it succeeds, it is generally better to simply try writing to the socket right away, and try again later if the initial attempt returns IOErrorEnum.WOULD_BLOCK.

      It is meaningless to specify IOCondition.ERR or IOCondition.HUP in condition; these conditions will always be set in the output if they are true.

      This call never blocks.

      Specified by:
      conditionCheck in interface DatagramBased
      Parameters:
      condition - a GIOCondition mask to check
      Returns:
      the GIOCondition mask of the current state
      Since:
      2.22

    • conditionTimedWait

      public boolean conditionTimedWait(Set<IOCondition> condition, long timeoutUs, @Nullable Cancellable cancellable) throws GErrorException

      Waits for up to timeoutUs microseconds for condition to become true on socket. If the condition is met, true is returned.

      If cancellable is cancelled before the condition is met, or if timeoutUs (or the socket's GSocket:timeout) is reached before the condition is met, then false is returned and error, if non-null, is set to the appropriate value (IOErrorEnum.CANCELLED or IOErrorEnum.TIMED_OUT).

      If you don't want a timeout, use g_socket_condition_wait(). (Alternatively, you can pass -1 for timeoutUs.)

      Note that although timeoutUs is in microseconds for consistency with other GLib APIs, this function actually only has millisecond resolution, and the behavior is undefined if timeoutUs is not an exact number of milliseconds.

      Parameters:
      condition - a GIOCondition mask to wait for
      timeoutUs - the maximum time (in microseconds) to wait, or -1
      cancellable - a GCancellable, or null
      Returns:
      true if the condition was met, false otherwise
      Throws:
      GErrorException - see GError
      Since:
      2.32

    • conditionTimedWait

      public boolean conditionTimedWait(IOCondition condition, long timeoutUs, @Nullable Cancellable cancellable) throws GErrorException

      Waits for up to timeoutUs microseconds for condition to become true on socket. If the condition is met, true is returned.

      If cancellable is cancelled before the condition is met, or if timeoutUs (or the socket's GSocket:timeout) is reached before the condition is met, then false is returned and error, if non-null, is set to the appropriate value (IOErrorEnum.CANCELLED or IOErrorEnum.TIMED_OUT).

      If you don't want a timeout, use g_socket_condition_wait(). (Alternatively, you can pass -1 for timeoutUs.)

      Note that although timeoutUs is in microseconds for consistency with other GLib APIs, this function actually only has millisecond resolution, and the behavior is undefined if timeoutUs is not an exact number of milliseconds.

      Parameters:
      condition - a GIOCondition mask to wait for
      timeoutUs - the maximum time (in microseconds) to wait, or -1
      cancellable - a GCancellable, or null
      Returns:
      true if the condition was met, false otherwise
      Throws:
      GErrorException - see GError
      Since:
      2.32

    • conditionWait

      public boolean conditionWait(Set<IOCondition> condition, @Nullable Cancellable cancellable) throws GErrorException

      Waits for condition to become true on socket. When the condition is met, true is returned.

      If cancellable is cancelled before the condition is met, or if the socket has a timeout set and it is reached before the condition is met, then false is returned and error, if non-null, is set to the appropriate value (IOErrorEnum.CANCELLED or IOErrorEnum.TIMED_OUT).

      See also g_socket_condition_timed_wait().

      Parameters:
      condition - a GIOCondition mask to wait for
      cancellable - a GCancellable, or null
      Returns:
      true if the condition was met, false otherwise
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • conditionWait

      public boolean conditionWait(IOCondition condition, @Nullable Cancellable cancellable) throws GErrorException

      Waits for condition to become true on socket. When the condition is met, true is returned.

      If cancellable is cancelled before the condition is met, or if the socket has a timeout set and it is reached before the condition is met, then false is returned and error, if non-null, is set to the appropriate value (IOErrorEnum.CANCELLED or IOErrorEnum.TIMED_OUT).

      See also g_socket_condition_timed_wait().

      Parameters:
      condition - a GIOCondition mask to wait for
      cancellable - a GCancellable, or null
      Returns:
      true if the condition was met, false otherwise
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • connect

      public boolean connect(SocketAddress address, @Nullable Cancellable cancellable) throws GErrorException

      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 IOErrorEnum.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().

      Parameters:
      address - a GSocketAddress specifying the remote address.
      cancellable - a GCancellable or null
      Returns:
      true if connected, false on error.
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • connectionFactoryCreateConnection

      public SocketConnection connectionFactoryCreateConnection()
      Creates a GSocketConnection subclass of the right type for socket.
      Returns:
      a GSocketConnection
      Since:
      2.22

    • createSource

      public Source createSource(Set<IOCondition> condition, @Nullable Cancellable cancellable)

      Creates a GSource that can be attached to a GMainContext to monitor for the availability of the specified condition on the socket. The GSource keeps a reference to the socket.

      The callback on the source is of the GSocketSourceFunc type.

      It is meaningless to specify IOCondition.ERR or IOCondition.HUP in condition; these conditions will always be reported output if they are true.

      cancellable if not null can be used to cancel the source, which will cause the source to trigger, reporting the current condition (which is likely 0 unless cancellation happened at the same time as a condition change). You can check for this in the callback using g_cancellable_is_cancelled().

      If this Socket has a timeout set, and it is reached before condition occurs, the source will then trigger anyway, reporting IOCondition.IN or IOCondition.OUT depending on condition. However, this Socket will have been marked as having had a timeout, and so the next GSocket I/O method you call will then fail with a IOErrorEnum.TIMED_OUT.

      Specified by:
      createSource in interface DatagramBased
      Parameters:
      condition - a GIOCondition mask to monitor
      cancellable - a GCancellable or null
      Returns:
      a newly allocated GSource, free with g_source_unref().
      Since:
      2.22

    • createSource

      public Source createSource(IOCondition condition, @Nullable Cancellable cancellable)

      Creates a GSource that can be attached to a GMainContext to monitor for the availability of the specified condition on the socket. The GSource keeps a reference to the socket.

      The callback on the source is of the GSocketSourceFunc type.

      It is meaningless to specify IOCondition.ERR or IOCondition.HUP in condition; these conditions will always be reported output if they are true.

      cancellable if not null can be used to cancel the source, which will cause the source to trigger, reporting the current condition (which is likely 0 unless cancellation happened at the same time as a condition change). You can check for this in the callback using g_cancellable_is_cancelled().

      If this Socket has a timeout set, and it is reached before condition occurs, the source will then trigger anyway, reporting IOCondition.IN or IOCondition.OUT depending on condition. However, this Socket will have been marked as having had a timeout, and so the next GSocket I/O method you call will then fail with a IOErrorEnum.TIMED_OUT.

      Specified by:
      createSource in interface DatagramBased
      Parameters:
      condition - a GIOCondition mask to monitor
      cancellable - a GCancellable or null
      Returns:
      a newly allocated GSource, free with g_source_unref().
      Since:
      2.22

    • getAvailableBytes

      public long getAvailableBytes()

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

      If this 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.

      Returns:
      the number of bytes that can be read from the socket without blocking or truncating, or -1 on error.
      Since:
      2.32

    • getBlocking

      public boolean getBlocking()
      Gets the blocking mode of the socket. For details on blocking I/O, see g_socket_set_blocking().
      Returns:
      true if blocking I/O is used, false otherwise.
      Since:
      2.22

    • getBroadcast

      public boolean getBroadcast()
      Gets the broadcast setting on socket; if true, it is possible to send packets to broadcast addresses.
      Returns:
      the broadcast setting on this Socket
      Since:
      2.32

    • getCredentials

      public Credentials getCredentials() throws GErrorException

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

      If this operation isn't supported on the OS, the method fails with the IOErrorEnum.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.

      Returns:
      null if error is set, otherwise a GCredentials object that must be freed with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.26

    • getFamily

      public SocketFamily getFamily()
      Gets the socket family of the socket.
      Returns:
      a GSocketFamily
      Since:
      2.22

    • getFd

      public int getFd()
      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.
      Returns:
      the file descriptor of the socket.
      Since:
      2.22

    • getKeepalive

      public boolean getKeepalive()
      Gets the keepalive mode of the socket. For details on this, see g_socket_set_keepalive().
      Returns:
      true if keepalive is active, false otherwise.
      Since:
      2.22

    • getListenBacklog

      public int getListenBacklog()
      Gets the listen backlog setting of the socket. For details on this, see g_socket_set_listen_backlog().
      Returns:
      the maximum number of pending connections.
      Since:
      2.22

    • getLocalAddress

      public SocketAddress getLocalAddress() throws GErrorException
      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.
      Returns:
      a GSocketAddress or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • getMulticastLoopback

      public boolean getMulticastLoopback()
      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.
      Returns:
      the multicast loopback setting on this Socket
      Since:
      2.32

    • getMulticastTtl

      public int getMulticastTtl()
      Gets the multicast time-to-live setting on socket; see g_socket_set_multicast_ttl() for more details.
      Returns:
      the multicast time-to-live setting on this Socket
      Since:
      2.32

    • getOption

      public boolean getOption(int level, int optname, Out<Integer> value) throws GErrorException

      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.)

      The <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.

      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.

      Parameters:
      level - the "API level" of the option (eg, SOL_SOCKET)
      optname - the "name" of the option (eg, SO_BROADCAST)
      value - return location for the option value
      Returns:
      success or failure. On failure, error will be set, and the system error value (errno or WSAGetLastError()) will still be set to the result of the getsockopt() call.
      Throws:
      GErrorException - see GError
      Since:
      2.36

    • getProtocol

      public SocketProtocol getProtocol()
      Gets the socket protocol id the socket was created with. In case the protocol is unknown, -1 is returned.
      Returns:
      a protocol id, or -1 if unknown
      Since:
      2.22

    • getRemoteAddress

      public SocketAddress getRemoteAddress() throws GErrorException
      Try to get the remote address of a connected socket. This is only useful for connection oriented sockets that have been connected.
      Returns:
      a GSocketAddress or null on error. Free the returned object with g_object_unref().
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • getSocketType

      public SocketType getSocketType()
      Gets the socket type of the socket.
      Returns:
      a GSocketType
      Since:
      2.22

    • getTimeout

      public int getTimeout()
      Gets the timeout setting of the socket. For details on this, see g_socket_set_timeout().
      Returns:
      the timeout in seconds
      Since:
      2.26

    • getTtl

      public int getTtl()
      Gets the unicast time-to-live setting on socket; see g_socket_set_ttl() for more details.
      Returns:
      the time-to-live setting on this Socket
      Since:
      2.32

    • isClosed

      public boolean isClosed()
      Checks whether a socket is closed.
      Returns:
      true if socket is closed, false otherwise
      Since:
      2.22

    • isConnected

      public boolean isConnected()

      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().

      Returns:
      true if socket is connected, false otherwise.
      Since:
      2.22

    • joinMulticastGroup

      public boolean joinMulticastGroup(InetAddress group, boolean sourceSpecific, @Nullable String iface) throws GErrorException

      Registers this Socket to receive multicast messages sent to group. this Socket must be a SocketType.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 sourceSpecific is true, source-specific multicast as defined in RFC 4604 is used. Note that on older platforms this may fail with a IOErrorEnum.NOT_SUPPORTED error.

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

      Parameters:
      group - a GInetAddress specifying the group address to join.
      sourceSpecific - true if source-specific multicast should be used
      iface - Name of the interface to use, or null
      Returns:
      true on success, false on error.
      Throws:
      GErrorException - see GError
      Since:
      2.32

    • joinMulticastGroupSsm

      public boolean joinMulticastGroupSsm(InetAddress group, @Nullable InetAddress sourceSpecific, @Nullable String iface) throws GErrorException

      Registers this Socket to receive multicast messages sent to group. this Socket must be a SocketType.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 sourceSpecific is not null, use source-specific multicast as defined in RFC 4604. Note that on older platforms this may fail with a IOErrorEnum.NOT_SUPPORTED error.

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

      Parameters:
      group - a GInetAddress specifying the group address to join.
      sourceSpecific - a GInetAddress specifying the source-specific multicast address or null to ignore.
      iface - Name of the interface to use, or null
      Returns:
      true on success, false on error.
      Throws:
      GErrorException - see GError
      Since:
      2.56

    • leaveMulticastGroup

      public boolean leaveMulticastGroup(InetAddress group, boolean sourceSpecific, @Nullable String iface) throws GErrorException

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

      this 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.

      Parameters:
      group - a GInetAddress specifying the group address to leave.
      sourceSpecific - true if source-specific multicast was used
      iface - Interface used
      Returns:
      true on success, false on error.
      Throws:
      GErrorException - see GError
      Since:
      2.32

    • leaveMulticastGroupSsm

      public boolean leaveMulticastGroupSsm(InetAddress group, @Nullable InetAddress sourceSpecific, @Nullable String iface) throws GErrorException

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

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

      Parameters:
      group - a GInetAddress specifying the group address to leave.
      sourceSpecific - a GInetAddress specifying the source-specific multicast address or null to ignore.
      iface - Name of the interface to use, or null
      Returns:
      true on success, false on error.
      Throws:
      GErrorException - see GError
      Since:
      2.56

    • listen

      public boolean listen() throws GErrorException

      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().

      Returns:
      true on success, false on error.
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • receive

      public long receive(@Nullable Out<byte[]> buffer, @Nullable Cancellable cancellable) throws GErrorException

      Receive data (up to size bytes) from a socket. This is mainly used by connection-oriented sockets; it is identical to g_socket_receive_from() with address set to null.

      For SocketType.DATAGRAM and SocketType.SEQPACKET sockets, g_socket_receive() will always read either 0 or 1 complete messages from the socket. If the received message is too large to fit in buffer, then the data beyond size bytes will be discarded, without any explicit indication that this has occurred.

      For SocketType.STREAM sockets, g_socket_receive() can return any number of bytes, up to size. If more than size bytes have been received, the additional data will be returned in future calls to g_socket_receive().

      If the socket is in blocking mode the call will block until there is some data to receive, the connection is closed, or there is an error. If there is no data available and the socket is in non-blocking mode, a IOErrorEnum.WOULD_BLOCK error will be returned. To be notified when data is available, wait for the IOCondition.IN condition.

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

      Parameters:
      buffer - a buffer to read data into (which should be at least size bytes long).
      cancellable - a GCancellable or null
      Returns:
      Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • receiveBytes

      public byte[] receiveBytes(long size, long timeoutUs, @Nullable Cancellable cancellable) throws GErrorException

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

      This function is a variant of receive(Out, Cancellable) which returns a GLib.Bytes rather than a plain buffer.

      Pass -1 to timeoutUs 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 Gio.Socket:timeout, or pass a positive number to wait for that many microseconds for data before returning G_IO_ERROR_TIMED_OUT.

      Parameters:
      size - the number of bytes you want to read from the socket
      timeoutUs - the timeout to wait for, in microseconds, or -1 to block indefinitely
      cancellable - a GCancellable, or NULL
      Returns:
      a bytes buffer containing the received bytes, or NULL on error
      Throws:
      GErrorException - see GError
      Since:
      2.80

    • receiveBytesFrom

      public byte[] receiveBytesFrom(@Nullable Out<SocketAddress> address, long size, long timeoutUs, @Nullable Cancellable cancellable) throws GErrorException

      Receive data (up to size bytes) from a socket.

      This function is a variant of receiveFrom(Out, Out, Cancellable) which returns a GLib.Bytes rather than a plain buffer.

      If address is non-null then address will be set equal to the source address of the received packet.

      The address is owned by the caller.

      Pass -1 to timeoutUs 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 Gio.Socket:timeout, or pass a positive number to wait for that many microseconds for data before returning G_IO_ERROR_TIMED_OUT.

      Parameters:
      address - return location for a GSocketAddress
      size - the number of bytes you want to read from the socket
      timeoutUs - the timeout to wait for, in microseconds, or -1 to block indefinitely
      cancellable - a GCancellable, or NULL
      Returns:
      a bytes buffer containing the received bytes, or NULL on error
      Throws:
      GErrorException - see GError
      Since:
      2.80

    • receiveFrom

      public long receiveFrom(@Nullable Out<SocketAddress> address, @Nullable Out<byte[]> buffer, @Nullable Cancellable cancellable) throws GErrorException

      Receive data (up to size bytes) from a socket.

      If address is non-null then address will be set equal to the source address of the received packet. address is owned by the caller.

      See g_socket_receive() for additional information.

      Parameters:
      address - a pointer to a GSocketAddress pointer, or null
      buffer - a buffer to read data into (which should be at least size bytes long).
      cancellable - a GCancellable or null
      Returns:
      Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • receiveMessage

      public long receiveMessage(@Nullable Out<SocketAddress> address, @Nullable InputVector @Nullable [] vectors, @Nullable Out<SocketControlMessage[]> messages, Out<Integer> flags, @Nullable Cancellable cancellable) throws GErrorException

      Receive data from a socket. For receiving multiple messages, see g_socket_receive_messages(); for easier use, see g_socket_receive() and g_socket_receive_from().

      If address is non-null then address will be set equal to the source address of the received packet. address is owned by the caller.

      vector must point to an array of GInputVector structs and numVectors must be the length of this array. These structs describe the buffers that received data will be scattered into. If numVectors is -1, then vectors is assumed to be terminated by a GInputVector with a null buffer pointer.

      As a special case, if numVectors is 0 (in which case, vectors may of course be null), then a single byte is received and discarded. This is to facilitate the common practice of sending a single '\0' byte for the purposes of transferring ancillary data.

      messages, if non-null, will be set to point to a newly-allocated array of GSocketControlMessage instances or null if no such messages was received. These correspond to the control messages received from the kernel, one GSocketControlMessage per message from the kernel. This array is null-terminated and must be freed by the caller using g_free() after calling g_object_unref() on each element. If messages is null, any control messages received will be discarded.

      numMessages, if non-null, will be set to the number of control messages received.

      If both messages and numMessages are non-null, then numMessages gives the number of GSocketControlMessage instances in messages (ie: not including the null terminator).

      flags is an in/out parameter. 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 (and g_socket_receive_message() may pass system-specific flags out). Flags passed in to the parameter affect the receive operation; flags returned out of it are relevant to the specific returned message.

      As with g_socket_receive(), data may be discarded if this Socket is SocketType.DATAGRAM or SocketType.SEQPACKET and you do not provide enough buffer space to read a complete message. You can pass SocketMsgFlags.PEEK in flags to peek at the current message without removing it from the receive queue, but there is no portable way to find out the length of the message other than by reading it into a sufficiently-large buffer.

      If the socket is in blocking mode the call will block until there is some data to receive, the connection is closed, or there is an error. If there is no data available and the socket is in non-blocking mode, a IOErrorEnum.WOULD_BLOCK error will be returned. To be notified when data is available, wait for the IOCondition.IN condition.

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

      Parameters:
      address - a pointer to a GSocketAddress pointer, or null
      vectors - an array of GInputVector structs
      messages - a pointer which may be filled with an array of GSocketControlMessages, or null
      flags - a pointer to an int containing GSocketMsgFlags flags, which may additionally contain other platform specific flags
      cancellable - a GCancellable or null
      Returns:
      Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • receiveMessages

      public int receiveMessages(@Nullable InputMessage @Nullable [] messages, int flags, @Nullable Cancellable cancellable) throws GErrorException

      Receive multiple data messages from this 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 numMessages 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 numMessages have been received, or the end of the stream is reached.

      If GSocket:blocking is false the call will return up to numMessages without blocking, or IOErrorEnum.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, IOErrorEnum.TIMED_OUT is returned, otherwise up to numMessages are returned. (Note: This is effectively the behaviour of MSG_WAITFORONE with recvmmsg().)

      To be notified when messages are available, wait for the IOCondition.IN condition. Note though that you may still receive IOErrorEnum.WOULD_BLOCK from g_socket_receive_messages() even if you were previously notified of a IOCondition.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.

      Parameters:
      messages - an array of GInputMessage structs
      flags - an int containing GSocketMsgFlags flags for the overall operation, which may additionally contain other platform specific flags
      cancellable - a GCancellable or null
      Returns:
      number of messages received, or -1 on error. Note that the number of messages received may be smaller than numMessages if in non-blocking mode, if the peer closed the connection, or if numMessages was larger than UIO_MAXIOV (1024), in which case the caller may re-try to receive the remaining messages.
      Throws:
      GErrorException - see GError
      Since:
      2.48

    • receiveWithBlocking

      public long receiveWithBlocking(@Nullable Out<byte[]> buffer, boolean blocking, @Nullable Cancellable cancellable) throws GErrorException
      This behaves exactly the same as g_socket_receive(), except that the choice of blocking or non-blocking behavior is determined by the blocking argument rather than by socket's properties.
      Parameters:
      buffer - a buffer to read data into (which should be at least size bytes long).
      blocking - whether to do blocking or non-blocking I/O
      cancellable - a GCancellable or null
      Returns:
      Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error
      Throws:
      GErrorException - see GError
      Since:
      2.26

    • send

      public long send(@Nullable byte @Nullable [] buffer, @Nullable Cancellable cancellable) throws GErrorException

      Tries to send size bytes from buffer on the socket. This is mainly used by connection-oriented sockets; it is identical to g_socket_send_to() with address set to null.

      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 IOErrorEnum.WOULD_BLOCK error will be returned. To be notified when space is available, wait for the IOCondition.OUT condition. Note though that you may still receive IOErrorEnum.WOULD_BLOCK from g_socket_send() even if you were previously notified of a IOCondition.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.

      Parameters:
      buffer - the buffer containing the data to send.
      cancellable - a GCancellable or null
      Returns:
      Number of bytes written (which may be less than size), or -1 on error
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • sendMessage

      public long sendMessage(@Nullable SocketAddress address, @Nullable OutputVector @Nullable [] vectors, @Nullable SocketControlMessage @Nullable [] messages, int flags, @Nullable Cancellable cancellable) throws GErrorException

      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 numVectors must be the length of this array. (If numVectors 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 numMessages GSocketControlMessage instances. These correspond to the control messages to be sent on the socket. If numMessages is -1 then messages is treated as a null-terminated array.

      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 the data in the socket queue. If there is no space available and the socket is in non-blocking mode a IOErrorEnum.WOULD_BLOCK error will be returned. To be notified when space is available, wait for the IOCondition.OUT condition. Note though that you may still receive IOErrorEnum.WOULD_BLOCK from g_socket_send() even if you were previously notified of a IOCondition.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.

      Parameters:
      address - a GSocketAddress, or null
      vectors - an array of GOutputVector structs
      messages - a pointer to an array of GSocketControlMessages, or null.
      flags - an int containing GSocketMsgFlags flags, which may additionally contain other platform specific flags
      cancellable - a GCancellable or null
      Returns:
      Number of bytes written (which may be less than size), or -1 on error
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • sendMessageWithTimeout

      public PollableReturn sendMessageWithTimeout(@Nullable SocketAddress address, @Nullable OutputVector @Nullable [] vectors, @Nullable SocketControlMessage @Nullable [] messages, int flags, long timeoutUs, @Nullable Out<Long> bytesWritten, @Nullable Cancellable cancellable) throws GErrorException

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

      On error PollableReturn.FAILED is returned and error is set accordingly, or if the socket is currently not writable PollableReturn.WOULD_BLOCK is returned. bytesWritten will contain 0 in both cases.

      Parameters:
      address - a GSocketAddress, or null
      vectors - an array of GOutputVector structs
      messages - a pointer to an array of GSocketControlMessages, or null.
      flags - an int containing GSocketMsgFlags flags, which may additionally contain other platform specific flags
      timeoutUs - the maximum time (in microseconds) to wait, or -1
      bytesWritten - location to store the number of bytes that were written to the socket
      cancellable - a GCancellable or null
      Returns:
      PollableReturn.OK if all data was successfully written, PollableReturn.WOULD_BLOCK if the socket is currently not writable, or PollableReturn.FAILED if an error happened and error is set.
      Throws:
      GErrorException - see GError
      Since:
      2.60

    • sendMessages

      public int sendMessages(@Nullable OutputMessage @Nullable [] messages, int flags, @Nullable Cancellable cancellable) throws GErrorException

      Send multiple data messages from this 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 numMessages 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 IOErrorEnum.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 IOCondition.OUT condition. Note though that you may still receive IOErrorEnum.WOULD_BLOCK from g_socket_send() even if you were previously notified of a IOCondition.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.

      Parameters:
      messages - an array of GOutputMessage structs
      flags - an int containing GSocketMsgFlags flags, which may additionally contain other platform specific flags
      cancellable - a GCancellable or null
      Returns:
      number of messages sent, or -1 on error. Note that the number of messages sent may be smaller than numMessages if the socket is non-blocking or if numMessages was larger than UIO_MAXIOV (1024), in which case the caller may re-try to send the remaining messages.
      Throws:
      GErrorException - see GError
      Since:
      2.44

    • sendTo

      public long sendTo(@Nullable SocketAddress address, @Nullable byte @Nullable [] buffer, @Nullable Cancellable cancellable) throws GErrorException

      Tries to send size bytes from buffer to address. If address is null then the message is sent to the default receiver (set by g_socket_connect()).

      See g_socket_send() for additional information.

      Parameters:
      address - a GSocketAddress, or null
      buffer - the buffer containing the data to send.
      cancellable - a GCancellable or null
      Returns:
      Number of bytes written (which may be less than size), or -1 on error
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • sendWithBlocking

      public long sendWithBlocking(@Nullable byte @Nullable [] buffer, boolean blocking, @Nullable Cancellable cancellable) throws GErrorException
      This behaves exactly the same as g_socket_send(), except that the choice of blocking or non-blocking behavior is determined by the blocking argument rather than by socket's properties.
      Parameters:
      buffer - the buffer containing the data to send.
      blocking - whether to do blocking or non-blocking I/O
      cancellable - a GCancellable or null
      Returns:
      Number of bytes written (which may be less than size), or -1 on error
      Throws:
      GErrorException - see GError
      Since:
      2.26

    • setBlocking

      public void setBlocking(boolean blocking)

      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 IOErrorEnum.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.

      Parameters:
      blocking - Whether to use blocking I/O or not.
      Since:
      2.22

    • setBroadcast

      public void setBroadcast(boolean broadcast)
      Sets whether this Socket should allow sending to broadcast addresses. This is false by default.
      Parameters:
      broadcast - whether this Socket should allow sending to broadcast addresses
      Since:
      2.32

    • setKeepalive

      public void setKeepalive(boolean keepalive)

      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, SocketProtocol.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.

      Parameters:
      keepalive - Value for the keepalive flag
      Since:
      2.22

    • setListenBacklog

      public void setListenBacklog(int backlog)

      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.

      Parameters:
      backlog - the maximum number of pending connections.
      Since:
      2.22

    • setMulticastLoopback

      public void setMulticastLoopback(boolean loopback)
      Sets whether outgoing multicast packets will be received by sockets listening on that multicast address on the same host. This is true by default.
      Parameters:
      loopback - whether this Socket should receive messages sent to its multicast groups from the local host
      Since:
      2.32

    • setMulticastTtl

      public void setMulticastTtl(int ttl)
      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.
      Parameters:
      ttl - the time-to-live value for all multicast datagrams on this Socket
      Since:
      2.32

    • setOption

      public boolean setOption(int level, int optname, int value) throws GErrorException

      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> 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.

      Parameters:
      level - the "API level" of the option (eg, SOL_SOCKET)
      optname - the "name" of the option (eg, SO_BROADCAST)
      value - the value to set the option to
      Returns:
      success or failure. On failure, error will be set, and the system error value (errno or WSAGetLastError()) will still be set to the result of the setsockopt() call.
      Throws:
      GErrorException - see GError
      Since:
      2.36

    • setTimeout

      public void setTimeout(int timeout)

      Sets the time in seconds after which I/O operations on this 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 IOErrorEnum.TIMED_OUT.

      On a non-blocking socket, calls to g_socket_condition_wait() will also fail with IOErrorEnum.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 IOErrorEnum.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.

      Parameters:
      timeout - the timeout for socket, in seconds, or 0 for none
      Since:
      2.26

    • setTtl

      public void setTtl(int ttl)
      Sets the time-to-live for outgoing unicast packets on socket. By default the platform-specific default value is used.
      Parameters:
      ttl - the time-to-live value for all unicast packets on this Socket
      Since:
      2.32

    • shutdown

      public boolean shutdown(boolean shutdownRead, boolean shutdownWrite) throws GErrorException

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

      If shutdownRead is true then the receiving side of the connection is shut down, and further reading is disallowed.

      If shutdownWrite is true then the sending side of the connection is shut down, and further writing is disallowed.

      It is allowed for both shutdownRead and shutdownWrite 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.

      Parameters:
      shutdownRead - whether to shut down the read side
      shutdownWrite - whether to shut down the write side
      Returns:
      true on success, false on error
      Throws:
      GErrorException - see GError
      Since:
      2.22

    • speaksIpv4

      public boolean speaksIpv4()

      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.

      Returns:
      true if this socket can be used with IPv4.
      Since:
      2.22

    • builder

      public static Socket.Builder<? extends Socket.Builder> builder()
      A Socket.Builder object constructs a Socket with the specified properties. Use the various set...() methods to set properties, and finish construction with Socket.Builder.build().
      Returns:
      the builder object