Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Since 2.60advertised_Since 2.60advertisedConstruct OnlySince 2.48base_The Gio.DatagramBased that the connection wraps. Note that this may be any implementation of Gio.DatagramBased, not just a Gio.Socket.
Construct OnlySince 2.48baseThe Gio.DatagramBased that the connection wraps. Note that this may be any implementation of Gio.DatagramBased, not just a Gio.Socket.
Since 2.48certificateThe connection's certificate; see
g_dtls_connection_set_certificate().
Read-OnlySince 2.70ciphersuite_Read-OnlySince 2.70ciphersuiteSince 2.48databaseThe certificate database to use when verifying this TLS connection.
If no certificate database is set, then the default database will be
used. See g_tls_backend_get_default_database().
When using a non-default database, Gio.DtlsConnection must fall back to using
the Gio.TlsDatabase to perform certificate verification using
g_tls_database_verify_chain(), which means certificate verification will
not be able to make use of TLS session context. This may be less secure.
For example, if you create your own Gio.TlsDatabase that just wraps the
default Gio.TlsDatabase, you might expect that you have not changed anything,
but this is not true because you may have altered the behavior of
Gio.DtlsConnection by causing it to use g_tls_database_verify_chain(). See the
documentation of g_tls_database_verify_chain() for more details on specific
security checks that may not be performed. Accordingly, setting a
non-default database is discouraged except for specialty applications with
unusual security requirements.
Since 2.48interactionA Gio.TlsInteraction object to be used when the connection or certificate database need to interact with the user. This will be used to prompt the user for passwords where necessary.
Read-OnlySince 2.60negotiated_Read-OnlySince 2.60negotiatedRead-OnlySince 2.48peer_The connection's peer's certificate, after the TLS handshake has completed or failed. Note in particular that this is not yet set during the emission of Gio.DtlsConnection.SignalSignatures.accept_certificate | Gio.DtlsConnection::accept-certificate.
(You can watch for a GObject.Object::notify signal on this property to detect when a handshake has occurred.)
Read-OnlySince 2.48peer_The errors noticed while verifying Gio.DtlsConnection.peer_certificate. Normally this should be 0, but it may not be if Gio.DtlsClientConnection.validation_flags is not Gio.TlsCertificateFlags.VALIDATE_ALL, or if Gio.DtlsConnection.SignalSignatures.accept_certificate | Gio.DtlsConnection::accept-certificate overrode the default behavior.
GLib guarantees that if certificate verification fails, at least one error will be set, but it does not guarantee that all possible errors will be set. Accordingly, you may not safely decide to ignore any particular type of error. For example, it would be incorrect to mask Gio.TlsCertificateFlags.EXPIRED if you want to allow expired certificates, because this could potentially be the only error flag set even if other problems exist with the certificate.
Read-OnlySince 2.48peerThe connection's peer's certificate, after the TLS handshake has completed or failed. Note in particular that this is not yet set during the emission of Gio.DtlsConnection.SignalSignatures.accept_certificate | Gio.DtlsConnection::accept-certificate.
(You can watch for a GObject.Object::notify signal on this property to detect when a handshake has occurred.)
Read-OnlySince 2.48peerThe errors noticed while verifying Gio.DtlsConnection.peer_certificate. Normally this should be 0, but it may not be if Gio.DtlsClientConnection.validation_flags is not Gio.TlsCertificateFlags.VALIDATE_ALL, or if Gio.DtlsConnection.SignalSignatures.accept_certificate | Gio.DtlsConnection::accept-certificate overrode the default behavior.
GLib guarantees that if certificate verification fails, at least one error will be set, but it does not guarantee that all possible errors will be set. Accordingly, you may not safely decide to ignore any particular type of error. For example, it would be incorrect to mask Gio.TlsCertificateFlags.EXPIRED if you want to allow expired certificates, because this could potentially be the only error flag set even if other problems exist with the certificate.
Read-OnlySince 2.70protocol_The DTLS protocol version in use. See g_dtls_connection_get_protocol_version().
Read-OnlySince 2.70protocolThe DTLS protocol version in use. See g_dtls_connection_get_protocol_version().
Since 2.48rehandshake_The rehandshaking mode. See
g_dtls_connection_set_rehandshake_mode().
Since 2.48rehandshakeThe rehandshaking mode. See
g_dtls_connection_set_rehandshake_mode().
Since 2.48require_Since 2.48requireClose the DTLS connection. This is equivalent to calling
g_dtls_connection_shutdown() to shut down both sides of the connection.
Closing a Gio.DtlsConnection waits for all buffered but untransmitted data to
be sent before it completes. It then sends a close_notify DTLS alert to the
peer and may wait for a close_notify to be received from the peer. It does
not close the underlying Gio.DtlsConnection.base_socket; that must be closed
separately.
Once conn is closed, all other operations will return Gio.IOErrorEnum.CLOSED.
Closing a Gio.DtlsConnection multiple times will not return an error.
GDtlsConnections 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.
If cancellable is cancelled, the Gio.DtlsConnection may be left
partially-closed and any pending untransmitted data may be lost. Call
g_dtls_connection_close() again to complete closing the Gio.DtlsConnection.
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
true on success, false otherwise
Asynchronously close the DTLS connection. See g_dtls_connection_close() for
more information.
the I/O priority of the request
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
Asynchronously close the DTLS connection. See g_dtls_connection_close() for
more information.
the I/O priority of the request
a Gio.Cancellable, or null
callback to call when the close operation is complete
Asynchronously close the DTLS connection. See g_dtls_connection_close() for
more information.
the I/O priority of the request
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
Optionalcallback: AsyncReadyCallback<Gio.DtlsConnection>callback to call when the close operation is complete
Finish an asynchronous TLS close operation. See g_dtls_connection_close()
for more information.
true on success, false on failure, in which case error will be set
Used by Gio.DtlsConnection implementations to emit the Gio.DtlsConnection.SignalSignatures.accept_certificate | Gio.DtlsConnection::accept-certificate signal.
the peer's Gio.TlsCertificate
the problems with peer_cert
true if one of the signal handlers has returned true to accept peer_cert
Gets conn's certificate, as set by
g_dtls_connection_set_certificate().
conn's certificate, or null
Query the TLS backend for TLS channel binding data of type for conn.
This call retrieves TLS channel binding data as specified in RFC
5056, RFC
5929, and related RFCs. The
binding data is returned in data. The data is resized by the callee
using GLib.ByteArray buffer management and will be freed when the data
is destroyed by g_byte_array_unref(). If data is null, it will only
check whether TLS backend is able to fetch the data (e.g. whether type
is supported by the TLS backend). It does not guarantee that the data
will be available though. That could happen if TLS connection does not
support type or the binding data is not available yet due to additional
negotiation or input required.
Gio.TlsChannelBindingType type of data to fetch
true on success, false otherwise
Returns the name of the current DTLS ciphersuite, or null if the
connection has not handshaked or has been closed. Beware that the TLS
backend may use any of multiple different naming conventions, because
OpenSSL and GnuTLS have their own ciphersuite naming conventions that
are different from each other and different from the standard, IANA-
registered ciphersuite names. The ciphersuite name is intended to be
displayed to the user for informative purposes only, and parsing it
is not recommended.
The name of the current DTLS ciphersuite, or null
Gets the certificate database that conn uses to verify
peer certificates. See g_dtls_connection_set_database().
the certificate database that conn uses or null
Get the object that will be used to interact with the user. It will be used
for things like prompting the user for passwords. If null is returned, then
no user interaction will occur for this connection.
The interaction object.
Gets the name of the application-layer protocol negotiated during the handshake.
If the peer did not use the ALPN extension, or did not advertise a
protocol that matched one of conn's protocols, or the TLS backend
does not support ALPN, then this will be null. See
g_dtls_connection_set_advertised_protocols().
the negotiated protocol, or null
Gets conn's peer's certificate after the handshake has completed
or failed. (It is not set during the emission of
Gio.DtlsConnection.SignalSignatures.accept_certificate | Gio.DtlsConnection::accept-certificate.)
conn's peer's certificate, or null
Gets the errors associated with validating conn's peer's
certificate, after the handshake has completed or failed. (It is
not set during the emission of Gio.DtlsConnection.SignalSignatures.accept_certificate | Gio.DtlsConnection::accept-certificate.)
conn's peer's certificate errors
Returns the current DTLS protocol version, which may be Gio.TlsProtocolVersion.UNKNOWN if the connection has not handshaked, or has been closed, or if the TLS backend has implemented a protocol version that is not a recognized Gio.TlsProtocolVersion.
The current DTLS protocol version
Gets conn rehandshaking mode. See
g_dtls_connection_set_rehandshake_mode() for details.
Tests whether or not conn expects a proper TLS close notification
when the connection is closed. See
g_dtls_connection_set_require_close_notify() for details.
true if conn requires a proper TLS close notification.
Attempts a TLS handshake on conn.
On the client side, it is never necessary to call this method;
although the connection needs to perform a handshake after
connecting, Gio.DtlsConnection will handle this for you automatically
when you try to send or receive data on the connection. You can call
g_dtls_connection_handshake() manually if you want to know whether
the initial handshake succeeded or failed (as opposed to just
immediately trying to use conn to read or write, in which case,
if it fails, it may not be possible to tell if it failed before
or after completing the handshake), but beware that servers may reject
client authentication after the handshake has completed, so a
successful handshake does not indicate the connection will be usable.
Likewise, on the server side, although a handshake is necessary at the beginning of the communication, you do not need to call this function explicitly unless you want clearer error reporting.
Previously, calling g_dtls_connection_handshake() after the initial
handshake would trigger a rehandshake; however, this usage was
deprecated in GLib 2.60 because rehandshaking was removed from the
TLS protocol in TLS 1.3. Since GLib 2.64, calling this function after
the initial handshake will no longer do anything.
Gio.DtlsConnection.SignalSignatures.accept_certificate | Gio.DtlsConnection::accept_certificate may be emitted during the handshake.
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
success or failure
Asynchronously performs a TLS handshake on conn. See
g_dtls_connection_handshake() for more information.
the I/O priority of the request
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
Asynchronously performs a TLS handshake on conn. See
g_dtls_connection_handshake() for more information.
the I/O priority of the request
a Gio.Cancellable, or null
callback to call when the handshake is complete
Asynchronously performs a TLS handshake on conn. See
g_dtls_connection_handshake() for more information.
the I/O priority of the request
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
Optionalcallback: AsyncReadyCallback<Gio.DtlsConnection>callback to call when the handshake is complete
Finish an asynchronous TLS handshake operation. See
g_dtls_connection_handshake() for more information.
true on success, false on failure, in which case error will be set.
Sets the list of application-layer protocols to advertise that the
caller is willing to speak on this connection. The
Application-Layer Protocol Negotiation (ALPN) extension will be
used to negotiate a compatible protocol with the peer; use
g_dtls_connection_get_negotiated_protocol() to find the negotiated
protocol after the handshake. Specifying null for the the value
of protocols will disable ALPN negotiation.
See IANA TLS ALPN Protocol IDs for a list of registered protocol IDs.
Optionalprotocols: string[]a null-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or null
This sets the certificate that conn will present to its peer
during the TLS handshake. For a Gio.DtlsServerConnection, it is
mandatory to set this, and that will normally be done at construct
time.
For a Gio.DtlsClientConnection, this is optional. If a handshake fails
with Gio.TlsError.CERTIFICATE_REQUIRED, that means that the server
requires a certificate, and if you try connecting again, you should
call this method first. You can call
g_dtls_client_connection_get_accepted_cas() on the failed connection
to get a list of Certificate Authorities that the server will
accept certificates from.
(It is also possible that a server will allow the connection with
or without a certificate; in that case, if you don't provide a
certificate, you can tell that the server requested one by the fact
that g_dtls_client_connection_get_accepted_cas() will return
non-null.)
the certificate to use for conn
Sets the certificate database that is used to verify peer certificates.
This is set to the default database by default. See
g_tls_backend_get_default_database(). If set to null, then
peer certificate validation will always set the
Gio.TlsCertificateFlags.UNKNOWN_CA error (meaning
Gio.DtlsConnection.SignalSignatures.accept_certificate | Gio.DtlsConnection::accept-certificate will always be emitted on
client-side connections, unless that bit is not set in
Gio.DtlsClientConnection.validation_flags).
There are nonintuitive security implications when using a non-default database. See Gio.DtlsConnection.database for details.
Optionaldatabase: Gio.TlsDatabaseSet the object that will be used to interact with the user. It will be used for things like prompting the user for passwords.
The interaction argument will normally be a derived subclass of
Gio.TlsInteraction. null can also be provided if no user interaction
should occur for this connection.
Optionalinteraction: Gio.TlsInteractionan interaction object, or null
Since GLib 2.64, changing the rehandshake mode is no longer supported and will have no effect. With TLS 1.3, rehandshaking has been removed from the TLS protocol, replaced by separate post-handshake authentication and rekey operations.
the rehandshaking mode
Sets whether or not conn expects a proper TLS close notification
before the connection is closed. If this is true (the default),
then conn will expect to receive a TLS close notification from its
peer before the connection is closed, and will return a
Gio.TlsError.EOF error if the connection is closed without proper
notification (since this may indicate a network error, or
man-in-the-middle attack).
In some protocols, the application will know whether or not the
connection was closed cleanly based on application-level data
(because the application-level data includes a length field, or is
somehow self-delimiting); in this case, the close notify is
redundant and may be omitted. You
can use g_dtls_connection_set_require_close_notify() to tell conn
to allow an "unannounced" connection close, in which case the close
will show up as a 0-length read, as in a non-TLS
Gio.DatagramBased, and it is up to the application to check that
the data has been fully received.
Note that this only affects the behavior when the peer closes the
connection; when the application calls g_dtls_connection_close_async() on
conn itself, this will send a close notification regardless of the
setting of this property. If you explicitly want to do an unclean
close, you can close conn's Gio.DtlsConnection.base_socket rather
than closing conn itself.
whether or not to require close notification
Shut down part or all of a DTLS connection.
If shutdown_read is true then the receiving side of the connection is shut
down, and further reading is disallowed. Subsequent calls to
g_datagram_based_receive_messages() will return Gio.IOErrorEnum.CLOSED.
If shutdown_write is true then the sending side of the connection is shut
down, and further writing is disallowed. Subsequent calls to
g_datagram_based_send_messages() will return Gio.IOErrorEnum.CLOSED.
It is allowed for both shutdown_read and shutdown_write to be TRUE — this
is equivalent to calling g_dtls_connection_close().
If cancellable is cancelled, the Gio.DtlsConnection may be left
partially-closed and any pending untransmitted data may be lost. Call
g_dtls_connection_shutdown() again to complete closing the Gio.DtlsConnection.
true to stop reception of incoming datagrams
true to stop sending outgoing datagrams
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
true on success, false otherwise
Asynchronously shut down part or all of the DTLS connection. See
g_dtls_connection_shutdown() for more information.
true to stop reception of incoming datagrams
true to stop sending outgoing datagrams
the I/O priority of the request
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
Asynchronously shut down part or all of the DTLS connection. See
g_dtls_connection_shutdown() for more information.
true to stop reception of incoming datagrams
true to stop sending outgoing datagrams
the I/O priority of the request
a Gio.Cancellable, or null
callback to call when the shutdown operation is complete
Asynchronously shut down part or all of the DTLS connection. See
g_dtls_connection_shutdown() for more information.
true to stop reception of incoming datagrams
true to stop sending outgoing datagrams
the I/O priority of the request
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
Optionalcallback: AsyncReadyCallback<Gio.DtlsConnection>callback to call when the shutdown operation is complete
Finish an asynchronous TLS shutdown operation. See
g_dtls_connection_shutdown() for more information.
true on success, false on failure, in which case error will be set
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.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.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
GObject.Binding 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.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
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.
If flags contains GObject.BindingFlags.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 transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
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.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default
a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
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.
GObject.IOCondition.IN will be set in the return value if data is available to read with
g_datagram_based_receive_messages(), or if the connection is closed remotely
(EOS); and if the datagram_based has not been closed locally using some
implementation-specific method (such as g_socket_close() or
g_socket_shutdown() with shutdown_read set, if it’s a Gio.Socket).
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 Gio.Socket, for
example), all calls to this function will return Gio.IOErrorEnum.CLOSED.
GObject.IOCondition.OUT will be set if it is expected that at least one byte can be sent
using g_datagram_based_send_messages() without blocking. It will not be set
if the datagram_based has been closed locally.
GObject.IOCondition.HUP will be set if the connection has been closed locally.
GObject.IOCondition.ERR will be set if there was an asynchronous error in transmitting data
previously enqueued using g_datagram_based_send_messages().
Note that on Windows, it is possible for an operation to return
Gio.IOErrorEnum.WOULD_BLOCK even immediately after
g_datagram_based_condition_check() has claimed that the Gio.DatagramBased is
ready for writing. Rather than calling g_datagram_based_condition_check() and
then writing to the Gio.DatagramBased if it succeeds, it is generally better to
simply try writing right away, and try again later if the initial attempt
returns Gio.IOErrorEnum.WOULD_BLOCK.
It is meaningless to specify GObject.IOCondition.ERR or GObject.IOCondition.HUP in condition; these
conditions will always be set in the output if they are true. Apart from
these flags, the output is guaranteed to be masked by condition.
This call never blocks.
a GObject.IOCondition mask to check
the GObject.IOCondition mask of the current state
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 (Gio.IOErrorEnum.CANCELLED or Gio.IOErrorEnum.TIMED_OUT).
a GObject.IOCondition mask to wait for
the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely
Optionalcancellable: Gio.Cancellabletrue if the condition was met, false otherwise
SignalconnectSignalconnect_Creates a GLib.Source that can be attached to a GLib.MainContext to monitor for
the availability of the specified condition on the Gio.DatagramBased. The
GLib.Source keeps a reference to the datagram_based.
The callback on the source is of the Gio.DatagramBasedSourceFunc type.
It is meaningless to specify GObject.IOCondition.ERR or GObject.IOCondition.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().
a GObject.IOCondition mask to monitor
Optionalcancellable: Gio.Cancellablea newly allocated GLib.Source
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
SignalemitThis function is intended for GObject.Object 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
GObject.Object::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.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
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.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
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.
the name of a property installed on the class of object.
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.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
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]);
the GObject.ParamSpec of a property installed on the class of object.
Receive one or more data messages from datagram_based in one go.
messages must point to an array of Gio.InputMessage structs and
num_messages must be the length of this array. Each Gio.InputMessage
contains a pointer to an array of Gio.InputVector 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 Gio.SocketMsgFlags 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 Gio.InputMessage.flags.
The other members of Gio.InputMessage 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 Gio.IOErrorEnum.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, Gio.IOErrorEnum.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 GObject.IOCondition.IN condition.
Note though that you may still receive Gio.IOErrorEnum.WOULD_BLOCK from
g_datagram_based_receive_messages() even if you were previously notified of a
GObject.IOCondition.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 Gio.Socket, for
example), all calls to this function will return Gio.IOErrorEnum.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, Gio.IOErrorEnum.CANCELLED is returned as with any
other error.
an array of Gio.InputMessage structs
an int containing Gio.SocketMsgFlags flags for the overall operation
the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely
Optionalcancellable: Gio.Cancellablea %GCancellable
number of messages received, or -1 on error. Note that the number of messages received may be smaller than num_messages if timeout is zero or positive, if the peer closed the connection, or if num_messages was larger than UIO_MAXIOV (1024), in which case the caller may re-try to receive the remaining messages.
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.
the same 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().
object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Send one or more data messages from datagram_based in one go.
messages must point to an array of Gio.OutputMessage structs and
num_messages must be the length of this array. Each Gio.OutputMessage
contains an address to send the data to, and a pointer to an array of
Gio.OutputVector 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 Gio.SocketMsgFlags 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 Gio.OutputMessage 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 Gio.IOErrorEnum.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, Gio.IOErrorEnum.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 GObject.IOCondition.OUT condition.
Note though that you may still receive Gio.IOErrorEnum.WOULD_BLOCK from
g_datagram_based_send_messages() even if you were previously notified of a
GObject.IOCondition.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 Gio.Socket, for
example), all calls to this function will return Gio.IOErrorEnum.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, Gio.IOErrorEnum.CANCELLED is returned as with any other error.
an array of Gio.OutputMessage structs
an int containing Gio.SocketMsgFlags flags
the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely
Optionalcancellable: Gio.Cancellablea %GCancellable
number of messages sent, or -1 on error. Note that the number of messages sent may be smaller than num_messages if timeout is zero or positive, or if num_messages was larger than UIO_MAXIOV (1024), in which case the caller may re-try to send the remaining messages.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
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 GLib.Quark 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 GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Sets a property on an object.
The name of the property to set
The value to set the property to
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
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().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
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.Object::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.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
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.Object 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.Object instance. Use g_clear_object() for this.
Virtualvfunc_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.
GObject.IOCondition.IN will be set in the return value if data is available to read with
g_datagram_based_receive_messages(), or if the connection is closed remotely
(EOS); and if the datagram_based has not been closed locally using some
implementation-specific method (such as g_socket_close() or
g_socket_shutdown() with shutdown_read set, if it’s a Gio.Socket).
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 Gio.Socket, for
example), all calls to this function will return Gio.IOErrorEnum.CLOSED.
GObject.IOCondition.OUT will be set if it is expected that at least one byte can be sent
using g_datagram_based_send_messages() without blocking. It will not be set
if the datagram_based has been closed locally.
GObject.IOCondition.HUP will be set if the connection has been closed locally.
GObject.IOCondition.ERR will be set if there was an asynchronous error in transmitting data
previously enqueued using g_datagram_based_send_messages().
Note that on Windows, it is possible for an operation to return
Gio.IOErrorEnum.WOULD_BLOCK even immediately after
g_datagram_based_condition_check() has claimed that the Gio.DatagramBased is
ready for writing. Rather than calling g_datagram_based_condition_check() and
then writing to the Gio.DatagramBased if it succeeds, it is generally better to
simply try writing right away, and try again later if the initial attempt
returns Gio.IOErrorEnum.WOULD_BLOCK.
It is meaningless to specify GObject.IOCondition.ERR or GObject.IOCondition.HUP in condition; these
conditions will always be set in the output if they are true. Apart from
these flags, the output is guaranteed to be masked by condition.
This call never blocks.
a GObject.IOCondition mask to check
Virtualvfunc_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 (Gio.IOErrorEnum.CANCELLED or Gio.IOErrorEnum.TIMED_OUT).
a GObject.IOCondition mask to wait for
the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely
Optionalcancellable: Gio.CancellableVirtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Creates a GLib.Source that can be attached to a GLib.MainContext to monitor for
the availability of the specified condition on the Gio.DatagramBased. The
GLib.Source keeps a reference to the datagram_based.
The callback on the source is of the Gio.DatagramBasedSourceFunc type.
It is meaningless to specify GObject.IOCondition.ERR or GObject.IOCondition.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().
a GObject.IOCondition mask to monitor
Optionalcancellable: Gio.CancellableVirtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_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.
Virtualvfunc_Receive one or more data messages from datagram_based in one go.
messages must point to an array of Gio.InputMessage structs and
num_messages must be the length of this array. Each Gio.InputMessage
contains a pointer to an array of Gio.InputVector 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 Gio.SocketMsgFlags 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 Gio.InputMessage.flags.
The other members of Gio.InputMessage 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 Gio.IOErrorEnum.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, Gio.IOErrorEnum.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 GObject.IOCondition.IN condition.
Note though that you may still receive Gio.IOErrorEnum.WOULD_BLOCK from
g_datagram_based_receive_messages() even if you were previously notified of a
GObject.IOCondition.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 Gio.Socket, for
example), all calls to this function will return Gio.IOErrorEnum.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, Gio.IOErrorEnum.CANCELLED is returned as with any
other error.
an array of Gio.InputMessage structs
an int containing Gio.SocketMsgFlags flags for the overall operation
the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely
Optionalcancellable: Gio.Cancellablea %GCancellable
Virtualvfunc_Send one or more data messages from datagram_based in one go.
messages must point to an array of Gio.OutputMessage structs and
num_messages must be the length of this array. Each Gio.OutputMessage
contains an address to send the data to, and a pointer to an array of
Gio.OutputVector 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 Gio.SocketMsgFlags 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 Gio.OutputMessage 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 Gio.IOErrorEnum.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, Gio.IOErrorEnum.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 GObject.IOCondition.OUT condition.
Note though that you may still receive Gio.IOErrorEnum.WOULD_BLOCK from
g_datagram_based_send_messages() even if you were previously notified of a
GObject.IOCondition.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 Gio.Socket, for
example), all calls to this function will return Gio.IOErrorEnum.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, Gio.IOErrorEnum.CANCELLED is returned as with any other error.
an array of Gio.OutputMessage structs
an int containing Gio.SocketMsgFlags flags
the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely
Optionalcancellable: Gio.Cancellablea %GCancellable
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
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.
GObject.Closure to watch
Virtualvfunc_Check whether to accept a certificate.
Virtualvfunc_Retrieve TLS channel binding data (Since: 2.66)
Virtualvfunc_Gets the name of the application-layer protocol negotiated during the handshake.
If the peer did not use the ALPN extension, or did not advertise a
protocol that matched one of conn's protocols, or the TLS backend
does not support ALPN, then this will be null. See
g_dtls_connection_set_advertised_protocols().
Virtualvfunc_Attempts a TLS handshake on conn.
On the client side, it is never necessary to call this method;
although the connection needs to perform a handshake after
connecting, Gio.DtlsConnection will handle this for you automatically
when you try to send or receive data on the connection. You can call
g_dtls_connection_handshake() manually if you want to know whether
the initial handshake succeeded or failed (as opposed to just
immediately trying to use conn to read or write, in which case,
if it fails, it may not be possible to tell if it failed before
or after completing the handshake), but beware that servers may reject
client authentication after the handshake has completed, so a
successful handshake does not indicate the connection will be usable.
Likewise, on the server side, although a handshake is necessary at the beginning of the communication, you do not need to call this function explicitly unless you want clearer error reporting.
Previously, calling g_dtls_connection_handshake() after the initial
handshake would trigger a rehandshake; however, this usage was
deprecated in GLib 2.60 because rehandshaking was removed from the
TLS protocol in TLS 1.3. Since GLib 2.64, calling this function after
the initial handshake will no longer do anything.
Gio.DtlsConnection.SignalSignatures.accept_certificate | Gio.DtlsConnection::accept_certificate may be emitted during the handshake.
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
Virtualvfunc_Asynchronously performs a TLS handshake on conn. See
g_dtls_connection_handshake() for more information.
the I/O priority of the request
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
Optionalcallback: AsyncReadyCallback<Gio.DtlsConnection>callback to call when the handshake is complete
Virtualvfunc_Finish an asynchronous TLS handshake operation. See
g_dtls_connection_handshake() for more information.
Virtualvfunc_Sets the list of application-layer protocols to advertise that the
caller is willing to speak on this connection. The
Application-Layer Protocol Negotiation (ALPN) extension will be
used to negotiate a compatible protocol with the peer; use
g_dtls_connection_get_negotiated_protocol() to find the negotiated
protocol after the handshake. Specifying null for the the value
of protocols will disable ALPN negotiation.
See IANA TLS ALPN Protocol IDs for a list of registered protocol IDs.
Optionalprotocols: string[]a null-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or null
Virtualvfunc_Shut down part or all of a DTLS connection.
If shutdown_read is true then the receiving side of the connection is shut
down, and further reading is disallowed. Subsequent calls to
g_datagram_based_receive_messages() will return Gio.IOErrorEnum.CLOSED.
If shutdown_write is true then the sending side of the connection is shut
down, and further writing is disallowed. Subsequent calls to
g_datagram_based_send_messages() will return Gio.IOErrorEnum.CLOSED.
It is allowed for both shutdown_read and shutdown_write to be TRUE — this
is equivalent to calling g_dtls_connection_close().
If cancellable is cancelled, the Gio.DtlsConnection may be left
partially-closed and any pending untransmitted data may be lost. Call
g_dtls_connection_shutdown() again to complete closing the Gio.DtlsConnection.
true to stop reception of incoming datagrams
true to stop sending outgoing datagrams
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
Virtualvfunc_Asynchronously shut down part or all of the DTLS connection. See
g_dtls_connection_shutdown() for more information.
true to stop reception of incoming datagrams
true to stop sending outgoing datagrams
the I/O priority of the request
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
Optionalcallback: AsyncReadyCallback<Gio.DtlsConnection>callback to call when the shutdown operation is complete
Virtualvfunc_Finish an asynchronous TLS shutdown operation. See
g_dtls_connection_shutdown() for more information.
Gio.DtlsConnection is the base DTLS connection class type, which wraps a Gio.DatagramBased and provides DTLS encryption on top of it. Its subclasses, Gio.DtlsClientConnection and Gio.DtlsServerConnection, implement client-side and server-side DTLS, respectively.
For TLS support, see Gio.TlsConnection.
As DTLS is datagram based, Gio.DtlsConnection implements Gio.DatagramBased, presenting a datagram-socket-like API for the encrypted connection. This operates over a base datagram connection, which is also a Gio.DatagramBased (Gio.DtlsConnection.base_socket).
To close a DTLS connection, use Gio.DtlsConnection.close.
Neither Gio.DtlsServerConnection or Gio.DtlsClientConnection set the peer address on their base Gio.DatagramBased if it is a Gio.Socket — it is up to the caller to do that if they wish. If they do not, and Gio.Socket.close is called on the base socket, the Gio.DtlsConnection will not raise a
G_IO_ERROR_NOT_CONNECTEDerror on further I/O.Since
2.48