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

Transfer context management


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)
 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.

void glite_transfer_TransferJobSummary_free (glite_transfer_ctx *ctx, glite_transfer_TransferJobSummary *summary)
 Dispose a TransferJobSummary object.

glite_transfer_TransferJobSummaryglite_transfer_TransferJobSummary_clone (glite_transfer_ctx *ctx, const glite_transfer_TransferJobSummary *orig)
 Clone an existing TransferJobSummary object.

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)
 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.

void glite_transfer_Channel_free (glite_transfer_ctx *ctx, glite_transfer_Channel *channel)
 Dispose a Channel object.

glite_transfer_Channelglite_transfer_Channel_clone (glite_transfer_ctx *ctx, const glite_transfer_Channel *orig)
 Clone an existing Channel object.

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.


Function Documentation

void glite_transfer_add_sites glite_transfer_ctx ctx,
const char *  s,
const char *  d
 

Add sites to a transfer context.

Parameters:
ctx The context to be used.
s Source site.
d Destination site.

glite_transfer_Channel* glite_transfer_Channel_clone glite_transfer_ctx ctx,
const glite_transfer_Channel orig
 

Clone an existing Channel object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
orig The original object to be cloned.
Returns:
The replica of the object.

void glite_transfer_Channel_free glite_transfer_ctx ctx,
glite_transfer_Channel channel
 

Dispose a Channel object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
channel The object to be disposed.

glite_transfer_Channel* glite_transfer_Channel_new glite_transfer_ctx ctx,
const char *  name,
const char *  domainA,
const char *  domainB
 

Create a new Channel object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
name The name of the channel, used for reference.
domainA The domain of the source SE.
domainB The domain of the destination SE.
Returns:
The new object.

int glite_transfer_Channel_setContact glite_transfer_ctx ctx,
glite_transfer_Channel channel,
const char *  contact
 

Set the contact information on a channel.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
channel The object to be modified.
contact The new value of the contact field to be set.
Returns:
0 when successful and -1 in case of an error.

int glite_transfer_Channel_setState glite_transfer_ctx ctx,
glite_transfer_Channel channel,
glite_channel_state  state
 

Set the state of a channel.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
channel The object to be modified.
state The new channel state to be set.
Returns:
0 when successful and -1 in case of an error.

glite_transfer_FileTransferStatus* glite_transfer_FileTransferStatus_clone glite_transfer_ctx ctx,
const glite_transfer_FileTransferStatus status
 

Makes a copy of an file transfer status entry.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
status The status entry to be duplicated.
Returns:
The replica of the object.

void glite_transfer_FileTransferStatus_free glite_transfer_ctx ctx,
glite_transfer_FileTransferStatus status
 

Destroys a file transfer status entry.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
status The status object to be disposed.

void glite_transfer_FileTransferStatus_freeArray glite_transfer_ctx ctx,
int  nitems,
glite_transfer_FileTransferStatus status[]
 

Destroys a list of file transfer status entries.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
nitems Number of items in the array.
status Array of status objects to be disposed.

glite_transfer_FileTransferStatus* glite_transfer_FileTransferStatus_new glite_transfer_ctx ctx,
const char *  source,
const char *  dest,
glite_transfer_state  state
 

Allocates a file transfer status entry.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
source The source domain of the transfer.
dest The destinatioin domain of the transfer.
state The starting state value.
Returns:
The allocated FileTransferStatus object.

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.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
status The status object to be modified.
name The new LogicalName to be set.
Returns:
0 when successful and -1 in case of an error.

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.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
status The status object to be modified.
reason The new Reason to be set.
Returns:
0 when successful and -1 in case of an error.

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.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
status The status object to be modified.
reasonClass The new ReasonClass to be set.
Returns:
0 when successful and -1 in case of an error.

void glite_transfer_free glite_transfer_ctx ctx  ) 
 

Destroys a transfer context.

Parameters:
ctx The context to be disposed.

glite_transfer_errclass glite_transfer_get_errclass glite_transfer_ctx ctx  ) 
 

Determines the class of the last error.

Parameters:
ctx The transfer context.
Returns:
The proper errorclass value.

const char* glite_transfer_get_error glite_transfer_ctx ctx  ) 
 

Returns the error message for the last failed operation.

The returned pointer is valid only till the next call to any of the library's functions with the same context pointer.

Parameters:
ctx The transfer context.
Returns:
The error message string.

glite_transfer_JobStatus* glite_transfer_JobStatus_clone glite_transfer_ctx ctx,
const glite_transfer_JobStatus orig
 

Create a copy of a JobStatus object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
orig The original object we want to replicate.
Returns:
A replica of the object.

void glite_transfer_JobStatus_free glite_transfer_ctx ctx,
glite_transfer_JobStatus status
 

Dispose a JobStatus object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
status The status object to be modified.

void glite_transfer_JobStatus_freeArray glite_transfer_ctx ctx,
int  nitems,
glite_transfer_JobStatus status[]
 

Dispose multiple JobStatus objects.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
nitems Number of items in the array.
status Array of the JobStatus objects to be disposed.

glite_transfer_JobStatus* glite_transfer_JobStatus_new glite_transfer_ctx ctx,
const char *  jobId,
glite_transfer_state  jobStatus
 

Create a new JobStatus object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
jobId The ID of the job used for later reference on it.
jobStatus The status to be set.
Returns:
The new object.

glite_transfer_ctx* glite_transfer_new const char *  endpoint  ) 
 

Allocates a new transfer context.

Parameters:
endpoint The service endpoint.
Returns:
The context or NULL if memory allocation has failed.

int glite_transfer_PlacementJob_add glite_transfer_ctx ctx,
glite_transfer_PlacementJob job,
const char *  logicalFile
 

