Sets our main struct and passes it to the parent class.
Creates a new atk.Socket 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.
Creates a new atk.Socket from a native file descriptor or winsock SOCKET handle.
Accept incoming connections on a connection-based socket. This removes the first outstanding connection request from the listening socket and creates a atk.Socket object for it.
When a socket is created it is attached to an address family, but it doesn't have an address in this family. Socket.bind assigns the address (sometimes called name) of the socket.
Checks and resets the pending connect error for the socket. This is used to check for errors when Socket.connect is used in non-blocking mode.
Closes the socket, shutting down any active connection.
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.
Waits for up to timeout_us microseconds for condition to become true on socket. If the condition is met, TRUE is returned.
Waits for condition to become true on socket. When the condition is met, TRUE is returned.
Connect the socket to the specified remote address.
Creates a gio.SocketConnection subclass of the right type for socket.
Creates a glib.Source that can be attached to a GMainContext to monitor for the availability of the specified condition on the socket. The glib.Source keeps a reference to the socket.
Get the amount of data pending in the OS input buffer, without blocking.
Gets the blocking mode of the socket. For details on blocking I/O, see Socket.setBlocking.
Gets the broadcast setting on socket; if TRUE, it is possible to send packets to broadcast addresses.
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).
Gets the socket family of the socket.
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.
Gets the keepalive mode of the socket. For details on this, see Socket.setKeepalive.
Gets the listen backlog setting of the socket. For details on this, see Socket.setListenBacklog.
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.
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.
Gets the multicast time-to-live setting on socket; see Socket.setMulticastTtl for more details.
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.)
Gets the socket protocol id the socket was created with. In case the protocol is unknown, -1 is returned.
Try to get the remote address of a connected socket. This is only useful for connection oriented sockets that have been connected.
Get the main Gtk struct
Gets the socket type of the socket.
the main Gtk struct as a void*
Gets the timeout setting of the socket. For details on this, see Socket.setTimeout.
Gets the unicast time-to-live setting on socket; see Socket.setTtl for more details.
Checks whether a socket is closed.
Check whether the socket is connected. This is only useful for connection-oriented sockets.
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 Socket.bind.
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 Socket.bind.
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).
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).
Marks the socket as a server socket, i.e. a socket that is used to accept incoming requests using Socket.accept.
Receive data (up to size bytes) from a socket. This is mainly used by connection-oriented sockets; it is identical to Socket.receiveFrom with address set to NULL.
Receive data (up to size bytes) from a socket.
Receive data from a socket. For receiving multiple messages, see Socket.receiveMessages; for easier use, see Socket.receive and Socket.receiveFrom.
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 Socket.receive, Socket.receiveFrom, and Socket.receiveMessage.
This behaves exactly the same as Socket.receive, except that the choice of blocking or non-blocking behavior is determined by the blocking argument rather than by socket's properties.
Tries to send size bytes from buffer on the socket. This is mainly used by connection-oriented sockets; it is identical to Socket.sendTo with address set to NULL.
Send data to address on socket. For sending multiple messages see Socket.sendMessages; for easier use, see Socket.send and Socket.sendTo.
This behaves exactly the same as Socket.sendMessage, except that the choice of timeout behavior is determined by the timeout_us argument rather than by socket's properties.
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 Socket.send, Socket.sendTo, and Socket.sendMessage.
Tries to send size bytes from buffer to address. If address is NULL then the message is sent to the default receiver (set by Socket.connect).
This behaves exactly the same as Socket.send, except that the choice of blocking or non-blocking behavior is determined by the blocking argument rather than by socket's properties.
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.
Sets whether socket should allow sending to broadcast addresses. This is FALSE by default.
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.
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.
Sets whether outgoing multicast packets will be received by sockets listening on that multicast address on the same host. This is TRUE by default.
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.
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.)
Sets the time in seconds after which I/O operations on socket will time out if they have not yet completed.
Sets the time-to-live for outgoing unicast packets on socket. By default the platform-specific default value is used.
Shut down part or all of a full-duplex connection.
Checks if a socket is capable of speaking IPv4.
the main Gtk struct
the main Gtk struct
Get the main Gtk struct
the main Gtk struct as a void*
Gets a D Object from the objects table of associations.
The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.
Find the gobject.ParamSpec 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().
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 gobject.ParamSpec, but normally ObjectClass.overrideProperty 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.
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().
Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.
Adds a weak reference from weak_pointer to object to indicate that the pointer located at weak_pointer_location is only valid during the lifetime of object. When the object is finalized, weak_pointer will be set to NULL.
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:
Complete version of g_object_bind_property().
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 is a variant of g_object_get_data() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
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().
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 notify signal is emitted for each property modified while the object is frozen.
Gets a named field from the objects table of associations (see g_object_set_data()).
Gets a property of an object.
This function gets back user data pointers stored via g_object_set_qdata().
Gets properties of an object.
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.
Checks whether object has a floating[floating-ref] reference.
Emits a "notify" signal for the property property_name on object.
Emits a "notify" signal for the property specified by pspec on object.
Increases the reference count of object.
Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.
Removes a weak reference from object that was previously added using g_object_add_weak_pointer(). The weak_pointer_location has to match the one used with g_object_add_weak_pointer().
Compares the user data for the key key on object with oldval, and if they are the same, replaces oldval with newval.
Compares the user data for the key quark on object with oldval, and if they are the same, replaces oldval with newval.
Releases all references to other objects. This can be used to break reference cycles.
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.
Sets a property on an object.
This sets an opaque, named pointer on an object. The name is specified through a GQuark (retrived e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the object with g_object_get_qdata() until the object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using NULL as pointer essentially removes the data stored.
This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with data as argument when the object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same quark.
Sets properties on an object.
Sets n_properties properties for an object. Properties to be set will be taken from values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
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:
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.
Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).
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 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.
Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).
Removes a weak reference callback to an object.
Clears a reference to a GObject
Get the main Gtk struct
the main Gtk struct as a void*
Checks on the readiness of datagram_based to perform operations. The operations specified in condition are checked for and masked against the currently-satisfied conditions on datagram_based. The result is returned.
Waits for up to timeout microseconds for condition to become true on datagram_based. If the condition is met, TRUE is returned.
Creates a glib.Source that can be attached to a glib.MainContext to monitor for the availability of the specified condition on the GDatagramBased The glib.Source keeps a reference to the datagram_based.
Receive one or more data messages from datagram_based in one go.
Send one or more data messages from datagram_based in one go.
Get the main Gtk struct
the main Gtk struct as a void*
Initializes the object implementing the interface.
A atk.Socket 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.
atk.Socket 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 gio.SocketClient, gio.SocketService and gio.SocketConnection However there may be cases where direct use of atk.Socket is useful.
atk.Socket 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 Socket.new and Socket.newFromFd, 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 Socket.conditionCheck, or Socket.conditionWait. You can also use Socket.createSource 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.
atk.Sockets 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 atk.Socket causes the signal SIGPIPE to be ignored for the remainder of the program. If you are writing a command-line utility that uses atk.Socket, 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, atk.Socket is not inherently thread safe. To use a atk.Socket concurrently from multiple threads, you must implement your own locking.