EGEE
Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals

transfer-simple.h File Reference

#include <stdarg.h>
#include <stdint.h>
#include <time.h>

Go to the source code of this file.

Data Structures

struct  _glite_transfer_FileTransferStatus
 Object to describe the status of a file transfer. More...
struct  _glite_transfer_JobStatus
 Object to describe a job. More...
struct  _glite_transfer_PlacementJob
 Describes the placement job description. More...
struct  _glite_transfer_TransferJob
 Describes the transfer job description with checksums. More...
struct  _glite_transfer_TransferJobElement
 An object to describe a source-destination pair with checksum. More...
struct  _glite_transfer_VOShareElement
 An object to describe a VO-share pair. More...
struct  _glite_transfer_VOLimitElement
 An object to describe a VO-limit pair. More...
struct  _glite_transfer_TransferJobSummary
 Describes the overall status of the job: the job state and some extra statistics. More...
struct  _glite_transfer_TransferJobSummary2
 Describes the overall extended status of the job: the job state and some extra statistics. More...
struct  _glite_transfer_TransferParams
 Parameters for the transfer. More...
struct  _glite_transfer_ChannelAuditEntry
 The transfer channel audit object. More...
struct  _glite_transfer_Channel
 The transfer channel object. More...
struct  _glite_transfer_Channel2
 The transfer channel2 object. More...
struct  _glite_transfer_Channel3
 The transfer channel3 object. More...
struct  _glite_transfer_StringPair
 A string pair object. More...
struct  _glite_transfer_Roles
 The transfer roles object. More...
struct  _glite_transfer_TransferSnapshot
 The transfer snapshot object. More...
struct  _glite_transfer_TransferSummary
 The transfer summary object. More...
struct  _glite_transfer_TransferActivityPeriod
 The transfer activity period object. More...
struct  _glite_transfer_TransferActivity
 The transfer activity object. More...
struct  _glite_transfer_TransferAgent
 The transfer agent object. More...

Defines

#define GLITE_FTS_IFC_VERSION   "GLITE_FTS_IFC_VERSION"
 Copyright (c) Members of the EGEE Collaboration.

Typedefs

typedef _glite_transfer_ctx glite_transfer_ctx
typedef _glite_transfer_Channel glite_transfer_Channel
typedef _glite_transfer_Channel2 glite_transfer_Channel2
typedef _glite_transfer_Channel3 glite_transfer_Channel3
typedef _glite_transfer_ChannelAuditEntry glite_transfer_ChannelAuditEntry
typedef _glite_transfer_FileTransferStatus glite_transfer_FileTransferStatus
typedef _glite_transfer_JobStatus glite_transfer_JobStatus
typedef _glite_transfer_PlacementJob glite_transfer_PlacementJob
typedef _glite_transfer_TransferJob glite_transfer_TransferJob
typedef _glite_transfer_TransferJobElement glite_transfer_TransferJobElement
typedef _glite_transfer_TransferJobSummary glite_transfer_TransferJobSummary
typedef _glite_transfer_TransferJobSummary2 glite_transfer_TransferJobSummary2
typedef _glite_transfer_TransferParams glite_transfer_TransferParams
typedef _glite_transfer_StringPair glite_transfer_StringPair
typedef _glite_transfer_Roles glite_transfer_Roles
typedef _glite_transfer_VOShareElement glite_transfer_VOShareElement
typedef _glite_transfer_VOLimitElement glite_transfer_VOLimitElement
typedef _glite_transfer_TransferSnapshot glite_transfer_TransferSnapshot
typedef _glite_transfer_TransferSummary glite_transfer_TransferSummary
typedef _glite_transfer_TransferActivity glite_transfer_TransferActivity
typedef _glite_transfer_TransferActivityPeriod glite_transfer_TransferActivityPeriod
typedef _glite_transfer_TransferAgent glite_transfer_TransferAgent

Enumerations

