IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 4661


Ignore:
Timestamp:
Jul 28, 2005, 4:40:24 PM (21 years ago)
Author:
jhoblitt
Message:

more doxygen

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/Nebulous/nebclient/src/nebclient.h

    r4660 r4661  
    44 * Copyright (C) 2005  Joshua Hoblitt
    55 *
    6  * $Id: nebclient.h,v 1.27 2005-07-29 02:31:56 jhoblitt Exp $
     6 * $Id: nebclient.h,v 1.28 2005-07-29 02:40:24 jhoblitt Exp $
    77 */
    88
     
    2020
    2121typedef enum { NEB_READ, NEB_WRITE } nebRW;
     22
     23/** Represent a "connection" to a Nebulous server
     24 */
    2225
    2326typedef struct {
     
    2831} nebServer;
    2932
     33/** The properties of a storage object
     34 */
     35
    3036typedef struct {
    31     char            so_id[256];
    32     char            ext_id[256];
    33     char            class_id[256];
    34     char            comment[256];
    35     char            read_lock[256];
    36     char            write_lock[256];
    37     char            epoch[256];
    38     char            mtime[256];
     37    char            so_id[256];         ///< storage object ID
     38    char            ext_id[256];        ///< storage object key (name)
     39    char            class_id[256];      ///< storage object class
     40    char            comment[256];       ///< storage object comment
     41    char            read_lock[256];     ///< read lock value
     42    char            write_lock[256];    ///< write lock value
     43    char            epoch[256];         ///< creation time stamp
     44    char            mtime[256];         ///< modification time stamp
    3945} nebObjectStat;
    4046
     47/** The storage location of a storage object's instances
     48 */
     49
    4150typedef struct {
    42     unsigned int    n;
    43     char            **URI;
     51    unsigned int    n;                  ///< number of instances
     52    char            **URI;              ///< URLs of instances
    4453} nebObjectInstances;
    4554
     
    7079int nebCreate(
    7180    nebServer *server,                  ///< nebServer object
    72     const char *key,                    ///< storage object ID
     81    const char *key,                    ///< storage object key (name)
    7382    unsigned int class,                 ///< storage object storage class
    7483    const char *volume,                 ///< preferred storage location of initial instance
     
    8493bool nebReplicate(
    8594    nebServer *server,                  ///< nebServer object
    86     const char *key,                    ///< storage object ID
     95    const char *key,                    ///< storage object key (name)
    8796    const char *volume,                 ///< preferred storage location of new instance
    8897    char **URI                          ///< URL of new instance, can be NULL
     
    98107bool nebCull(
    99108    nebServer *server,                  ///< nebServer object
    100     const char *key                     ///< storage object ID
     109    const char *key                     ///< storage object key (name)
    101110);
    102111
     
    110119bool nebLock(
    111120    nebServer *server,                  ///< nebServer object
    112     const char *key,                    ///< storage object ID
     121    const char *key,                    ///< storage object key (name)
    113122    nebRW flag                          ///< read only or write lock
    114123);
     
    120129bool nebUnlock(
    121130    nebServer *server,                  ///< nebServer object
    122     const char *key,                    ///< storage object ID
     131    const char *key,                    ///< storage object key (name)
    123132    nebRW flag                          ///< read only or write lock
    124133);
     
    131140nebObjectInstances *nebFindInstances(
    132141    nebServer *server,                  ///< nebServer object
    133     const char *key,                    ///< storage object ID
     142    const char *key,                    ///< storage object key (name)
    134143    const char *volume                  ///< restrict search to this storage volume (non-working)
    135144);
     
    149158char *nebFind(
    150159    nebServer *server,                  ///< nebServer object
    151     const char *key                     ///< storage object ID
     160    const char *key                     ///< storage object key (name)
    152161);
    153162
     
    159168int nebOpen(
    160169    nebServer *server,                  ///< nebServer object
    161     const char *key,                    ///< storage object ID
     170    const char *key,                    ///< storage object key (name)
    162171    nebRW flag                          ///< read only or write lock
    163172);
     
    170179bool nebDelete(
    171180    nebServer *server,                  ///< nebServer object
    172     const char *key                     ///< storage object ID
     181    const char *key                     ///< storage object key (name)
    173182);
    174183
     
    182191bool nebCopy(
    183192    nebServer *server,                  ///< nebServer object
    184     const char *key,                    ///< storage object ID
    185     const char *newKey                  ///< new storage object ID
     193    const char *key,                    ///< storage object key (name)
     194    const char *newKey                  ///< new storage object key (name)
    186195);
    187196
     
    193202bool nebMove(
    194203    nebServer *server,                  ///< nebServer object
    195     const char *key,                    ///< storage object ID
    196     const char *newKey                  ///< new storage object ID
     204    const char *key,                    ///< storage object key (name)
     205    const char *newKey                  ///< new storage object key (name)
    197206);
    198207
     
    217226nebObjectStat *nebStat(
    218227    nebServer *server,                  ///< nebServer object
    219     const char *key                     /// storage object ID
     228    const char *key                     /// storage object key (name)
    220229);
    221230
Note: See TracChangeset for help on using the changeset viewer.