GME  13
Public Attributes
svn_lock_t Struct Reference

#include <svn_types.h>

List of all members.

Public Attributes

const char * path
const char * token
const char * owner
const char * comment
svn_boolean_t is_dav_comment
apr_time_t creation_date
apr_time_t expiration_date

Detailed Description

A lock object, for client & server to share.

A lock represents the exclusive right to add, delete, or modify a path. A lock is created in a repository, wholly controlled by the repository. A "lock-token" is the lock's UUID, and can be used to learn more about a lock's fields, and or/make use of the lock. Because a lock is immutable, a client is free to not only cache the lock-token, but the lock's fields too, for convenience.

Note that the 'is_dav_comment' field is wholly ignored by every library except for mod_dav_svn. The field isn't even marshalled over the network to the client. Assuming lock structures are created with apr_pcalloc(), a default value of 0 is universally safe.

Note:
in the current implementation, only files are lockable.
Since:
New in 1.2.

Definition at line 1111 of file svn_types.h.


Member Data Documentation

const char* svn_lock_t::comment

(optional) description of lock

Definition at line 1116 of file svn_types.h.

when lock was made

Definition at line 1118 of file svn_types.h.

(optional) when lock will expire; If value is 0, lock will never expire.

Definition at line 1119 of file svn_types.h.

was comment made by generic DAV client?

Definition at line 1117 of file svn_types.h.

const char* svn_lock_t::owner

the username which owns the lock

Definition at line 1115 of file svn_types.h.

const char* svn_lock_t::path

the path this lock applies to

Definition at line 1113 of file svn_types.h.

const char* svn_lock_t::token

unique URI representing lock

Definition at line 1114 of file svn_types.h.


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