enum  glite_transfer_errclass {
  GLITE_TRANSFER_EXCEPTION_EXISTS = -9, GLITE_TRANSFER_EXCEPTION_AUTHORIZATION = -8, GLITE_TRANSFER_EXCEPTION_CANNOTCANCEL = -7, GLITE_TRANSFER_EXCEPTION_FILENOTFOUND = -6,
  GLITE_TRANSFER_EXCEPTION_INTERNAL = -5, GLITE_TRANSFER_EXCEPTION_INVALIDARGUMENT = -4, GLITE_TRANSFER_EXCEPTION_NOTEXISTS = -3, GLITE_TRANSFER_EXCEPTION_SERVICEBUSY = -2,
  GLITE_TRANSFER_EXCEPTION_TRANSFER = -1, GLITE_TRANSFER_ERROR_NONE, GLITE_TRANSFER_ERROR_UNKNOWN, GLITE_TRANSFER_ERROR_INVALIDARGUMENT,
  GLITE_TRANSFER_ERROR_OUTOFMEMORY, GLITE_TRANSFER_ERROR_SERVICEDISCOVERY, GLITE_TRANSFER_ERROR_SOAP
}
 Error categories. More...
enum  glite_transfer_state {
  GLITE_TRANSFER_FAILED = -6, GLITE_TRANSFER_CATALOGFAILED = -5, GLITE_TRANSFER_FINISHED_DIRTY = -4, GLITE_TRANSFER_UNKNOWN = -3,
  GLITE_TRANSFER_CANCELED = -2, GLITE_TRANSFER_TRANSFERFAILED = -1, GLITE_TRANSFER_FINISHED = 0, GLITE_TRANSFER_SUBMITTED,
  GLITE_TRANSFER_PENDING, GLITE_TRANSFER_ACTIVE, GLITE_TRANSFER_CANCELING, GLITE_TRANSFER_WAITING,
  GLITE_TRANSFER_HOLD, GLITE_TRANSFER_DONE, GLITE_TRANSFER_READY, GLITE_TRANSFER_DONEWITHERRORS,
  GLITE_TRANSFER_FINISHING, GLITE_TRANSFER_AWAITING_PRESTAGE, GLITE_TRANSFER_PRESTAGING, GLITE_TRANSFER_WAITING_PRESTAGE,
  GLITE_TRANSFER_WAITING_CATALOG_RESOLUTION, GLITE_TRANSFER_WAITING_CATALOG_REGISTRATION
}
 Job states. More...
enum  glite_channel_state {
  GLITE_CHANNEL_UNKNOWN = -1, GLITE_CHANNEL_ACTIVE, GLITE_CHANNEL_INACTIVE, GLITE_CHANNEL_DRAIN,
  GLITE_CHANNEL_STOPPED, GLITE_CHANNEL_HALTED, GLITE_CHANNEL_ARCHIVED, GLITE_CHANNEL_DELETED
}
 Channel states. More...

Functions

glite_transfer_ctxglite_transfer_new (const char *endpoint)
 Allocates a new transfer context.
void glite_transfer_free (glite_transfer_ctx *ctx)
 Destroys a transfer context.
void glite_transfer_add_sites (glite_transfer_ctx *ctx, const char *s, const char *d)
 Add sites to a transfer context.
const char * glite_transfer_get_error (glite_transfer_ctx *ctx)
 Returns the error message for the last failed operation.
glite_transfer_errclass glite_transfer_get_errclass (glite_transfer_ctx *ctx)
 Determines the class of the last error.
void glite_transfer_set_error (glite_transfer_ctx *ctx, glite_transfer_errclass errclass, const char *fmt,...)
 Set the error message in the context.
void glite_transfer_set_verror (glite_transfer_ctx *ctx, glite_transfer_errclass errclass, const char *fmt, va_list ap)
 Set the error message in the context.
glite_transfer_state glite_transfer_state_parse (glite_transfer_ctx *ctx, const char *state)
 Parse a string to a glite_transfer_state value.
const char * glite_transfer_state_str (glite_transfer_state state)
 Convert a glite_transfer_state value to a human readable string.
glite_transfer_FileTransferStatusglite_transfer_FileTransferStatus_new (glite_transfer_ctx *ctx, const char *source, const char *dest, glite_transfer_state state)
 Allocates a file transfer status entry.
void glite_transfer_FileTransferStatus_free (glite_transfer_ctx *ctx, glite_transfer_FileTransferStatus *status)
 Destroys a file transfer status entry.
void glite_transfer_FileTransferStatus_freeArray (glite_transfer_ctx *ctx, int nitems, glite_transfer_FileTransferStatus *status[])
 Destroys a list of file transfer status entries.
glite_transfer_FileTransferStatusglite_transfer_FileTransferStatus_clone (glite_transfer_ctx *ctx, const glite_transfer_FileTransferStatus *status)
 Makes a copy of an file transfer status entry.
