Optionalproperties: Partial<Soup.Session.ConstructorProps>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.
Static$gtypeIf non-null, the value to use for the "Accept-Language" header
on Messages sent from this session.
Setting this will disable Session.accept_language_auto.
If true, Session will automatically set the string
for the "Accept-Language" header on every Message
sent, based on the return value of GLib.get_language_names.
Setting this will override any previous value of Session.accept_language.
If non-null, the value to use for the "Accept-Language" header
on Messages sent from this session.
Setting this will disable Session.accept_language_auto.
If true, Session will automatically set the string
for the "Accept-Language" header on every Message
sent, based on the return value of GLib.get_language_names.
Setting this will override any previous value of Session.accept_language.
Connection lifetime (in seconds) when idle. Any connection left idle longer than this will be closed.
Although you can change this property at any time, it will only affect newly-created connections, not currently-open ones. You can call Session.abort after setting this if you want to ensure that all future connections will have this timeout value.
Connection lifetime (in seconds) when idle. Any connection left idle longer than this will be closed.
Although you can change this property at any time, it will only affect newly-created connections, not currently-open ones. You can call Session.abort after setting this if you want to ensure that all future connections will have this timeout value.
Construct Onlylocal_Sets the Gio.InetSocketAddress to use for the client side of the connection.
Use this property if you want for instance to bind the local socket to a specific IP address.
Construct OnlylocalSets the Gio.InetSocketAddress to use for the client side of the connection.
Use this property if you want for instance to bind the local socket to a specific IP address.
Construct Onlymax_The maximum number of connections that the session can open at once.
Construct Onlymax_The maximum number of connections that the session can open at once to a given host.
Construct OnlymaxThe maximum number of connections that the session can open at once.
Construct OnlymaxThe maximum number of connections that the session can open at once to a given host.
A Gio.ProxyResolver to use with this session.
If no proxy resolver is set, then the default proxy resolver
will be used. See Gio.ProxyResolver.get_default.
You can set it to null if you don't want to use proxies, or
set it to your own Gio.ProxyResolver if you want to control
what proxies get used.
A Gio.ProxyResolver to use with this session.
If no proxy resolver is set, then the default proxy resolver
will be used. See Gio.ProxyResolver.get_default.
You can set it to null if you don't want to use proxies, or
set it to your own Gio.ProxyResolver if you want to control
what proxies get used.
Construct Onlyremote_Sets a socket to make outgoing connections on. This will override the default behaviour of opening TCP/IP sockets to the hosts specified in the URIs.
This function is not required for common HTTP usage, but only when connecting to a HTTP service that is not using standard TCP/IP sockets. An example of this is a local service that uses HTTP over UNIX-domain sockets, in that case a Gio.UnixSocketAddress can be passed to this function.
Construct OnlyremoteSets a socket to make outgoing connections on. This will override the default behaviour of opening TCP/IP sockets to the hosts specified in the URIs.
This function is not required for common HTTP usage, but only when connecting to a HTTP service that is not using standard TCP/IP sockets. An example of this is a local service that uses HTTP over UNIX-domain sockets, in that case a Gio.UnixSocketAddress can be passed to this function.
The timeout (in seconds) for socket I/O operations (including connecting to a server, and waiting for a reply to an HTTP request).
Although you can change this property at any time, it will only affect newly-created connections, not currently-open ones. You can call Session.abort after setting this if you want to ensure that all future connections will have this timeout value.
Not to be confused with Session.idle_timeout (which is the length of time that idle persistent connections will be kept open).
Sets the Gio.TlsDatabase to use for validating SSL/TLS certificates.
If no certificate database is set, then the default database will be used. See Gio.TlsBackend.get_default_database.
A Gio.TlsInteraction object that will be passed on to any Gio.TlsConnections created by the session.
This can be used to provide client-side certificates, for example.
Sets the Gio.TlsDatabase to use for validating SSL/TLS certificates.
If no certificate database is set, then the default database will be used. See Gio.TlsBackend.get_default_database.
A Gio.TlsInteraction object that will be passed on to any Gio.TlsConnections created by the session.
This can be used to provide client-side certificates, for example.
User-Agent string.
If non-null, the value to use for the "User-Agent" header
on Messages sent from this session.
RFC 2616 says: "The User-Agent request-header field contains information about the user agent originating the request. This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations. User agents SHOULD include this field with requests."
The User-Agent header contains a list of one or more product tokens, separated by whitespace, with the most significant product token coming first. The tokens must be brief, ASCII, and mostly alphanumeric (although "-", "_", and "." are also allowed), and may optionally include a "/" followed by a version string. You may also put comments, enclosed in parentheses, between or after the tokens.
If you set a Session.user_agent property that has trailing
whitespace, Session will append its own product token
(eg, libsoup/2.3.2) to the end of the
header for you.
User-Agent string.
If non-null, the value to use for the "User-Agent" header
on Messages sent from this session.
RFC 2616 says: "The User-Agent request-header field contains information about the user agent originating the request. This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations. User agents SHOULD include this field with requests."
The User-Agent header contains a list of one or more product tokens, separated by whitespace, with the most significant product token coming first. The tokens must be brief, ASCII, and mostly alphanumeric (although "-", "_", and "." are also allowed), and may optionally include a "/" followed by a version string. You may also put comments, enclosed in parentheses, between or after the tokens.
If you set a Session.user_agent property that has trailing
whitespace, Session will append its own product token
(eg, libsoup/2.3.2) to the end of the
header for you.
Cancels all pending requests in session and closes all idle
persistent connections.
Adds feature's functionality to session. You cannot add multiple
features of the same GObject.Type to a session.
See the main Session documentation for information on what features are present in sessions by default.
an object that implements Soup.SessionFeature
If feature_type is the type of a class that implements
SessionFeature, this creates a new feature of that type and
adds it to session as with Session.add_feature. You can use
this when you don't need to customize the new feature in any way.
Adding multiple features of the same feature_type is not allowed.
If feature_type is not a SessionFeature type, this gives each
existing feature on session the chance to accept feature_type as
a "subfeature". This can be used to add new Auth types, for instance.
See the main Session documentation for information on what features are present in sessions by default.
SignalconnectSignalconnect_SignalemitGet the value used by session for the "Accept-Language" header on new
requests.
the accept language string
Gets whether session automatically sets the "Accept-Language" header on new
requests.
true if session sets "Accept-Language" header automatically, or false otherwise.
Gets the Message of the result asynchronous operation This is useful
to get the Message of an asynchronous operation started by session
from its Gio.AsyncReadyCallback.
the Gio.AsyncResult passed to your callback
a Soup.Message or null if result is not a valid session async operation result.
Gets the feature in session of type feature_type.
the GObject.GType of the feature to get
a Soup.SessionFeature, or null. The feature is owned by session.
Gets the feature in session of type feature_type, provided
that it is not disabled for msg.
the GObject.GType of the feature to get
a Soup.SessionFeature. The feature is owned by session.
Get the timeout in seconds for idle connection lifetime currently used by
session.
the timeout in seconds
Get the Gio.InetSocketAddress to use for the client side of
connections in session.
Get the maximum number of connections that session can open at once.
the maximum number of connections
Get the maximum number of connections that session can open at once to a
given host.
the maximum number of connections per host
Get the Gio.ProxyResolver currently used by session.
a Gio.ProxyResolver or null if proxies are disabled in session
Get the timeout in seconds for socket I/O operations currently used by
session.
the timeout in seconds
Get the Gio.TlsInteraction currently used by session.
Get the value used by session for the "User-Agent" header on new requests.
the user agent string
Tests if session has at a feature of type feature_type (which can
be the type of either a SessionFeature, or else a subtype of
some class managed by another feature, such as Auth).
the GObject.GType of the class of features to check for
true or false
Start a preconnection to msg.
Once the connection is done, it will remain in idle state so that it can be
reused by future requests. If there's already an idle connection for the
given msg host, the operation finishes successfully without creating a new
connection. If a new request for the given msg host is made while the
preconnect is still ongoing, the request will take the ownership of the
connection and the preconnect operation will finish successfully (if there's
a connection error it will be handled by the request).
The operation finishes when the connection is done or an error occurred.
the I/O priority of the request
Optionalcancellable: Gio.CancellableStart a preconnection to msg.
Once the connection is done, it will remain in idle state so that it can be
reused by future requests. If there's already an idle connection for the
given msg host, the operation finishes successfully without creating a new
connection. If a new request for the given msg host is made while the
preconnect is still ongoing, the request will take the ownership of the
connection and the preconnect operation will finish successfully (if there's
a connection error it will be handled by the request).
The operation finishes when the connection is done or an error occurred.
the I/O priority of the request
the callback to invoke when the operation finishes
Start a preconnection to msg.
Once the connection is done, it will remain in idle state so that it can be
reused by future requests. If there's already an idle connection for the
given msg host, the operation finishes successfully without creating a new
connection. If a new request for the given msg host is made while the
preconnect is still ongoing, the request will take the ownership of the
connection and the preconnect operation will finish successfully (if there's
a connection error it will be handled by the request).
The operation finishes when the connection is done or an error occurred.
the I/O priority of the request
Optionalcancellable: Gio.CancellableOptionalcallback: AsyncReadyCallback<Soup.Session>the callback to invoke when the operation finishes
Complete a preconnect async operation started with Session.preconnect_async.
the Gio.AsyncResult passed to your callback
true if the preconnect succeeded, or false in case of error.
Removes feature's functionality from session.
a feature that has previously been added to session
Removes all features of type feature_type (or any subclass of
feature_type) from session.
Synchronously sends msg and waits for the beginning of a response.
On success, a Gio.InputStream will be returned which you can use to read the response body. ("Success" here means only that an HTTP response was received and understood; it does not necessarily mean that a 2xx class status code was received.)
If non-null, cancellable can be used to cancel the request;
Session.send will return a Gio.IOErrorEnum.CANCELLED error. Note that
with requests that have side effects (eg, POST, PUT, DELETE) it is
possible that you might cancel the request after the server acts on it, but
before it returns a response, leaving the remote resource in an unknown
state.
If msg is requeued due to a redirect or authentication, the
initial (3xx/401/407) response body will be suppressed, and
Session.send will only return once a final response has been
received.
Possible error domains include SessionError, Gio.IOErrorEnum, and Gio.TlsError which you may want to specifically handle.
Optionalcancellable: Gio.Cancellablea Gio.InputStream for reading the response body, or null on error.
Synchronously sends msg and reads the response body.
On success, a GLib.Bytes will be returned with the response body. This function should only be used when the resource to be retrieved is not too long and can be stored in memory.
See Session.send for more details on the general semantics.
Optionalcancellable: Gio.Cancellablea GLib.Bytes, or null on error.
Asynchronously sends msg and reads the response body.
When callback is called, then either msg has been sent, and its response
body read, or else an error has occurred. This function should only be used
when the resource to be retrieved is not too long and can be stored in
memory. Call Session.send_and_read_finish to get a
GLib.Bytes with the response body.
See Session.send for more details on the general semantics.
the I/O priority of the request
Optionalcancellable: Gio.CancellableAsynchronously sends msg and reads the response body.
When callback is called, then either msg has been sent, and its response
body read, or else an error has occurred. This function should only be used
when the resource to be retrieved is not too long and can be stored in
memory. Call Session.send_and_read_finish to get a
GLib.Bytes with the response body.
See Session.send for more details on the general semantics.
the I/O priority of the request
the callback to invoke
Asynchronously sends msg and reads the response body.
When callback is called, then either msg has been sent, and its response
body read, or else an error has occurred. This function should only be used
when the resource to be retrieved is not too long and can be stored in
memory. Call Session.send_and_read_finish to get a
GLib.Bytes with the response body.
See Session.send for more details on the general semantics.
the I/O priority of the request
Optionalcancellable: Gio.CancellableOptionalcallback: AsyncReadyCallback<Soup.Session>the callback to invoke
Gets the response to a Session.send_and_read_async.
If successful, returns a GLib.Bytes with the response body.
the Gio.AsyncResult passed to your callback
a GLib.Bytes, or null on error.
Synchronously sends msg and splices the response body stream into out_stream.
See Session.send for more details on the general semantics.
a set of Gio.OutputStreamSpliceFlags
Optionalcancellable: Gio.Cancellablea gssize containing the size of the data spliced, or -1 if an error occurred.
Asynchronously sends msg and splices the response body stream into out_stream.
When callback is called, then either msg has been sent and its response body
spliced, or else an error has occurred.
See Session.send for more details on the general semantics.
a set of Gio.OutputStreamSpliceFlags
the I/O priority of the request
Optionalcancellable: Gio.CancellableAsynchronously sends msg and splices the response body stream into out_stream.
When callback is called, then either msg has been sent and its response body
spliced, or else an error has occurred.
See Session.send for more details on the general semantics.
a set of Gio.OutputStreamSpliceFlags
the I/O priority of the request
the callback to invoke
Asynchronously sends msg and splices the response body stream into out_stream.
When callback is called, then either msg has been sent and its response body
spliced, or else an error has occurred.
See Session.send for more details on the general semantics.
a set of Gio.OutputStreamSpliceFlags
the I/O priority of the request
Optionalcancellable: Gio.CancellableOptionalcallback: AsyncReadyCallback<Soup.Session>the callback to invoke
Gets the response to a Session.send_and_splice_async.
the Gio.AsyncResult passed to your callback
a gssize containing the size of the data spliced, or -1 if an error occurred.
Asynchronously sends msg and waits for the beginning of a response.
When callback is called, then either msg has been sent, and its response
headers received, or else an error has occurred. Call
Session.send_finish to get a Gio.InputStream for reading the
response body.
See Session.send for more details on the general semantics.
the I/O priority of the request
Optionalcancellable: Gio.CancellableAsynchronously sends msg and waits for the beginning of a response.
When callback is called, then either msg has been sent, and its response
headers received, or else an error has occurred. Call
Session.send_finish to get a Gio.InputStream for reading the
response body.
See Session.send for more details on the general semantics.
the I/O priority of the request
the callback to invoke
Asynchronously sends msg and waits for the beginning of a response.
When callback is called, then either msg has been sent, and its response
headers received, or else an error has occurred. Call
Session.send_finish to get a Gio.InputStream for reading the
response body.
See Session.send for more details on the general semantics.
the I/O priority of the request
Optionalcancellable: Gio.CancellableOptionalcallback: AsyncReadyCallback<Soup.Session>the callback to invoke
Gets the response to a Session.send_async call.
If successful returns a Gio.InputStream that can be used to read the response body.
the Gio.AsyncResult passed to your callback
a Gio.InputStream for reading the response body, or null on error.
Set the value to use for the "Accept-Language" header on Messages
sent from session.
If accept_language is null then no "Accept-Language" will be included in
requests. See Session.accept_language for more information.
the languages string
Set whether session will automatically set the "Accept-Language" header on
requests using a value generated from system languages based on
GLib.get_language_names.
See Session.accept_language_auto for more information.
the value to set
Set a timeout in seconds for idle connection lifetime to be used by session
on new connections.
See Session.idle_timeout for more information.
a timeout in seconds
Set a Gio.ProxyResolver to be used by session on new connections.
If proxy_resolver is null then no proxies will be used. See
Session.proxy_resolver for more information.
Optionalproxy_resolver: Gio.ProxyResolvera Gio.ProxyResolver or null
Set a timeout in seconds for socket I/O operations to be used by session
on new connections.
See Session.timeout for more information.
a timeout in seconds
Set a Gio.TlsDatabase to be used by session on new connections.
If tls_database is null then certificate validation will always fail. See
Session.tls_database for more information.
Optionaltls_database: Gio.TlsDatabaseSet a Gio.TlsInteraction to be used by session on new connections.
If tls_interaction is null then client certificate validation will always
fail.
See Session.tls_interaction for more information.
Optionaltls_interaction: Gio.TlsInteractionSet the value to use for the "User-Agent" header on Messages sent
from session.
If user_agent has trailing whitespace, session will append its own product
token (eg, libsoup/3.0.0) to the end of the header for you. If user_agent
is null then no "User-Agent" will be included in requests. See
Session.user_agent for more information.
the user agent string
Virtualvfunc_Virtualvfunc_Asynchronously creates a WebsocketConnection to communicate with a remote server.
All necessary WebSocket-related headers will be added to msg, and
it will then be sent and asynchronously processed normally
(including handling of redirection and HTTP authentication).
If the server returns "101 Switching Protocols", then msg's status
code and response headers will be updated, and then the WebSocket
handshake will be completed. On success,
Session.websocket_connect_finish will return a new
WebsocketConnection. On failure it will return a GLib.Error.
If the server returns a status other than "101 Switching Protocols", then
msg will contain the complete response headers and body from the server's
response, and Session.websocket_connect_finish will return
Soup.WebsocketError.NOT_WEBSOCKET.
Soup.Message indicating the WebSocket server to connect to
origin of the connection
a null-terminated array of protocols supported
the I/O priority of the request
Optionalcancellable: Gio.CancellableAsynchronously creates a WebsocketConnection to communicate with a remote server.
All necessary WebSocket-related headers will be added to msg, and
it will then be sent and asynchronously processed normally
(including handling of redirection and HTTP authentication).
If the server returns "101 Switching Protocols", then msg's status
code and response headers will be updated, and then the WebSocket
handshake will be completed. On success,
Session.websocket_connect_finish will return a new
WebsocketConnection. On failure it will return a GLib.Error.
If the server returns a status other than "101 Switching Protocols", then
msg will contain the complete response headers and body from the server's
response, and Session.websocket_connect_finish will return
Soup.WebsocketError.NOT_WEBSOCKET.
Soup.Message indicating the WebSocket server to connect to
origin of the connection
a null-terminated array of protocols supported
the I/O priority of the request
the callback to invoke
Asynchronously creates a WebsocketConnection to communicate with a remote server.
All necessary WebSocket-related headers will be added to msg, and
it will then be sent and asynchronously processed normally
(including handling of redirection and HTTP authentication).
If the server returns "101 Switching Protocols", then msg's status
code and response headers will be updated, and then the WebSocket
handshake will be completed. On success,
Session.websocket_connect_finish will return a new
WebsocketConnection. On failure it will return a GLib.Error.
If the server returns a status other than "101 Switching Protocols", then
msg will contain the complete response headers and body from the server's
response, and Session.websocket_connect_finish will return
Soup.WebsocketError.NOT_WEBSOCKET.
Soup.Message indicating the WebSocket server to connect to
origin of the connection
a null-terminated array of protocols supported
the I/O priority of the request
Optionalcancellable: Gio.CancellableOptionalcallback: AsyncReadyCallback<Soup.Session>the callback to invoke
Gets the WebsocketConnection response to a Session.websocket_connect_async call.
If successful, returns a WebsocketConnection that can be used to communicate with the server.
the Gio.AsyncResult passed to your callback
a new Soup.WebsocketConnection, or null on error.
StaticnewCreates 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
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
This 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.
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.
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_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_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_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
Static_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_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().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_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
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
GObject.TypeInfo.) 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.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_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().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
Soup session state object.
Session is the object that controls client-side HTTP. A Session encapsulates all of the state that libsoup is keeping on behalf of your program; cached HTTP connections, authentication information, etc. It also keeps track of various global options and features that you are using.
Most applications will only need a single Session; the primary reason you might need multiple sessions is if you need to have multiple independent authentication contexts. (Eg, you are connecting to a server and authenticating as two different users at different times; the easiest way to ensure that each Message is sent with the authentication information you intended is to use one session for the first user, and a second session for the other user.)
Additional Session functionality is provided by SessionFeature objects, which can be added to a session with Session.add_feature or Session.add_feature_by_type For example, Logger provides support for logging HTTP traffic, ContentDecoder provides support for compressed response handling, and ContentSniffer provides support for HTML5-style response body content sniffing. Additionally, subtypes of Auth can be added as features, to add support for additional authentication types.
All Soup.Sessions are created with a AuthManager, and support for
SOUP_TYPE_AUTH_BASICandSOUP_TYPE_AUTH_DIGEST. Additionally, sessions using the plain Session class (rather than one of its deprecated subtypes) have a ContentDecoder by default.Note that all async methods will invoke their callbacks on the thread-default context at the time of the function call.