Standard Callbacks

Name

Standard Callbacks -- module callbacks pre-defined by gnome-vfs

Synopsis



#define     GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION
#define     GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION
typedef     GnomeVFSModuleCallbackAuthenticationOut;
#define     GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE
typedef     GnomeVFSModuleCallbackStatusMessageIn;
typedef     GnomeVFSModuleCallbackStatusMessageOut;

Description

Some standard module callbacks are predefined. They include callbacks for authentication, http proxy authentication, and status messages. For each standard callback, a macro provides the name, and structures are defined for the in and out argument.

Details

GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION

#define GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION "simple-authentication"

This callback is called when access to a URI requires a username and password.

in : GnomeVFSModuleCallbackAuthenticationIn
out :GnomeVFSModuleCallbackAuthenticationOut


GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION

#define GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION "http:proxy-authentication"

This callback is called when access to an HTTP proxy requires a username and password.

in : GnomeVFSModuleCallbackAuthenticationIn
out :GnomeVFSModuleCallbackAuthenticationOut


GnomeVFSModuleCallbackAuthenticationOut

typedef struct {
	char *username;		/* will be freed by g_free,
				 * NULL indicates no auth should be provided;
				 * if the request requires authn, the operation
				 * will fail with a GNOME_VFS_ERROR_ACCESS_DENIED
				 * code
				 */
	char *password;		/* will be freed by g_free */

	/* Reserved "padding" to avoid future breaks in ABI compatibility */
	void *reserved1;
	void *reserved2;

} GnomeVFSModuleCallbackAuthenticationOut;


GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE

#define GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE "status-message"

This callback is called when a GnomeVFS module operation has a status message to return to the application.


GnomeVFSModuleCallbackStatusMessageIn

typedef struct {
	char *uri;		/* Full URI of operation */
	char *message;		/* A message indicating the current state or
				 * NULL if there is no message */
	int percentage;		/* Percentage indicating completeness 0-100 or
				 * -1 if there is no progress percentage to
				 * report */

	/* Reserved "padding" to avoid future breaks in ABI compatibility */
	void *reserved1;
	void *reserved2;
} GnomeVFSModuleCallbackStatusMessageIn;


GnomeVFSModuleCallbackStatusMessageOut

typedef struct {
	int dummy; /* empty structs not allowed */

	/* Reserved "padding" to avoid future breaks in ABI compatibility */
	void *reserved1;
	void *reserved2;
} GnomeVFSModuleCallbackStatusMessageOut;

See Also

Module Callbacks