int glite_transfer_FileTransferStatus_setLogicalName (glite_transfer_ctx *ctx, glite_transfer_FileTransferStatus *status, const char *name)
 Change the value of the LogicalName field of a FileTransferStatus object.
int glite_transfer_FileTransferStatus_setReason (glite_transfer_ctx *ctx, glite_transfer_FileTransferStatus *status, const char *reason)
 Change the value of the Reason field of a FileTransferStatus object.
int glite_transfer_FileTransferStatus_setReasonClass (glite_transfer_ctx *ctx, glite_transfer_FileTransferStatus *status, const char *reasonClass)
 Change the value of the ReasonClass field of a FileTransferStatus object.
glite_transfer_JobStatusglite_transfer_JobStatus_new (glite_transfer_ctx *ctx, const char *jobId, glite_transfer_state jobStatus)
 Create a new JobStatus object.
void glite_transfer_JobStatus_free (glite_transfer_ctx *ctx, glite_transfer_JobStatus *status)
 Dispose a JobStatus object.
void glite_transfer_JobStatus_freeArray (glite_transfer_ctx *ctx, int nitems, glite_transfer_JobStatus *status[])
 Dispose multiple JobStatus objects.
glite_transfer_JobStatusglite_transfer_JobStatus_clone (glite_transfer_ctx *ctx, const glite_transfer_JobStatus *orig)
 Create a copy of a JobStatus object.
glite_transfer_PlacementJobglite_transfer_PlacementJob_new (glite_transfer_ctx *ctx, const char *sourceSE, const char *destSE)
 Create a new PlacementJob object.
void glite_transfer_PlacementJob_free (glite_transfer_ctx *ctx, glite_transfer_PlacementJob *job)
 Dispose a PlacementJob object.
glite_transfer_PlacementJobglite_transfer_PlacementJob_clone (glite_transfer_ctx *ctx, const glite_transfer_PlacementJob *orig)
 Clone an existing PlacementJob object.
int glite_transfer_PlacementJob_setParams (glite_transfer_ctx *ctx, glite_transfer_PlacementJob *job, const glite_transfer_TransferParams *params)
 Sets the parameters of a PlacementJob.
int glite_transfer_PlacementJob_add (glite_transfer_ctx *ctx, glite_transfer_PlacementJob *job, const char *logicalFile)
 Adds a new LFN to the PlacementJob.
glite_transfer_TransferJobElementglite_transfer_TransferJobElement_new (glite_transfer_ctx *ctx, const char *src, const char *dst, const char *cksm)
 Create a new TransferJobElement object.
void glite_transfer_TransferJobElement_free (glite_transfer_ctx *ctx, glite_transfer_TransferJobElement *elem)
 Dispose a TransferJobElement object.
void glite_transfer_TransferJobElement_freeArray (glite_transfer_ctx *ctx, int nitems, glite_transfer_TransferJobElement *elems[])
 Dispose an array of TransferJobElement objects.
glite_transfer_TransferJobElementglite_transfer_TransferJobElement_clone (glite_transfer_ctx *ctx, const glite_transfer_TransferJobElement *orig)
 Clone an existing TransferJobElement object.
glite_transfer_TransferJobSummaryglite_transfer_TransferJobSummary_new (glite_transfer_ctx *ctx)
 Create a new TransferJobSummary object.
glite_transfer_TransferJobSummary2glite_transfer_TransferJobSummary2_new (glite_transfer_ctx *ctx)
void glite_transfer_TransferJobSummary_free (glite_transfer_ctx *ctx, glite_transfer_TransferJobSummary *summary)
 Dispose a TransferJobSummary object.
void glite_transfer_TransferJobSummary2_free (glite_transfer_ctx *ctx, glite_transfer_TransferJobSummary2 *summary)
glite_transfer_TransferJobSummaryglite_transfer_TransferJobSummary_clone (glite_transfer_ctx *ctx, const glite_transfer_TransferJobSummary *orig)
 Clone an existing TransferJobSummary object.
glite_transfer_TransferJobSummary2glite_transfer_TransferJobSummary2_clone (glite_transfer_ctx *ctx, const glite_transfer_TransferJobSummary2 *orig)
glite_transfer_TransferJobglite_transfer_TransferJob_new (glite_transfer_ctx *ctx)
 Create a new TransferJob object.
void glite_transfer_TransferJob_free (glite_transfer_ctx *ctx, glite_transfer_TransferJob *job)
 Dispose a TransferJob object.
