svn_client_ctx_t Struct Reference
[Client context management]

A client context structure, which holds client specific callbacks, batons, serves as a cache for configuration options, and other various and sundry things. More...

#include <svn_client.h>

Data Fields
svn_auth_baton_t *	auth_baton
	main authentication baton.
svn_wc_notify_func_t	notify_func
	notification callback function.
void *	notify_baton
	notification callback baton for notify_func()
svn_client_get_commit_log_t	log_msg_func
	Log message callback function.
void *	log_msg_baton
	log message callback baton
apr_hash_t *	config
	a hash mapping of const char * configuration file names to svn_config_t *'s.
svn_cancel_func_t	cancel_func
	a callback to be used to see if the client wishes to cancel the running operation.
void *	cancel_baton
	a baton to pass to the cancellation callback.
svn_wc_notify_func2_t	notify_func2
	notification function, defaulting to a function that forwards to notify_func().
void *	notify_baton2
	notification baton for notify_func2().
svn_client_get_commit_log2_t	log_msg_func2
	Log message callback function.
void *	log_msg_baton2
	callback baton for log_msg_func2 Since: New in 1.3.
svn_ra_progress_notify_func_t	progress_func
	Notification callback for network progress information.
void *	progress_baton
	Callback baton for progress_func.
svn_client_get_commit_log3_t	log_msg_func3
	Log message callback function.
void *	log_msg_baton3
	The callback baton for log_msg_func3.
apr_hash_t *	mimetypes_map
	MIME types map.
svn_wc_conflict_resolver_func_t	conflict_func
	Conflict resolution callback and baton, if available.
void *	conflict_baton
const char *	client_name
	Custom client name string, or null.

---

Detailed Description

A client context structure, which holds client specific callbacks, batons, serves as a cache for configuration options, and other various and sundry things.

In order to avoid backwards compatibility problems clients should use svn_client_create_context() to allocate and intialize this structure instead of doing so themselves.

Definition at line 808 of file svn_client.h.

---

Field Documentation

const char* svn_client_ctx_t::client_name

Custom client name string, or null. Since: New in 1.5. Definition at line 896 of file svn_client.h.

apr_hash_t* svn_client_ctx_t::config

a hash mapping of const char * configuration file names to svn_config_t *'s. For example, the '~/.subversion/config' file's contents should have the key "config". May be left unset (or set to NULL) to use the built-in default settings and not use any configuration. Definition at line 840 of file svn_client.h.

svn_wc_conflict_resolver_func_t svn_client_ctx_t::conflict_func

Conflict resolution callback and baton, if available. Since: New in 1.5. Definition at line 891 of file svn_client.h.

void* svn_client_ctx_t::log_msg_baton

log message callback baton Deprecated: Provided for backward compatibility with the 1.2 API. Use log_msg_baton2 instead. Definition at line 833 of file svn_client.h.

void* svn_client_ctx_t::log_msg_baton3

The callback baton for log_msg_func3. Since: New in 1.5. Definition at line 883 of file svn_client.h.

svn_client_get_commit_log_t svn_client_ctx_t::log_msg_func

Log message callback function. NULL means that Subversion should try not attempt to fetch a log message. Deprecated: Provided for backward compatibility with the 1.2 API. Use log_msg_func2 instead. Definition at line 828 of file svn_client.h.

svn_client_get_commit_log2_t svn_client_ctx_t::log_msg_func2

Log message callback function. NULL means that Subversion should try log_msg_func. Since: New in 1.3. Definition at line 861 of file svn_client.h.

svn_client_get_commit_log3_t svn_client_ctx_t::log_msg_func3

Log message callback function. NULL means that Subversion should try log_msg_func2, then log_msg_func. Since: New in 1.5. Definition at line 879 of file svn_client.h.

apr_hash_t* svn_client_ctx_t::mimetypes_map

MIME types map. Since: New in 1.5. Definition at line 887 of file svn_client.h.

void* svn_client_ctx_t::notify_baton

notification callback baton for notify_func() Deprecated: Provided for backward compatibility with the 1.1 API. Use notify_baton2 instead Definition at line 822 of file svn_client.h.

void* svn_client_ctx_t::notify_baton2

notification baton for notify_func2(). Since: New in 1.2. Definition at line 856 of file svn_client.h.

svn_wc_notify_func_t svn_client_ctx_t::notify_func

notification callback function. This will be called by notify_func2() by default. Deprecated: Provided for backward compatibility with the 1.1 API. Use notify_func2 instead. Definition at line 817 of file svn_client.h.

svn_wc_notify_func2_t svn_client_ctx_t::notify_func2

notification function, defaulting to a function that forwards to notify_func(). Since: New in 1.2. Definition at line 852 of file svn_client.h.

void* svn_client_ctx_t::progress_baton

Callback baton for progress_func. Since: New in 1.3. Definition at line 874 of file svn_client.h.

svn_ra_progress_notify_func_t svn_client_ctx_t::progress_func

Notification callback for network progress information. May be NULL if not used. Since: New in 1.3. Definition at line 870 of file svn_client.h.

---

The documentation for this struct was generated from the following file:

• svn_client.h

---