Callbacks¶

	`AdoptedStateVectorForeachFunc` (id, value, *user_data)
	`AsyncOperationDoneFunc` (run_data, *user_data)
	`AsyncOperationRunFunc` (run_data, run_notify, *user_data)
	`DiscoveryResolvCompleteFunc` (info, connection, error, *user_data)
	`FileListFunc` (name, path, type, *user_data)
	`IoDispatchFunc` (*user_data)
	`IoTimeoutFunc` (*user_data)
	`IoWatchFunc` (socket, event, *user_data)
	`RequestFunc` (request, result, error, *user_data)
	`SaslContextCallbackFunc` (session, property, session_data, *user_data)
	`SaslContextSessionFeedFunc` (session, data, needs_more, error, *user_data)
	`UserTableForeachUserFunc` (user, *user_data)

Details¶

Infinity.AdoptedStateVectorForeachFunc(id, value, *user_data)¶

Parameters:

id (int) – The ID of the entry.
value (int) – The value of the entry.
user_data (object or None) – The user data passed to Infinity.AdoptedStateVector.foreach().

This function is called for every component in the state vector during the invocation of Infinity.AdoptedStateVector.foreach().

Infinity.AsyncOperationDoneFunc(run_data, *user_data)¶

Parameters:

run_data (object or None) – The result of the asynchronous operation.
user_data (object or None) – Data passed in Infinity.AsyncOperation.new().

This function is called in the main thread once the asynchronous operation has finished.

Infinity.AsyncOperationRunFunc(run_data, run_notify, *user_data)¶

Parameters:

run_data (object or None) – Location where to write the result of the asynchronous operation.
run_notify (GLib.DestroyNotify) – Function to be used to free run_data, or None.
user_data (object or None) – Data passed in Infinity.AsyncOperation.new().

This function performs the asynchronous task and is executed in a separate thread. The pointer written into run_data is passed back to the main thread after the function has finished executing.

Infinity.DiscoveryResolvCompleteFunc(info, connection, error, *user_data)¶

Parameters:

info (Infinity.DiscoveryInfo) – The resolved Infinity.DiscoveryInfo.
connection (Infinity.XmlConnection) – The resulting Infinity.XmlConnection.
error (GLib.Error) – Reason in case of failure.
user_data (object or None) – The user_data passed to Infinity.Discovery.resolve().

This callback is called when a call to Infinity.Discovery.resolve() finished.

Infinity.FileListFunc(name, path, type, *user_data)¶

Parameters:

name (str) – The name of the current file.
path (str) – The full path to the current file.
type (Infinity.FileType) – The type of the current file.
user_data (object or None) – User data specified at the time of the call.

Returns:

True if the iteration should be continued or False otherwise.

Return type:

bool

This is the prototype of the callback function passed to Infinity.file_util_list_directory(). If the function returns False then directory traversal is stopped immediately. In addition error can be set and it is propagated to the caller of Infinity.file_util_list_directory().

Infinity.IoDispatchFunc(*user_data)¶

Parameters:: user_data (object or None) – User-defined data specified in Infinity.Io.add_dispatch().

Callback function that is called when a dispatch is executed by the thread that runs Infinity.Io.

Infinity.IoTimeoutFunc(*user_data)¶

Parameters:: user_data (object or None) – User-defined data specified in Infinity.Io.add_timeout().

Callback function that is called when a timeout has elapsed.

Infinity.IoWatchFunc(socket, event, *user_data)¶

Parameters:

socket ([int]) – The socket on which an event occurred.
event (Infinity.IoEvent) – A bitmask of the events that occurred.
user_data (object or None) – User-defined data specified in Infinity.Io.add_watch().

Callback function that is called when an event occurs on a watched socket.

Infinity.RequestFunc(request, result, error, *user_data)¶

Parameters:

request (Infinity.Request) – The Infinity.Request that emits the signal.
result (Infinity.RequestResult) – A Infinity.RequestResult which contains the result of the request.
error (GLib.Error) – Error information in case the request failed, or None otherwise.
user_data (object or None) – Additional data set when the signal handler was connected.

Signature of a signal handler for the Infinity.Request ::finished signal.

Infinity.SaslContextCallbackFunc(session, property, session_data, *user_data)¶

Parameters:

session (Infinity.SaslContextSession) – A Infinity.SaslContextSession.
property (int) – The property requested.
session_data (object or None) – The session data for session specified in Infinity.SaslContext.server_start_session() or Infinity.SaslContext.client_start_session().
user_data (object or None) – The user data specified in Infinity.SaslContext.set_callback().

This callback is called whenever a property is required to proceed with authentication. For example, when a password is required, the callback is called with property set to %GSASL_PASSCODE.

The function is then expected to set that property using Infinity.SaslContextSession.set_property() and, once it is done, call Infinity.SaslContextSession.continue_(). This can happen fully asynchronously, that is it does not need to take place directly within the callback but the callback can, for example, open a dialog for the user to enter a password and then once the user closes the dialog call the two functions mentioned above.

Infinity.SaslContextSessionFeedFunc(session, data, needs_more, error, *user_data)¶

Parameters:

session (Infinity.SaslContextSession) – A Infinity.SaslContextSession.
data (str) – The response to the fed data, base64 encoded and null-terminated.
needs_more (bool) – If True then Infinity.SaslContextSession.feed() needs to be called again with more data, otherwise the authentication has finished.
error (GLib.Error) – This is nonzero if an error occurred while processing the input data.
user_data (object or None) – The user data specified in Infinity.SaslContextSession.feed().

This function is called in response to Infinity.SaslContextSession.feed(). When all required properties (if any) have been provided by the callback function then this function is called with the response to send to the remote site.

If an error occurred then error will be set and data will be None.

Infinity.UserTableForeachUserFunc(user, *user_data)¶

Parameters:

user (Infinity.User) – The Infinity.User for the current iteration.
user_data (object or None) – The user_data passed to Infinity.UserTable.foreach_user() or Infinity.UserTable.foreach_local_user().

This callback is called for every user iterated by Infinity.UserTable.foreach_user() or Infinity.UserTable.foreach_local_user().