Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

svn_client_ctx_t Struct Reference

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_tauth_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.


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 477 of file svn_client.h.


Field Documentation

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 505 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.

Definition at line 498 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.

Definition at line 494 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 526 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.

Definition at line 489 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 521 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.

Definition at line 485 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 517 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 539 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 535 of file svn_client.h.


The documentation for this struct was generated from the following file:
Generated on Mon Jun 5 17:10:18 2006 for Subversion by  doxygen 1.3.9.1