chirp_types.h File Reference


Detailed Description

All of the structure and type definitions used by the Chirp API.

#include "int_sizes.h"
#include "chirp_protocol.h"
#include <sys/types.h>
#include <time.h>
#include <fcntl.h>

Go to the source code of this file.

Data Structures

struct  chirp_stat
 Describes the properties of a file, much like the Unix stat structure. More...
struct  chirp_statfs
 Describes the properties of a file system, much like the Unix statfs structure. More...
struct  chirp_dirent
 Describes a directory entry returned by chirp_reli_readdir. More...
struct  chirp_bulkio
 Describes a bulk I/O operation. More...
struct  chirp_audit
 Descibes the space consumed by a single user on a Chirp server. More...
struct  chirp_job_state
 Describes the current state of an active storage job on a Chirp server. More...

Typedefs

typedef void(*) chirp_dir_t (const char *path, void *arg)
 A callback function typedef used to display a directory or access control list.
typedef void(*) chirp_longdir_t (const char *path, struct chirp_stat *info, void *arg)
 A callback function typedef used to display a detailed directory.
typedef void(*) chirp_joblist_t (struct chirp_job_state *state, void *arg)
 A callback function typedef used to display a job state.
typedef void(*) chirp_loc_t (const char *location, void *arg)
 A callback function typedef used to display a file's location(s).

Enumerations

enum  chirp_bulkio_t {
  CHIRP_BULKIO_PREAD,
  CHIRP_BULKIO_PWRITE,
  CHIRP_BULKIO_SREAD,
  CHIRP_BULKIO_SWRITE,
  CHIRP_BULKIO_FSTAT,
  CHIRP_BULKIO_FSYNC
}
 Describes the type of a bulk I/O operation. More...
enum  chirp_job_state_t {
  CHIRP_JOB_STATE_BEGIN = 0,
  CHIRP_JOB_STATE_IDLE = 1,
  CHIRP_JOB_STATE_RUNNING = 2,
  CHIRP_JOB_STATE_SUSPENDED = 3,
  CHIRP_JOB_STATE_COMPLETE = 4,
  CHIRP_JOB_STATE_FAILED = 5,
  CHIRP_JOB_STATE_KILLED = 6
}
 Describes the progress of an active storage job through its lifetime. More...

Functions

const char * chirp_job_state_string (chirp_job_state_t state)
 Gives a readable string corresponding to a job state.


Typedef Documentation

typedef void(*) chirp_dir_t(const char *path, void *arg)

A callback function typedef used to display a directory or access control list.

A function matching this type is called by chirp_reli_getdir to display or otherwise act upon each line in a directory or access control list.

Parameters:
path The short name of the file, directory, or ACL to display.
arg A convenience pointer corresponding to the arg passed from chirp_reli_getdir.
See also:
chirp_reli_getdir, chirp_reli_getacl

typedef void(*) chirp_longdir_t(const char *path, struct chirp_stat *info, void *arg)

A callback function typedef used to display a detailed directory.

A function matching this type is called by chirp_reli_getlongdir to display or otherwise act upon each line in a directory listing.

Parameters:
path The short name of the file or directory to display.
info The details of the named file.
arg A convenience pointer corresponding to the arg passed from chirp_reli_getlongdir.
See also:
chirp_reli_getlongdir

typedef void(*) chirp_joblist_t(struct chirp_job_state *state, void *arg)

A callback function typedef used to display a job state.

A function matching this type is called by chirp_reli_job_list to display or otherwise act upon all active storage jobs in a server.

Parameters:
state The name and detailed state of one job.
arg A convenience pointer corresponding to the arg passed from chirp_reli_job_list
See also:
chirp_reli_job_list

typedef void(*) chirp_loc_t(const char *location, void *arg)

A callback function typedef used to display a file's location(s).

A function matching this type is called by chirp_reli_locate to display or otherwise act upon each location at which a given file is stored.

Parameters:
location The location of a file (usually hostname:local_path).
arg A convenience pointer corresponding to the arg passed from chirp_reli_locate.
See also:
chirp_reli_locate


Enumeration Type Documentation

enum chirp_bulkio_t

Describes the type of a bulk I/O operation.

Used by chirp_bulkio

Enumerator:
CHIRP_BULKIO_PREAD  Perform a chirp_reli_pread.
CHIRP_BULKIO_PWRITE  Perform a chirp_reli_pwrite.
CHIRP_BULKIO_SREAD  Perform a chirp_reli_sread.
CHIRP_BULKIO_SWRITE  Perform a chirp_reli_swrite.
CHIRP_BULKIO_FSTAT  Perform a chirp_reli_fstat.
CHIRP_BULKIO_FSYNC  Perform a chirp_reli_fsync.

enum chirp_job_state_t

Describes the progress of an active storage job through its lifetime.

See also:
chirp_job_state, chirp_reli_job_wait, chirp_reli_job_list
Enumerator:
CHIRP_JOB_STATE_BEGIN  The job has been created, but not yet committed.
CHIRP_JOB_STATE_IDLE  The job has been committed, and is free to run.
CHIRP_JOB_STATE_RUNNING  The job is currently running.
CHIRP_JOB_STATE_SUSPENDED  The job has been temporarily suspended.
CHIRP_JOB_STATE_COMPLETE  The job ran all the way to completion.
CHIRP_JOB_STATE_FAILED  The job could not be run at all.
CHIRP_JOB_STATE_KILLED  The job was forcibly killed by the owner or administrator.


Function Documentation

const char* chirp_job_state_string ( chirp_job_state_t  state  ) 

Gives a readable string corresponding to a job state.

Returns:
A constant string corresponding to the job state, e.g. "BEGIN".


Generated on Mon Apr 11 10:37:25 2011 for cctools by  doxygen 1.4.7