Gjsify LogoGjsify Logo

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 #GSocketClient, #GSocketService and #GSocketConnection. However there may be cases where direct use of #GSocket is useful.

#GSocket implements the #GInitable interface, so if it is manually constructed by e.g. g_object_new() you must call g_initable_init() and check the results before using the object. This is done automatically in g_socket_new() and g_socket_new_from_fd(), 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 g_socket_condition_check(), or g_socket_condition_wait(). You can also use g_socket_create_source() and attach it to a #GMainContext 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.

Hierarchy

Index

Constructors

  • Parameters

    Returns Gio.Socket

  • Creates a new #GSocket with the defined family, type and protocol. If protocol is 0 (%G_SOCKET_PROTOCOL_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: SocketFamily

      the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4.

    • type: SocketType

      the socket type to use.

    • protocol: SocketProtocol

      the id of the protocol to use, or 0 for default.

    Returns Gio.Socket

Properties

blocking: boolean
broadcast: boolean

Whether the socket should allow sending to broadcast addresses.

family: SocketFamily
fd: number
gTypeInstance: TypeInstance
keepalive: boolean
listenBacklog: number
localAddress: SocketAddress
multicastLoopback: boolean

Whether outgoing multicast packets loop back to the local host.

multicastTtl: number

Time-to-live out outgoing multicast packets

parentInstance: GObject.Object
protocol: SocketProtocol
remoteAddress: SocketAddress
timeout: number

The timeout in seconds on socket I/O

ttl: number

Time-to-live for outgoing unicast packets

$gtype: GType<Gio.Socket>
name: string

