contrib/subversion/subversion/include/svn_ra_svn.h

   1 /**
   2  * @copyright
   3  * ====================================================================
   4  *    Licensed to the Apache Software Foundation (ASF) under one
   5  *    or more contributor license agreements.  See the NOTICE file
   6  *    distributed with this work for additional information
   7  *    regarding copyright ownership.  The ASF licenses this file
   8  *    to you under the Apache License, Version 2.0 (the
   9  *    "License"); you may not use this file except in compliance
  10  *    with the License.  You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  *    Unless required by applicable law or agreed to in writing,
  15  *    software distributed under the License is distributed on an
  16  *    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  17  *    KIND, either express or implied.  See the License for the
  18  *    specific language governing permissions and limitations
  19  *    under the License.
  20  * ====================================================================
  21  * @endcopyright
  22  *
  23  * @file svn_ra_svn.h
  24  * @brief libsvn_ra_svn functions used by the server
  25  */
  26
  27 #ifndef SVN_RA_SVN_H
  28 #define SVN_RA_SVN_H
  29
  30 #include <apr.h>
  31 #include <apr_pools.h>
  32 #include <apr_hash.h>
  33 #include <apr_tables.h>
  34 #include <apr_file_io.h>     /* for apr_file_t */
  35 #include <apr_network_io.h>  /* for apr_socket_t */
  36
  37 #include "svn_types.h"
  38 #include "svn_string.h"
  39 #include "svn_config.h"
  40 #include "svn_delta.h"
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif /* __cplusplus */
  45
  46 /** The well-known svn port number. */
  47 #define SVN_RA_SVN_PORT 3690
  48
  49 /** Currently-defined capabilities. */
  50 #define SVN_RA_SVN_CAP_EDIT_PIPELINE "edit-pipeline"
  51 #define SVN_RA_SVN_CAP_SVNDIFF1 "svndiff1"
  52 #define SVN_RA_SVN_CAP_ABSENT_ENTRIES "absent-entries"
  53 /* maps to SVN_RA_CAPABILITY_COMMIT_REVPROPS: */
  54 #define SVN_RA_SVN_CAP_COMMIT_REVPROPS "commit-revprops"
  55 /* maps to SVN_RA_CAPABILITY_MERGEINFO: */
  56 #define SVN_RA_SVN_CAP_MERGEINFO "mergeinfo"
  57 /* maps to SVN_RA_CAPABILITY_DEPTH: */
  58 #define SVN_RA_SVN_CAP_DEPTH "depth"
  59 /* maps to SVN_RA_CAPABILITY_LOG_REVPROPS */
  60 #define SVN_RA_SVN_CAP_LOG_REVPROPS "log-revprops"
  61 /* maps to SVN_RA_CAPABILITY_PARTIAL_REPLAY */
  62 #define SVN_RA_SVN_CAP_PARTIAL_REPLAY "partial-replay"
  63 /* maps to SVN_RA_CAPABILITY_ATOMIC_REVPROPS */
  64 #define SVN_RA_SVN_CAP_ATOMIC_REVPROPS "atomic-revprops"
  65 /* maps to SVN_RA_CAPABILITY_INHERITED_PROPERTIES: */
  66 #define SVN_RA_SVN_CAP_INHERITED_PROPS "inherited-props"
  67 /* maps to SVN_RA_CAPABILITY_EPHEMERAL_TXNPROPS */
  68 #define SVN_RA_SVN_CAP_EPHEMERAL_TXNPROPS "ephemeral-txnprops"
  69 /* maps to SVN_RA_CAPABILITY_GET_FILE_REVS_REVERSE */
  70 #define SVN_RA_SVN_CAP_GET_FILE_REVS_REVERSE "file-revs-reverse"
  71
  72
  73 /** ra_svn passes @c svn_dirent_t fields over the wire as a list of
  74  * words, these are the values used to represent each field.
  75  *
  76  * @defgroup ra_svn_dirent_fields Definitions of ra_svn dirent fields
  77  * @{
  78  */
  79
  80 /** The ra_svn way of saying @c SVN_DIRENT_KIND. */
  81 #define SVN_RA_SVN_DIRENT_KIND "kind"
  82
  83 /** The ra_svn way of saying @c SVN_DIRENT_SIZE. */
  84 #define SVN_RA_SVN_DIRENT_SIZE "size"
  85
  86 /** The ra_svn way of saying @c SVN_DIRENT_HAS_PROPS. */
  87 #define SVN_RA_SVN_DIRENT_HAS_PROPS "has-props"
  88
  89 /** The ra_svn way of saying @c SVN_DIRENT_CREATED_REV. */
  90 #define SVN_RA_SVN_DIRENT_CREATED_REV "created-rev"
  91
  92 /** The ra_svn way of saying @c SVN_DIRENT_TIME. */
  93 #define SVN_RA_SVN_DIRENT_TIME "time"
  94
  95 /** The ra_svn way of saying @c SVN_DIRENT_LAST_AUTHOR. */
  96 #define SVN_RA_SVN_DIRENT_LAST_AUTHOR "last-author"
  97
  98 /** @} */
  99
 100 /** A value used to indicate an optional number element in a tuple that was
 101  * not received.
 102  */
 103 #define SVN_RA_SVN_UNSPECIFIED_NUMBER ~((apr_uint64_t) 0)
 104
 105 /** A specialized form of @c SVN_ERR to deal with errors which occur in an
 106  * svn_ra_svn_command_handler().
 107  *
 108  * An error returned with this macro will be passed back to the other side
 109  * of the connection.  Use this macro when performing the requested operation;
 110  * use the regular @c SVN_ERR when performing I/O with the client.
 111  */
 112 #define SVN_CMD_ERR(expr)                                     \
 113   do {                                                        \
 114     svn_error_t *svn_err__temp = (expr);                      \
 115     if (svn_err__temp)                                        \
 116       return svn_error_create(SVN_ERR_RA_SVN_CMD_ERR,         \
 117                               svn_err__temp, NULL);           \
 118   } while (0)
 119
 120 /** an ra_svn connection. */
 121 typedef struct svn_ra_svn_conn_st svn_ra_svn_conn_t;
 122
 123 /** Command handler, used by svn_ra_svn_handle_commands(). */
 124 typedef svn_error_t *(*svn_ra_svn_command_handler)(svn_ra_svn_conn_t *conn,
 125                                                    apr_pool_t *pool,
 126                                                    apr_array_header_t *params,
 127                                                    void *baton);
 128
 129 /** Command table, used by svn_ra_svn_handle_commands().
 130  */
 131 typedef struct svn_ra_svn_cmd_entry_t
 132 {
 133   /** Name of the command */
 134   const char *cmdname;
 135
 136   /** Handler for the command */
 137   svn_ra_svn_command_handler handler;
 138
 139   /** Termination flag.  If set, command-handling will cease after
 140    * command is processed. */
 141   svn_boolean_t terminate;
 142 } svn_ra_svn_cmd_entry_t;
 143
 144 /** Memory representation of an on-the-wire data item. */
 145 typedef struct svn_ra_svn_item_t
 146 {
 147   /** Variant indicator. */
 148   enum {
 149     SVN_RA_SVN_NUMBER,
 150     SVN_RA_SVN_STRING,
 151     SVN_RA_SVN_WORD,
 152     SVN_RA_SVN_LIST
 153   } kind;
 154   /** Variant data. */
 155   union {
 156     apr_uint64_t number;
 157     svn_string_t *string;
 158     const char *word;
 159
 160     /** Contains @c svn_ra_svn_item_t's. */
 161     apr_array_header_t *list;
 162   } u;
 163 } svn_ra_svn_item_t;
 164
 165 typedef svn_error_t *(*svn_ra_svn_edit_callback)(void *baton);
 166
 167 /** Initialize a connection structure for the given socket or
 168  * input/output files.
 169  *
 170  * Either @a sock or @a in_file/@a out_file must be set, not both.
 171  * @a compression_level specifies the desired network data compression
 172  * level (zlib) from 0 (no compression) to 9 (best but slowest).
 173  *
 174  * If @a zero_copy_limit is not 0, cached file contents smaller than the
 175  * given limit may be sent directly to the network socket.  Otherwise,
 176  * it will be copied into a temporary buffer before being forwarded to
 177  * the network stack.  Since the zero-copy code path has to enforce strict
 178  * time-outs, the receiver must be able to process @a zero_copy_limit
 179  * bytes within one second.  Even temporary failure to do so may cause
 180  * the server to cancel the respective operation with a time-out error.
 181  *
 182  * To reduce the overhead of checking for cancellation requests from the
 183  * data receiver, set @a error_check_interval to some non-zero value.
 184  * It defines the number of bytes that must have been sent since the last
 185  * check before the next check will be made.
 186  *
 187  * Allocate the result in @a pool.
 188  *
 189  * @since New in 1.8
 190  */
 191 svn_ra_svn_conn_t *svn_ra_svn_create_conn3(apr_socket_t *sock,
 192                                            apr_file_t *in_file,
 193                                            apr_file_t *out_file,
 194                                            int compression_level,
 195                                            apr_size_t zero_copy_limit,
 196                                            apr_size_t error_check_interval,
 197                                            apr_pool_t *pool);
 198
 199 /** Similar to svn_ra_svn_create_conn3() but disables the zero copy code
 200  * path and sets the error checking interval to 0.
 201  *
 202  * @since New in 1.7.
 203  *
 204  * @deprecated Provided for backward compatibility with the 1.7 API.
 205  */
 206 SVN_DEPRECATED
 207 svn_ra_svn_conn_t *
 208 svn_ra_svn_create_conn2(apr_socket_t *sock,
 209                         apr_file_t *in_file,
 210                         apr_file_t *out_file,
 211                         int compression_level,
 212                         apr_pool_t *pool);
 213
 214 /** Similar to svn_ra_svn_create_conn2() but uses the default
 215  * compression level (#SVN_DELTA_COMPRESSION_LEVEL_DEFAULT) for network
 216  * transmissions.
 217  *
 218  * @deprecated Provided for backward compatibility with the 1.6 API.
 219  */
 220 SVN_DEPRECATED
 221 svn_ra_svn_conn_t *
 222 svn_ra_svn_create_conn(apr_socket_t *sock,
 223                        apr_file_t *in_file,
 224                        apr_file_t *out_file,
 225                        apr_pool_t *pool);
 226
 227 /** Add the capabilities in @a list to @a conn's capabilities.
 228  * @a list contains svn_ra_svn_item_t entries (which should be of type
 229  * SVN_RA_SVN_WORD; a malformed data error will result if any are not).
 230  *
 231  * This is idempotent: if a given capability was already set for
 232  * @a conn, it remains set.
 233  */
 234 svn_error_t *
 235 svn_ra_svn_set_capabilities(svn_ra_svn_conn_t *conn,
 236                             const apr_array_header_t *list);
 237
 238 /** Return @c TRUE if @a conn has the capability @a capability, or
 239  * @c FALSE if it does not. */
 240 svn_boolean_t
 241 svn_ra_svn_has_capability(svn_ra_svn_conn_t *conn,
 242                           const char *capability);
 243
 244 /** Return the data compression level to use for network transmissions.
 245  *
 246  * @since New in 1.7.
 247  */
 248 int
 249 svn_ra_svn_compression_level(svn_ra_svn_conn_t *conn);
 250
 251 /** Return the zero-copy data block limit to use for network
 252  * transmissions.
 253  *
 254  * @see http://en.wikipedia.org/wiki/Zero-copy
 255  *
 256  * @since New in 1.8.
 257  */
 258 apr_size_t
 259 svn_ra_svn_zero_copy_limit(svn_ra_svn_conn_t *conn);
 260
 261 /** Returns the remote address of the connection as a string, if known,
 262  *  or NULL if inapplicable. */
 263 const char *
 264 svn_ra_svn_conn_remote_host(svn_ra_svn_conn_t *conn);
 265
 266 /** Set @a *editor and @a *edit_baton to an editor which will pass editing
 267  * operations over the network, using @a conn and @a pool.
 268  *
 269  * Upon successful completion of the edit, the editor will invoke @a callback
 270  * with @a callback_baton as an argument.
 271  */
 272 void
 273 svn_ra_svn_get_editor(const svn_delta_editor_t **editor,
 274                       void **edit_baton,
 275                       svn_ra_svn_conn_t *conn,
 276                       apr_pool_t *pool,
 277                       svn_ra_svn_edit_callback callback,
 278                       void *callback_baton);
 279
 280 /** Receive edit commands over the network and use them to drive @a editor
 281  * with @a edit_baton.  On return, @a *aborted will be set if the edit was
 282  * aborted.  The drive can be terminated with a finish-replay command only
 283  * if @a for_replay is TRUE.
 284  *
 285  * @since New in 1.4.
 286  */
 287 svn_error_t *
 288 svn_ra_svn_drive_editor2(svn_ra_svn_conn_t *conn,
 289                          apr_pool_t *pool,
 290                          const svn_delta_editor_t *editor,
 291                          void *edit_baton,
 292                          svn_boolean_t *aborted,
 293                          svn_boolean_t for_replay);
 294
 295 /** Like svn_ra_svn_drive_editor2, but with @a for_replay always FALSE.
 296  *
 297  * @deprecated Provided for backward compatibility with the 1.3 API.
 298  */
 299 SVN_DEPRECATED
 300 svn_error_t *
 301 svn_ra_svn_drive_editor(svn_ra_svn_conn_t *conn,
 302                         apr_pool_t *pool,
 303                         const svn_delta_editor_t *editor,
 304                         void *edit_baton,
 305                         svn_boolean_t *aborted);
 306
 307 /** This function is only intended for use by svnserve.
 308  *
 309  * Perform CRAM-MD5 password authentication.  On success, return
 310  * SVN_NO_ERROR with *user set to the username and *success set to
 311  * TRUE.  On an error which can be reported to the client, report the
 312  * error and return SVN_NO_ERROR with *success set to FALSE.  On
 313  * communications failure, return an error.
 314  */
 315 svn_error_t *
 316 svn_ra_svn_cram_server(svn_ra_svn_conn_t *conn,
 317                        apr_pool_t *pool,
 318                        svn_config_t *pwdb,
 319                        const char **user,
 320                        svn_boolean_t *success);
 321
 322 /**
 323  * Get libsvn_ra_svn version information.
 324  * @since New in 1.1.
 325  */
 326 const svn_version_t *
 327 svn_ra_svn_version(void);
 328
 329 /**
 330  * @defgroup ra_svn_deprecated ra_svn low-level functions
 331  * @{
 332  */
 333
 334 /** Write a number over the net.
 335  *
 336  * Writes will be buffered until the next read or flush.
 337  *
 338  * @deprecated Provided for backward compatibility with the 1.7 API.
 339  *             RA_SVN low-level functions are no longer considered public.
 340  */
 341 SVN_DEPRECATED
 342 svn_error_t *
 343 svn_ra_svn_write_number(svn_ra_svn_conn_t *conn,
 344                         apr_pool_t *pool,
 345                         apr_uint64_t number);
 346
 347 /** Write a string over the net.
 348  *
 349  * Writes will be buffered until the next read or flush.
 350  *
 351  * @deprecated Provided for backward compatibility with the 1.7 API.
 352  *             RA_SVN low-level functions are no longer considered public.
 353  */
 354 SVN_DEPRECATED
 355 svn_error_t *
 356 svn_ra_svn_write_string(svn_ra_svn_conn_t *conn,
 357                         apr_pool_t *pool,
 358                         const svn_string_t *str);
 359
 360 /** Write a cstring over the net.
 361  *
 362  * Writes will be buffered until the next read or flush.
 363  *
 364  * @deprecated Provided for backward compatibility with the 1.7 API.
 365  *             RA_SVN low-level functions are no longer considered public.
 366  */
 367 SVN_DEPRECATED
 368 svn_error_t *
 369 svn_ra_svn_write_cstring(svn_ra_svn_conn_t *conn,
 370                          apr_pool_t *pool,
 371                          const char *s);
 372
 373 /** Write a word over the net.
 374  *
 375  * Writes will be buffered until the next read or flush.
 376  *
 377  * @deprecated Provided for backward compatibility with the 1.7 API.
 378  *             RA_SVN low-level functions are no longer considered public.
 379  */
 380 SVN_DEPRECATED
 381 svn_error_t *
 382 svn_ra_svn_write_word(svn_ra_svn_conn_t *conn,
 383                       apr_pool_t *pool,
 384                       const char *word);
 385
 386 /** Write a list of properties over the net.  @a props is allowed to be NULL,
 387  * in which case an empty list will be written out.
 388  *
 389  * @since New in 1.5.
 390  *
 391  * @deprecated Provided for backward compatibility with the 1.7 API.
 392  *             RA_SVN low-level functions are no longer considered public.
 393  */
 394 SVN_DEPRECATED
 395 svn_error_t *
 396 svn_ra_svn_write_proplist(svn_ra_svn_conn_t *conn,
 397                           apr_pool_t *pool,
 398                           apr_hash_t *props);
 399
 400 /** Begin a list.  Writes will be buffered until the next read or flush.
 401  *
 402  * @deprecated Provided for backward compatibility with the 1.7 API.
 403  *             RA_SVN low-level functions are no longer considered public.
 404  */
 405 SVN_DEPRECATED
 406 svn_error_t *
 407 svn_ra_svn_start_list(svn_ra_svn_conn_t *conn,
 408                       apr_pool_t *pool);
 409
 410 /** End a list.  Writes will be buffered until the next read or flush.
 411  *
 412  * @deprecated Provided for backward compatibility with the 1.7 API.
 413  *             RA_SVN low-level functions are no longer considered public.
 414  */
 415 SVN_DEPRECATED
 416 svn_error_t *
 417 svn_ra_svn_end_list(svn_ra_svn_conn_t *conn,
 418                     apr_pool_t *pool);
 419
 420 /** Flush the write buffer.
 421  *
 422  * Normally this shouldn't be necessary, since the write buffer is flushed
 423  * when a read is attempted.
 424  *
 425  * @deprecated Provided for backward compatibility with the 1.7 API.
 426  *             RA_SVN low-level functions are no longer considered public.
 427  */
 428 SVN_DEPRECATED
 429 svn_error_t *
 430 svn_ra_svn_flush(svn_ra_svn_conn_t *conn,
 431                  apr_pool_t *pool);
 432
 433 /** Write a tuple, using a printf-like interface.
 434  *
 435  * The format string @a fmt may contain:
 436  *
 437  *@verbatim
 438      Spec  Argument type         Item type
 439      ----  --------------------  ---------
 440      n     apr_uint64_t          Number
 441      r     svn_revnum_t          Number
 442      s     const svn_string_t *  String
 443      c     const char *          String
 444      w     const char *          Word
 445      b     svn_boolean_t         Word ("true" or "false")
 446      (                           Begin tuple
 447      )                           End tuple
 448      ?                           Remaining elements optional
 449      ! (at beginning or end)     Suppress opening or closing of tuple
 450   @endverbatim
 451  *
 452  * Inside the optional part of a tuple, 'r' values may be @c
 453  * SVN_INVALID_REVNUM, 'n' values may be
 454  * SVN_RA_SVN_UNSPECIFIED_NUMBER, and 's', 'c', and 'w' values may be
 455  * @c NULL; in these cases no data will be written.  'b' and '(' may
 456  * not appear in the optional part of a tuple.  Either all or none of
 457  * the optional values should be valid.
 458  *
 459  * (If we ever have a need for an optional boolean value, we should
 460  * invent a 'B' specifier which stores a boolean into an int, using -1
 461  * for unspecified.  Right now there is no need for such a thing.)
 462  *
 463  * Use the '!' format specifier to write partial tuples when you have
 464  * to transmit an array or other unusual data.  For example, to write
 465  * a tuple containing a revision, an array of words, and a boolean:
 466  * @code
 467      SVN_ERR(svn_ra_svn_write_tuple(conn, pool, "r(!", rev));
 468      for (i = 0; i < n; i++)
 469        SVN_ERR(svn_ra_svn_write_word(conn, pool, words[i]));
 470      SVN_ERR(svn_ra_svn_write_tuple(conn, pool, "!)b", flag)); @endcode
 471  *
 472  * @deprecated Provided for backward compatibility with the 1.7 API.
 473  *             RA_SVN low-level functions are no longer considered public.
 474  */
 475 SVN_DEPRECATED
 476 svn_error_t *
 477 svn_ra_svn_write_tuple(svn_ra_svn_conn_t *conn,
 478                        apr_pool_t *pool,
 479                        const char *fmt, ...);
 480
 481 /** Read an item from the network into @a *item.
 482  *
 483  * @deprecated Provided for backward compatibility with the 1.7 API.
 484  *             RA_SVN low-level functions are no longer considered public.
 485  */
 486 SVN_DEPRECATED
 487 svn_error_t *
 488 svn_ra_svn_read_item(svn_ra_svn_conn_t *conn,
 489                      apr_pool_t *pool,
 490                      svn_ra_svn_item_t **item);
 491
 492 /** Scan data on @a conn until we find something which looks like the
 493  * beginning of an svn server greeting (an open paren followed by a
 494  * whitespace character).  This function is appropriate for beginning
 495  * a client connection opened in tunnel mode, since people's dotfiles
 496  * sometimes write output to stdout.  It may only be called at the
 497  * beginning of a client connection.
 498  *
 499  * @deprecated Provided for backward compatibility with the 1.7 API.
 500  *             RA_SVN low-level functions are no longer considered public.
 501  */
 502 SVN_DEPRECATED
 503 svn_error_t *
 504 svn_ra_svn_skip_leading_garbage(svn_ra_svn_conn_t *conn,
 505                                 apr_pool_t *pool);
 506
 507 /** Parse an array of @c svn_sort__item_t structures as a tuple, using a
 508  * printf-like interface.  The format string @a fmt may contain:
 509  *
 510  *@verbatim
 511      Spec  Argument type          Item type
 512      ----  --------------------   ---------
 513      n     apr_uint64_t *         Number
 514      r     svn_revnum_t *         Number
 515      s     svn_string_t **        String
 516      c     const char **          String
 517      w     const char **          Word
 518      b     svn_boolean_t *        Word ("true" or "false")
 519      B     apr_uint64_t *         Word ("true" or "false")
 520      l     apr_array_header_t **  List
 521      (                            Begin tuple
 522      )                            End tuple
 523      ?                            Tuple is allowed to end here
 524   @endverbatim
 525  *
 526  * Note that a tuple is only allowed to end precisely at a '?', or at
 527  * the end of the specification.  So if @a fmt is "c?cc" and @a list
 528  * contains two elements, an error will result.
 529  *
 530  * 'B' is similar to 'b', but may be used in the optional tuple specification.
 531  * It returns TRUE, FALSE, or SVN_RA_SVN_UNSPECIFIED_NUMBER.
 532  *
 533  * If an optional part of a tuple contains no data, 'r' values will be
 534  * set to @c SVN_INVALID_REVNUM, 'n' and 'B' values will be set to
 535  * SVN_RA_SVN_UNSPECIFIED_NUMBER, and 's', 'c', 'w', and 'l' values
 536  * will be set to @c NULL.  'b' may not appear inside an optional
 537  * tuple specification; use 'B' instead.
 538  *
 539  * @deprecated Provided for backward compatibility with the 1.7 API.
 540  *             RA_SVN low-level functions are no longer considered public.
 541  */
 542 SVN_DEPRECATED
 543 svn_error_t *
 544 svn_ra_svn_parse_tuple(const apr_array_header_t *list,
 545                        apr_pool_t *pool,
 546                        const char *fmt, ...);
 547
 548 /** Read a tuple from the network and parse it as a tuple, using the
 549  * format string notation from svn_ra_svn_parse_tuple().
 550  *
 551  * @deprecated Provided for backward compatibility with the 1.7 API.
 552  *             RA_SVN low-level functions are no longer considered public.
 553  */
 554 SVN_DEPRECATED
 555 svn_error_t *
 556 svn_ra_svn_read_tuple(svn_ra_svn_conn_t *conn,
 557                       apr_pool_t *pool,
 558                       const char *fmt, ...);
 559
 560 /** Parse an array of @c svn_ra_svn_item_t structures as a list of
 561  * properties, storing the properties in a hash table.
 562  *
 563  * @since New in 1.5.
 564  *
 565  * @deprecated Provided for backward compatibility with the 1.7 API.
 566  *             RA_SVN low-level functions are no longer considered public.
 567  */
 568 SVN_DEPRECATED
 569 svn_error_t *
 570 svn_ra_svn_parse_proplist(const apr_array_header_t *list,
 571                           apr_pool_t *pool,
 572                           apr_hash_t **props);
 573
 574 /** Read a command response from the network and parse it as a tuple, using
 575  * the format string notation from svn_ra_svn_parse_tuple().
 576  *
 577  * @deprecated Provided for backward compatibility with the 1.7 API.
 578  *             RA_SVN low-level functions are no longer considered public.
 579  */
 580 SVN_DEPRECATED
 581 svn_error_t *
 582 svn_ra_svn_read_cmd_response(svn_ra_svn_conn_t *conn,
 583                              apr_pool_t *pool,
 584                              const char *fmt, ...);
 585
 586 /** Accept commands over the network and handle them according to @a
 587  * commands.  Command handlers will be passed @a conn, a subpool of @a
 588  * pool (cleared after each command is handled), the parameters of the
 589  * command, and @a baton.  Commands will be accepted until a
 590  * terminating command is received (a command with "terminate" set in
 591  * the command table).  If a command handler returns an error wrapped
 592  * in SVN_RA_SVN_CMD_ERR (see the @c SVN_CMD_ERR macro), the error
 593  * will be reported to the other side of the connection and the
 594  * command loop will continue; any other kind of error (typically a
 595  * network or protocol error) is passed through to the caller.
 596  *
 597  * @since New in 1.6.
 598  *
 599  * @deprecated Provided for backward compatibility with the 1.7 API.
 600  *             RA_SVN low-level functions are no longer considered public.
 601  */
 602 SVN_DEPRECATED
 603 svn_error_t *
 604 svn_ra_svn_handle_commands2(svn_ra_svn_conn_t *conn,
 605                             apr_pool_t *pool,
 606                             const svn_ra_svn_cmd_entry_t *commands,
 607                             void *baton,
 608                             svn_boolean_t error_on_disconnect);
 609
 610 /** Similar to svn_ra_svn_handle_commands2 but @a error_on_disconnect
 611  * is always @c FALSE.
 612  *
 613  * @deprecated Provided for backward compatibility with the 1.5 API.
 614  */
 615 SVN_DEPRECATED
 616 svn_error_t *
 617 svn_ra_svn_handle_commands(svn_ra_svn_conn_t *conn,
 618                            apr_pool_t *pool,
 619                            const svn_ra_svn_cmd_entry_t *commands,
 620                            void *baton);
 621
 622 /** Write a command over the network, using the same format string notation
 623  * as svn_ra_svn_write_tuple().
 624  *
 625  * @deprecated Provided for backward compatibility with the 1.7 API.
 626  *             RA_SVN low-level functions are no longer considered public.
 627  */
 628 SVN_DEPRECATED
 629 svn_error_t *
 630 svn_ra_svn_write_cmd(svn_ra_svn_conn_t *conn,
 631                      apr_pool_t *pool,
 632                      const char *cmdname,
 633                      const char *fmt, ...);
 634
 635 /** Write a successful command response over the network, using the
 636  * same format string notation as svn_ra_svn_write_tuple().  Do not use
 637  * partial tuples with this function; if you need to use partial
 638  * tuples, just write out the "success" and argument tuple by hand.
 639  *
 640  * @deprecated Provided for backward compatibility with the 1.7 API.
 641  *             RA_SVN low-level functions are no longer considered public.
 642  */
 643 SVN_DEPRECATED
 644 svn_error_t *
 645 svn_ra_svn_write_cmd_response(svn_ra_svn_conn_t *conn,
 646                               apr_pool_t *pool,
 647                               const char *fmt, ...);
 648
 649 /** Write an unsuccessful command response over the network.
 650  *
 651  * @deprecated Provided for backward compatibility with the 1.7 API.
 652  *             RA_SVN low-level functions are no longer considered public.
 653  */
 654 SVN_DEPRECATED
 655 svn_error_t *
 656 svn_ra_svn_write_cmd_failure(svn_ra_svn_conn_t *conn,
 657                              apr_pool_t *pool,
 658                              svn_error_t *err);
 659
 660 /**
 661  * @}
 662  */
 663
 664 #ifdef __cplusplus
 665 }
 666 #endif /* __cplusplus */
 667
 668 #endif  /* SVN_RA_SVN_H */