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

org.glite.data.transfer.channel.ChannelManagement


Functions

int glite_channel_add (glite_transfer_ctx *ctx, const glite_transfer_Channel *channel)
 Add a new transfer channel to the database.

int glite_channel_drop (glite_transfer_ctx *ctx, const char *name)
 Drop a channel from the database.

glite_transfer_Channelglite_channel_getChannel (glite_transfer_ctx *ctx, const char *name)
 Get a channel object by its name.

char ** glite_channel_listChannels (glite_transfer_ctx *ctx, int *resultCnt)
 List all channels in the database.

int glite_channel_changeStateForHeldJob (glite_transfer_ctx *ctx, const char *jobId, glite_transfer_state state)
 Manual intervention command on channel.

int glite_channel_changeStateForHeldJobsOnChannel (glite_transfer_ctx *ctx, const char *name, glite_transfer_state state)
 Manual intervention command on channel.

int glite_channel_setBandwidth (glite_transfer_ctx *ctx, const char *name, int utilisation)
 Set the theoretical bandwidth of a channel.

int glite_channel_setContact (glite_transfer_ctx *ctx, const char *name, const char *contact)
 Set the contact information of a channel which can be queried in case of a problem.

int glite_channel_setNominalThroughput (glite_transfer_ctx *ctx, const char *name, int nominalThroughput)
 Set the maximal throughput value of a channel which should not be overrun.

int glite_channel_setNumberOfFiles (glite_transfer_ctx *ctx, const char *name, int numberOfFiles)
 Set the maximal number of files that can be transfered simultanously on a channel.

int glite_channel_setNumberOfStreams (glite_transfer_ctx *ctx, const char *name, int numberOfStreams)
 Set the maximal number of streams a file transfer can be split.

int glite_channel_setState (glite_transfer_ctx *ctx, const char *name, glite_channel_state state)
 Set the state of a channel.

int glite_channel_addManager (glite_transfer_ctx *ctx, const char *name, const char *principal)
 Add a manager to the channel.

int glite_channel_removeManager (glite_transfer_ctx *ctx, const char *name, const char *principal)
 Remove a manager from the channel.

char ** glite_channel_listManagers (glite_transfer_ctx *ctx, const char *name, int *resultCnt)
 List all managers of the channel.

int glite_channel_setVOShare (glite_transfer_ctx *ctx, const char *name, const char *VOname, int share)
 Sets the share of a VO on a given channel.


Function Documentation

int glite_channel_add glite_transfer_ctx ctx,
const glite_transfer_Channel channel
 

Add a new transfer channel to the database.

Parameters:
ctx The transfer context.
channel The existing channel object to be added.
Returns:
0 when successful and -1 in case of an error.

int glite_channel_addManager glite_transfer_ctx ctx,
const char *  name,
const char *  principal
 

Add a manager to the channel.

Parameters:
ctx The transfer context.
name The name of the channel
principal The name of the principal.
Returns:
0 when successful and -1 in case of an error.

int glite_channel_changeStateForHeldJob glite_transfer_ctx ctx,
const char *  jobId,
glite_transfer_state  state
 

Manual intervention command on channel.

It changes the file_state for all files belonging to the given job from Hold to the given file state. It will only work for files in the Hold state. The only permissible requested states are 'Pending', 'Failed' or 'Canceling'.

Parameters:
ctx The transfer context.
jobId The ID of the job.
state The new state.
Returns:
0 when successful and -1 in case of an error.

int glite_channel_changeStateForHeldJobsOnChannel glite_transfer_ctx ctx,
const char *  name,
glite_transfer_state  state
 

Manual intervention command on channel.

It changes the file_state for all files belonging to all jobs on the given channel which are in the Hold state to the given file state. It will only work for files in the Hold state. The only permissible requested states are 'Pending', 'Failed' or 'Canceling'.

Parameters:
ctx The transfer context.
name The name of the channel.
state The new state.
Returns:
0 when successful and -1 in case of an error.

int glite_channel_drop glite_transfer_ctx ctx,
const char *  name
 

Drop a channel from the database.

Parameters:
ctx The transfer context.
name The name of the channel to be dropped.
Returns:
0 when successful and -1 in case of an error.

glite_transfer_Channel* glite_channel_getChannel glite_transfer_ctx ctx,
const char *  name
 

Get a channel object by its name.

Parameters:
ctx The transfer context.
name The name of the channel.
Returns:
The transfer-channel object, or NULL if there was an error.

char** glite_channel_listChannels glite_transfer_ctx ctx,
int *  resultCnt
 

List all channels in the database.

Parameters:
ctx The transfer context.
resultCnt [OUT] The number of items in the return array.
Returns:
A list containing the names of the channels, or NULL if there was an error.

char** glite_channel_listManagers glite_transfer_ctx ctx,
const char *  name,
int *  resultCnt
 

List all managers of the channel.

Parameters:
ctx The transfer context.
name The name of the channel
resultCnt [OUT] The number of items in the return array.
Returns:
A list containing the managers of the channels, or NULL if there was an error.

int glite_channel_removeManager glite_transfer_ctx ctx,
const char *  name,
const char *  principal
 

Remove a manager from the channel.

Parameters:
ctx The transfer context.
name The name of the channel
principal The name of the principal.
Returns:
0 when successful and -1 in case of an error.

int glite_channel_setBandwidth glite_transfer_ctx ctx,
const char *  name,
int  utilisation
 

Set the theoretical bandwidth of a channel.

Parameters:
ctx The transfer context.
name The name of the channel.
utilisation The new bandwidth value.
Returns:
0 when successful and -1 in case of an error.

int glite_channel_setContact glite_transfer_ctx ctx,
const char *  name,
const char *  contact
 

Set the contact information of a channel which can be queried in case of a problem.

Parameters:
ctx The transfer context.
name The name of the channel.
contact The contact info string.
Returns:
0 when successful and -1 in case of an error.

int glite_channel_setNominalThroughput glite_transfer_ctx ctx,
const char *  name,
int  nominalThroughput
 

Set the maximal throughput value of a channel which should not be overrun.

Parameters:
ctx The transfer context.
name The name of the channel.
nominalThroughput The new throughput value.
Returns:
0 when successful and -1 in case of an error.

int glite_channel_setNumberOfFiles glite_transfer_ctx ctx,
const char *  name,
int  numberOfFiles
 

Set the maximal number of files that can be transfered simultanously on a channel.

Parameters:
ctx The transfer context.
name The name of the channel.
numberOfFiles The new value.
Returns:
0 when successful and -1 in case of an error.

int glite_channel_setNumberOfStreams glite_transfer_ctx ctx,
const char *  name,
int  numberOfStreams
 

Set the maximal number of streams a file transfer can be split.

Parameters:
ctx The transfer context.
name The name of the channel.
numberOfStreams The new value.
Returns:
0 when successful and -1 in case of an error.

int glite_channel_setState glite_transfer_ctx ctx,
const char *  name,
glite_channel_state  state
 

Set the state of a channel.

Parameters:
ctx The transfer context.
name The name of the channel
state The state to be set.
Returns:
0 when successful and -1 in case of an error.

int glite_channel_setVOShare glite_transfer_ctx ctx,
const char *  name,
const char *  VOname,
int  share
 

Sets the share of a VO on a given channel.

Parameters:
ctx The transfer context.
name The name of the channel
VOname The name of the VO
share The share value
Returns:
0 when successful and -1 in case of an error.
The GLite Project. All rights reserved.