glite_transfer_TransferJobglite_transfer_TransferJob_clone (glite_transfer_ctx *ctx, const glite_transfer_TransferJob *orig)
 Clone an existing TransferJob object.
int glite_transfer_TransferJob_setParams (glite_transfer_ctx *ctx, glite_transfer_TransferJob *job, const glite_transfer_TransferParams *params)
 Set the parameters of a TransferJob.
int glite_transfer_TransferJob_add (glite_transfer_ctx *ctx, glite_transfer_TransferJob *job, const char *src, const char *dst, const char *cksm)
 Add a new source-destination pair to a TransferJob.
glite_transfer_TransferParamsglite_transfer_TransferParams_new (glite_transfer_ctx *ctx)
 Create a new TransferParams object.
void glite_transfer_TransferParams_free (glite_transfer_ctx *ctx, glite_transfer_TransferParams *params)
 Dispose a TransferParams object.
glite_transfer_TransferParamsglite_transfer_TransferParams_clone (glite_transfer_ctx *ctx, const glite_transfer_TransferParams *orig)
 Clone an existing TransferParams object.
int glite_transfer_TransferParams_add (glite_transfer_ctx *ctx, glite_transfer_TransferParams *params, const char *key, const char *value)
 Add a new key-value pair to a TransferParams object.
glite_transfer_Channelglite_transfer_Channel_new (glite_transfer_ctx *ctx, const char *name, const char *domainA, const char *domainB)
 Create a new Channel object.
glite_transfer_Channel2glite_transfer_Channel2_new (glite_transfer_ctx *ctx, const char *name, const char *domainA, const char *domainB)
glite_transfer_Channel3glite_transfer_Channel3_new (glite_transfer_ctx *ctx, const char *name, const char *domainA, const char *domainB)
void glite_transfer_Channel_free (glite_transfer_ctx *ctx, glite_transfer_Channel *channel)
 Dispose a Channel object.
void glite_transfer_Channel2_free (glite_transfer_ctx *ctx, glite_transfer_Channel2 *channel2)
void glite_transfer_Channel3_free (glite_transfer_ctx *ctx, glite_transfer_Channel3 *channel3)
glite_transfer_Channelglite_transfer_Channel_clone (glite_transfer_ctx *ctx, const glite_transfer_Channel *orig)
 Clone an existing Channel object.
glite_transfer_Channel2glite_transfer_Channel2_clone (glite_transfer_ctx *ctx, const glite_transfer_Channel2 *orig)
int glite_transfer_Channel_setContact (glite_transfer_ctx *ctx, glite_transfer_Channel *channel, const char *contact)
 Set the contact information on a channel.
int glite_transfer_Channel_setState (glite_transfer_ctx *ctx, glite_transfer_Channel *channel, glite_channel_state state)
 Set the state of a channel.
glite_transfer_Rolesglite_transfer_Roles_new (glite_transfer_ctx *ctx)
 Create a nem Roles object.
void glite_transfer_ChannelAuditEntry_freeArray (glite_transfer_ctx *ctx, int nitems, glite_transfer_ChannelAuditEntry *ca[])
glite_transfer_ChannelAuditEntryglite_transfer_ChannelAuditEntry_new (glite_transfer_ctx *ctx, const char *name)
void glite_transfer_ChannelAuditEntry_free (glite_transfer_ctx *ctx, glite_transfer_ChannelAuditEntry *ca)
glite_transfer_ChannelAuditEntryglite_transfer_ChannelAuditEntry_clone (glite_transfer_ctx *ctx, const glite_transfer_ChannelAuditEntry *orig)


Define Documentation

#define GLITE_FTS_IFC_VERSION   "GLITE_FTS_IFC_VERSION"
 

Copyright (c) Members of the EGEE Collaboration.

2004-2008. See http://www.eu-egee.org/partners/ for details on the copyright holders. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. GLite Data Management - Simple transfer API Authors: Gabor Gombas <Gabor.Gombas@cern.ch> Zoltan Farkas <Zoltan.Farkas@cern.ch> Paolo Tedesco <paolo.tedesco@cern.ch> Version info:

Id
transfer-simple.h,v 1.31 2009/07/02 15:28:18 szamsu Exp
Release:
Name

Definition at line 33 of file transfer-simple.h.


Typedef Documentation

typedef struct _glite_transfer_ctx glite_transfer_ctx
 

Definition at line 40 of file transfer-simple.h.

The GLite Project. All rights reserved.