Methods

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

    Parameters

    Returns Gio.Socket

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

    Parameters

    • address: SocketAddress

      a #GSocketAddress specifying the local address.

    • allowReuse: boolean

      whether to allow reusing this address

    Returns boolean

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • checkConnectResult(): boolean
  • 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 boolean

  • close(): boolean
  • 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.)

    Returns boolean

  • Checks on the readiness of 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 %G_IO_ERROR_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 %G_IO_ERROR_WOULD_BLOCK.

    It is meaningless to specify %G_IO_ERR or %G_IO_HUP in condition; these conditions will always be set in the output if they are true.

    This call never blocks.

    Parameters

    Returns IOCondition

  • Waits for up to timeout_us 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 timeout_us (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 (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT).

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

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

    Parameters

    • condition: IOCondition

      a #GIOCondition mask to wait for

    • timeoutUs: number

      the maximum time (in microseconds) to wait, or -1

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    Returns boolean

  • 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 (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT).

    See also g_socket_condition_timed_wait().

    Parameters

    Returns boolean

  • Waits for up to timeout microseconds for condition to become true on datagram_based. If the condition is met, %TRUE is returned.

    If cancellable is cancelled before the condition is met, or if timeout is reached before the condition is met, then %FALSE is returned and error is set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT).

    Parameters

    • condition: IOCondition

      a #GIOCondition mask to wait for

    • Optional timeout: number

      the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely

    • Optional cancellable: Gio.Cancellable

      a #GCancellable

    Returns boolean

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    Returns any

  • connect(sigName: "notify::blocking", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::broadcast", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::family", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::fd", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::keepalive", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::listen-backlog", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::local-address", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::multicast-loopback", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::multicast-ttl", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::protocol", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::remote-address", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::timeout", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::ttl", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::type", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

    • sigName: "notify::blocking"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::broadcast"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::family"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::fd"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::keepalive"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::listen-backlog"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::local-address"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::multicast-loopback"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::multicast-ttl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::protocol"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::remote-address"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::timeout"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::ttl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::type"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

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

    The callback on the source is of the #GDatagramBasedSourceFunc type.

    It is meaningless to specify %G_IO_ERR or %G_IO_HUP in condition; these conditions will always be reported in the callback if they are true.

    If non-%NULL, cancellable 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().

    Parameters

    Returns GLib.Source

  • emit(sigName: "notify::blocking", ...args: any[]): void
  • emit(sigName: "notify::broadcast", ...args: any[]): void
  • emit(sigName: "notify::family", ...args: any[]): void
  • emit(sigName: "notify::fd", ...args: any[]): void
  • emit(sigName: "notify::keepalive", ...args: any[]): void
  • emit(sigName: "notify::listen-backlog", ...args: any[]): void
  • emit(sigName: "notify::local-address", ...args: any[]): void
  • emit(sigName: "notify::multicast-loopback", ...args: any[]): void
  • emit(sigName: "notify::multicast-ttl", ...args: any[]): void
  • emit(sigName: "notify::protocol", ...args: any[]): void
  • emit(sigName: "notify::remote-address", ...args: any[]): void
  • emit(sigName: "notify::timeout", ...args: any[]): void
  • emit(sigName: "notify::ttl", ...args: any[]): void
  • emit(sigName: "notify::type", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Parameters

    • sigName: "notify::blocking"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::broadcast"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::family"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::fd"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::keepalive"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::listen-backlog"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::local-address"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::multicast-loopback"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::multicast-ttl"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::protocol"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::remote-address"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::timeout"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::ttl"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::type"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: string
    • Rest ...args: any[]

    Returns void

  • forceFloating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freezeNotify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • getAvailableBytes(): number
  • 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.

    Returns number

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

    Returns boolean

  • getBroadcast(): boolean
  • Gets the broadcast setting on socket; if %TRUE, it is possible to send packets to broadcast addresses.

    Returns boolean

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

    Returns Gio.Credentials

  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getFd(): number
  • 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 number

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

    Returns boolean

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

    Returns number

  • 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 SocketAddress

  • getMulticastLoopback(): boolean
  • 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 boolean

  • getMulticastTtl(): number
  • Gets the multicast time-to-live setting on socket; see g_socket_set_multicast_ttl() for more details.

    Returns number

  • getOption(level: number, optname: number): [boolean, number]
  • 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>][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: number

      the "API level" of the option (eg, SOL_SOCKET)

    • optname: number

      the "name" of the option (eg, SO_BROADCAST)

    Returns [boolean, number]

  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

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

    Returns SocketAddress

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

    Returns number

  • getTtl(): number
  • Gets the unicast time-to-live setting on socket; see g_socket_set_ttl() for more details.

    Returns number

  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • Initializes the object implementing the interface.

    This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.

    The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().

    Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL and the object doesn't support cancellable initialization the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

    If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [introduction][ginitable] for more details.

    Callers should not assume that a class which implements #GInitable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all #GInitable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.

    If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.

    One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a #GObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.

    Parameters

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    Returns boolean

  • isClosed(): boolean
  • isConnected(): boolean
  • 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 boolean

  • isFloating(): boolean
  • joinMulticastGroup(group: InetAddress, sourceSpecific: boolean, iface: string): boolean
  • 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.

    Parameters

    • group: InetAddress

      a #GInetAddress specifying the group address to join.

    • sourceSpecific: boolean

      %TRUE if source-specific multicast should be used

    • iface: string

      Name of the interface to use, or %NULL

    Returns boolean

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

    Parameters

    • group: InetAddress

      a #GInetAddress specifying the group address to join.

    • sourceSpecific: InetAddress

      a #GInetAddress specifying the source-specific multicast address or %NULL to ignore.

    • iface: string

      Name of the interface to use, or %NULL

    Returns boolean

  • leaveMulticastGroup(group: InetAddress, sourceSpecific: boolean, iface: string): boolean
  • 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.

    Parameters

    • group: InetAddress

      a #GInetAddress specifying the group address to leave.

    • sourceSpecific: boolean

      %TRUE if source-specific multicast was used

    • iface: string

      Interface used

    Returns boolean

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

    Parameters

    • group: InetAddress

      a #GInetAddress specifying the group address to leave.

    • sourceSpecific: InetAddress

      a #GInetAddress specifying the source-specific multicast address or %NULL to ignore.

    • iface: string

      Name of the interface to use, or %NULL

    Returns boolean

  • listen(): boolean
  • 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 boolean

  • notify(propertyName: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • propertyName: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • off(sigName: "notify::blocking", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::broadcast", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::family", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::fd", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::keepalive", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::listen-backlog", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::local-address", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::multicast-loopback", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::multicast-ttl", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::protocol", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::remote-address", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::timeout", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::ttl", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::type", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    • sigName: "notify::blocking"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::broadcast"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::family"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::fd"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::keepalive"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::listen-backlog"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::local-address"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::multicast-loopback"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::multicast-ttl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::protocol"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::remote-address"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::timeout"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::ttl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::type"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: "notify::blocking", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::broadcast", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::family", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::fd", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::keepalive", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::listen-backlog", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::local-address", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::multicast-loopback", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::multicast-ttl", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::protocol", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::remote-address", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::timeout", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::ttl", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::type", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: "notify::blocking"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::broadcast"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::family"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::fd"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::keepalive"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::listen-backlog"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::local-address"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::multicast-loopback"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::multicast-ttl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::protocol"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::remote-address"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::timeout"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::ttl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::type"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: "notify::blocking", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::broadcast", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::family", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::fd", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::keepalive", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::listen-backlog", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::local-address", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::multicast-loopback", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::multicast-ttl", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::protocol", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::remote-address", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::timeout", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::ttl", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::type", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: "notify::blocking"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::broadcast"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::family"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::fd"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::keepalive"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::listen-backlog"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::local-address"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::multicast-loopback"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::multicast-ttl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::protocol"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::remote-address"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::timeout"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::ttl"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::type"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • 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 %G_SOCKET_TYPE_DATAGRAM and %G_SOCKET_TYPE_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 %G_SOCKET_TYPE_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 %G_IO_ERROR_WOULD_BLOCK error will be returned. To be notified when data is available, wait for the %G_IO_IN condition.

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

    Parameters

    Returns [number, Uint8Array]

  • 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

    Returns [number, SocketAddress, Uint8Array]

  • 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 num_vectors must be the length of this array. These structs describe the buffers that received data will be scattered into. If num_vectors is -1, then vectors is assumed to be terminated by a #GInputVector with a %NULL buffer pointer.

    As a special case, if num_vectors 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.

    num_messages, if non-%NULL, will be set to the number of control messages received.

    If both messages and num_messages are non-%NULL, then num_messages 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 socket is %G_SOCKET_TYPE_DATAGRAM or %G_SOCKET_TYPE_SEQPACKET and you do not provide enough buffer space to read a complete message. You can pass %G_SOCKET_MSG_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 %G_IO_ERROR_WOULD_BLOCK error will be returned. To be notified when data is available, wait for the %G_IO_IN condition.

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

    Parameters

    Returns [number, SocketAddress, SocketControlMessage[], number]

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

    Parameters

    Returns number

  • Receive one or more data messages from datagram_based in one go.

    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.

    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 timeout is negative the call will block until num_messages have been received, the connection is closed remotely (EOS), cancellable is cancelled, or an error occurs.

    If timeout is 0 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.

    If timeout is positive the call will block on the same conditions as if timeout were negative. If the timeout is reached before any messages are received, %G_IO_ERROR_TIMED_OUT is returned, otherwise it will return the number of messages received before timing out. (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_datagram_based_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 underlying receive buffer will be returned, and subsequent calls to g_datagram_based_receive_messages() will return 0 (with no error set).

    If the connection is shut down or closed (by calling g_socket_close() or g_socket_shutdown() with shutdown_read set, if it’s a #GSocket, for example), all calls to this function will return %G_IO_ERROR_CLOSED.

    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. If cancellable is cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error.

    Parameters

    • messages: Gio.InputMessage[]

      an array of #GInputMessage structs

    • Optional flags: number

      an int containing #GSocketMsgFlags flags for the overall operation

    • Optional timeout: number

      the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely

    • Optional cancellable: Gio.Cancellable

      a %GCancellable

    Returns number

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    Returns any

  • receiveWithBlocking(blocking: boolean, cancellable: Gio.Cancellable): [number, Uint8Array]
  • 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

    • blocking: boolean

      whether to do blocking or non-blocking I/O

    • cancellable: Gio.Cancellable

      a %GCancellable or %NULL

    Returns [number, Uint8Array]

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

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

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

    Parameters

    • buffer: Uint8Array

      the buffer containing the data to send.

    • cancellable: Gio.Cancellable

      a %GCancellable or %NULL

    Returns number

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

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

    Parameters

    Returns number

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

    Parameters

    • address: SocketAddress

      a #GSocketAddress, or %NULL

    • vectors: OutputVector[]

      an array of #GOutputVector structs

    • messages: SocketControlMessage[]

      a pointer to an array of #GSocketControlMessages, or %NULL.

    • flags: number

      an int containing #GSocketMsgFlags flags, which may additionally contain other platform specific flags

    • timeoutUs: number

      the maximum time (in microseconds) to wait, or -1

    • cancellable: Gio.Cancellable

      a %GCancellable or %NULL

    Returns [PollableReturn, number]

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

    Parameters

    Returns number

  • Send one or more data messages from datagram_based in one go.

    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.

    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.

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

    If timeout is negative the call will block until num_messages have been sent, cancellable is cancelled, or an error occurs.

    If timeout is 0 the call will send up to num_messages without blocking, or will return %G_IO_ERROR_WOULD_BLOCK if there is no space to send messages.

    If timeout is positive the call will block on the same conditions as if timeout were negative. If the timeout is reached before any messages are sent, %G_IO_ERROR_TIMED_OUT is returned, otherwise it will return the number of messages sent before timing out.

    To be notified when messages can be sent, wait for the %G_IO_OUT condition. Note though that you may still receive %G_IO_ERROR_WOULD_BLOCK from g_datagram_based_send_messages() 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.)

    If the connection is shut down or closed (by calling g_socket_close() or g_socket_shutdown() with shutdown_write set, if it’s a #GSocket, for example), all calls to this function will return %G_IO_ERROR_CLOSED.

    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. If cancellable is cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error.

    Parameters

    • messages: Gio.OutputMessage[]

      an array of #GOutputMessage structs

    • Optional flags: number

      an int containing #GSocketMsgFlags flags

    • Optional timeout: number

      the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely

    • Optional cancellable: Gio.Cancellable

      a %GCancellable

    Returns number

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    Returns any

  • 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: SocketAddress

      a #GSocketAddress, or %NULL

    • buffer: Uint8Array

      the buffer containing the data to send.

    • cancellable: Gio.Cancellable

      a %GCancellable or %NULL

    Returns number

  • sendWithBlocking(buffer: Uint8Array, blocking: boolean, cancellable: Gio.Cancellable): number
  • 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: Uint8Array

      the buffer containing the data to send.

    • blocking: boolean

      whether to do blocking or non-blocking I/O

    • cancellable: Gio.Cancellable

      a %GCancellable or %NULL

    Returns number

  • setBlocking(blocking: boolean): void
  • 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.

    Parameters

    • blocking: boolean

      Whether to use blocking I/O or not.

    Returns void

  • setBroadcast(broadcast: boolean): void
  • Sets whether socket should allow sending to broadcast addresses. This is %FALSE by default.

    Parameters

    • broadcast: boolean

      whether socket should allow sending to broadcast addresses

    Returns void

  • setData(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • setKeepalive(keepalive: boolean): void
  • 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.

    Parameters

    • keepalive: boolean

      Value for the keepalive flag

    Returns void

  • setListenBacklog(backlog: number): void
  • 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: number

      the maximum number of pending connections.

    Returns void

  • setMulticastLoopback(loopback: boolean): void
  • 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: boolean

      whether socket should receive messages sent to its multicast groups from the local host

    Returns void

  • setMulticastTtl(ttl: number): void
  • 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: number

      the time-to-live value for all multicast datagrams on socket

    Returns void

  • setOption(level: number, optname: number, value: number): boolean
  • 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.

    Parameters

    • level: number

      the "API level" of the option (eg, SOL_SOCKET)

    • optname: number

      the "name" of the option (eg, SO_BROADCAST)

    • value: number

      the value to set the option to

    Returns boolean

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

  • setTimeout(timeout: number): void
  • 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.

    Parameters

    • timeout: number

      the timeout for socket, in seconds, or 0 for none

    Returns void

  • setTtl(ttl: number): void
  • Sets the time-to-live for outgoing unicast packets on socket. By default the platform-specific default value is used.

    Parameters

    • ttl: number

      the time-to-live value for all unicast packets on socket

    Returns void

  • shutdown(shutdownRead: boolean, shutdownWrite: boolean): boolean
  • 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.

    Parameters

    • shutdownRead: boolean

      whether to shut down the read side

    • shutdownWrite: boolean

      whether to shut down the write side

    Returns boolean

  • speaksIpv4(): boolean
  • 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 boolean

  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thawNotify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • watchClosure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compatControl(what: number, data: object): number
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new #GSocket with the defined family, type and protocol. If protocol is 0 (%G_SOCKET_PROTOCOL_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: SocketFamily

      the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4.

    • type: SocketType

      the socket type to use.

    • protocol: SocketProtocol

      the id of the protocol to use, or 0 for default.

    Returns Gio.Socket

  • 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 %G_IO_ERROR_FAILED

    Parameters

    • fd: number

      a native socket file descriptor.

    Returns Gio.Socket

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method