Adds a new LFN to the PlacementJob.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
job The object to be modified.
logicalFile The LFN to be added to the PlacementJob.
Returns:
0 when successful and -1 in case of an error.

glite_transfer_PlacementJob* glite_transfer_PlacementJob_clone glite_transfer_ctx ctx,
const glite_transfer_PlacementJob orig
 

Clone an existing PlacementJob object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
orig The original object to be cloned.
Returns:
The replica of the object.

void glite_transfer_PlacementJob_free glite_transfer_ctx ctx,
glite_transfer_PlacementJob job
 

Dispose a PlacementJob object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
job The object to be disposed.

glite_transfer_PlacementJob* glite_transfer_PlacementJob_new glite_transfer_ctx ctx,
const char *  sourceSE,
const char *  destSE
 

Create a new PlacementJob object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
sourceSE The physical source SE.
destSE The physical destination SE.
Returns:
The new 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.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
job The object to be modified.
params The transfer parameters to be set.
Returns:
0 when successful and -1 in case of an error.

glite_transfer_Roles* glite_transfer_Roles_new glite_transfer_ctx ctx  ) 
 

Create a nem Roles object.

void glite_transfer_set_error glite_transfer_ctx ctx,
glite_transfer_errclass  errclass,
const char *  fmt,
... 
 

Set the error message in the context.

Parameters:
ctx The transfer context.
errclass The type of error.
fmt The format string.
... Variables in the above string.

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.

Parameters:
ctx The transfer context.
errclass The type of error.
fmt The format string.
ap A variable length argument list.

glite_transfer_state glite_transfer_state_parse glite_transfer_ctx ctx,
const char *  state
 

Parse a string to a glite_transfer_state value.

Parameters:
ctx The transfer context used for error reporting.
state The state string to be parsed.
Returns:
The glite_transfer_state, specially GLITE_TRANSFER_UNKNOWN if the state variable is missing or invalid.

const char* glite_transfer_state_str glite_transfer_state  state  ) 
 

Convert a glite_transfer_state value to a human readable string.

Parameters:
state The state to be converted to string.
Returns:
The string

int glite_transfer_TransferJob_add glite_transfer_ctx ctx,
glite_transfer_TransferJob job,
const char *  src,
const char *  dst
 

Add a new source-destination pair to a TransferJob.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
job The object to be modified.
src The new source SURL to add.
dst The new destination SURL to add.
Returns:
0 when successful and -1 in case of an error.

glite_transfer_TransferJob* glite_transfer_TransferJob_clone glite_transfer_ctx ctx,
const glite_transfer_TransferJob orig
 

Clone an existing TransferJob object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
orig The original object to be cloned.
Returns:
The replica of the object.

void glite_transfer_TransferJob_free glite_transfer_ctx ctx,
glite_transfer_TransferJob job
 

Dispose a TransferJob object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
job The object to be disposed.

glite_transfer_TransferJob* glite_transfer_TransferJob_new glite_transfer_ctx ctx  ) 
 

Create a new TransferJob object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
Returns:
The new 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.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
job The object to be modified.
params The parameters to be set.
Returns:
0 when successful and -1 in case of an error.

glite_transfer_TransferJobElement* glite_transfer_TransferJobElement_clone glite_transfer_ctx ctx,
const glite_transfer_TransferJobElement orig
 

Clone an existing TransferJobElement object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
orig The original object to be cloned.
Returns:
The replica of the object.

void glite_transfer_TransferJobElement_free glite_transfer_ctx ctx,
glite_transfer_TransferJobElement elem
 

Dispose a TransferJobElement object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
elem The object to be disposed.

void glite_transfer_TransferJobElement_freeArray glite_transfer_ctx ctx,
int  nitems,
glite_transfer_TransferJobElement elems[]
 

Dispose an array of TransferJobElement objects.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
nitems Number of items in the array.
elems Array of objects to be disposed.

glite_transfer_TransferJobElement* glite_transfer_TransferJobElement_new glite_transfer_ctx ctx,
const char *  src,
const char *  dst
 

Create a new TransferJobElement object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
src The source SURL of the transfer.
dst The destination SURL of the transfer.
Returns:
The new object.

glite_transfer_TransferJobSummary* glite_transfer_TransferJobSummary_clone glite_transfer_ctx ctx,
const glite_transfer_TransferJobSummary orig
 

Clone an existing TransferJobSummary object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
orig The original object to be cloned.
Returns:
The replica of the object.

void glite_transfer_TransferJobSummary_free glite_transfer_ctx ctx,
glite_transfer_TransferJobSummary summary
 

Dispose a TransferJobSummary object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
summary The object to be disposed.

glite_transfer_TransferJobSummary* glite_transfer_TransferJobSummary_new glite_transfer_ctx ctx  ) 
 

Create a new TransferJobSummary object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
Returns:
The new 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.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
params The object to be modified.
key The key to be added.
value The value assigned to the key.
Returns:
0 when successful and -1 in case of an error.

glite_transfer_TransferParams* glite_transfer_TransferParams_clone glite_transfer_ctx ctx,
const glite_transfer_TransferParams orig
 

Clone an existing TransferParams object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
orig The original object to be cloned.
Returns:
The replica of the object.

void glite_transfer_TransferParams_free glite_transfer_ctx ctx,
glite_transfer_TransferParams params
 

Dispose a TransferParams object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
params The object to be disposed.

glite_transfer_TransferParams* glite_transfer_TransferParams_new glite_transfer_ctx ctx  ) 
 

Create a new TransferParams object.

Parameters:
ctx The transfer context, may be NULL if no error reporting is required.
Returns:
The new object.
The GLite Project. All rights reserved.