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_Channel *	glite_channel_getChannel (glite_transfer_ctx ctx, const char name)
	Get a channel object by its name.
glite_transfer_Channel2 *	glite_channel_getChannel2 (glite_transfer_ctx ctx, const char name)
glite_transfer_Channel3 *	glite_channel_getChannel3 (glite_transfer_ctx ctx, const char 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_setBandwidth2 (glite_transfer_ctx ctx, const char name, int utilisation, const char *message)
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_setContact2 (glite_transfer_ctx ctx, const char name, const char contact, const char message)
int	glite_channel_setTCPBufferSize2 (glite_transfer_ctx ctx, const char name, const char buffer_size, const char message)
	Set the default TCP buffer size for a channel.
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_setNominalThroughput2 (glite_transfer_ctx ctx, const char name, int nominalThroughput, const char *message)
int	glite_channel_setTargetDirCheck (glite_transfer_ctx ctx, const char name, int target_dir_check, const char *message)
	Set the flag to check the target directory on put operation.
int	glite_channel_setUrlCopyFirstMarkTo (glite_transfer_ctx ctx, const char name, int url_copy_first_txmark_to, const char *message)
	Set the number of seconds to mark first operations for URL copy as starting ones.
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_setNumberOfFiles2 (glite_transfer_ctx ctx, const char name, int numberOfFiles, const char *message)
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_setNumberOfStreams2 (glite_transfer_ctx ctx, const char name, int numberOfStreams, const char *message)
int	glite_channel_setState (glite_transfer_ctx ctx, const char name, glite_channel_state state)
	Set the state of a channel.
int	glite_channel_setState2 (glite_transfer_ctx ctx, const char name, glite_channel_state state, const char *message)
int	glite_channel_setBlockSize (glite_transfer_ctx ctx, const char name, const char value, const char message)
	setBlockSize
int	glite_channel_setHttpTimeout (glite_transfer_ctx ctx, const char name, int value, const char *message)
	setHttpTimeout
int	glite_channel_setTransferLogLevel (glite_transfer_ctx ctx, const char name, transfer_log_level value, const char *message)
	setTransferLogLevel
int	glite_channel_setPreparingFilesRatio (glite_transfer_ctx ctx, const char name, double value, const char *message)
	setPreparingFilesRatio
int	glite_channel_setUrlCopyPutTimeout (glite_transfer_ctx ctx, const char name, int value, const char *message)
	setUrlCopyPutTimeout
int	glite_channel_setUrlCopyPutDoneTimeout (glite_transfer_ctx ctx, const char name, int value, const char *message)
	setUrlCopyPutDoneTimeout
int	glite_channel_setUrlCopyGetTimeout (glite_transfer_ctx ctx, const char name, int value, const char *message)
	setUrlCopyGetTimeout
int	glite_channel_setUrlCopyGetDoneTimeout (glite_transfer_ctx ctx, const char name, int value, const char *message)
	setUrlCopyGetDoneTimeout
int	glite_channel_setUrlCopyTransferTimeout (glite_transfer_ctx ctx, const char name, int value, const char *message)
	setUrlCopyTransferTimeout
int	glite_channel_setUrlCopyTransferMarkersTimeout (glite_transfer_ctx ctx, const char name, int value, const char *message)
	setUrlCopyTransferMarkersTimeout
int	glite_channel_setUrlCopyNoProgressTimeout (glite_transfer_ctx ctx, const char name, int value, const char *message)
	setUrlCopyNoProgressTimeout
int	glite_channel_setUrlCopyTransferTimeoutPerMB (glite_transfer_ctx ctx, const char name, double value, const char *message)
	setUrlCopyTransferTimeoutPerMB
int	glite_channel_setSrmCopyDirection (glite_transfer_ctx ctx, const char name, srmcopy_direction value, const char *message)
	setSrmCopyDirection
int	glite_channel_setSrmCopyTimeout (glite_transfer_ctx ctx, const char name, int value, const char *message)
	setSrmCopyTimeout
int	glite_channel_setSrmCopyRefreshTimeout (glite_transfer_ctx ctx, const char name, int value, const char *message)
	setSrmCopyRefreshTimeout
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.
int	glite_channel_setVOLimit (glite_transfer_ctx ctx, const char name, const char *VOname, int limit)
	Sets the transfer limit of a VO on a given channel.
glite_transfer_ChannelAuditEntry **	glite_channel_channelAudit (glite_transfer_ctx ctx, const time_t startTime, const time_t endTime, const char restrictType, const int lastNentries, const char channelName, int resultCount)
	Fetches the channel admin audit for the given period.
char **	glite_channel_getSiteGroupNames (glite_transfer_ctx ctx, int resultCnt)
	Get a list of the names of the defined site groups.
char **	glite_channel_getSiteGroupMembers (glite_transfer_ctx ctx, char groupName, int *resultCnt)
	Get the list of the sites that are members of the group with given name.
int	glite_channel_addGroupMember (glite_transfer_ctx ctx, char groupName, char *siteName)
	Add the site with given name to members of the given group.
int	glite_channel_removeGroupMember (glite_transfer_ctx ctx, char groupName, char *siteName)
	Remove the site with given name from members of the given group.

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_addGroupMember	(	glite_transfer_ctx *	ctx,
		char *	groupName,
		char *	siteName
	)

Add the site with given name to members of the given group.

If the group does not exist it is created.

Parameters:

	ctx	[IN] The transfer context.
	groupName	[IN] The name of the group.
	siteName	[IN] The name of the site.

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.

glite_transfer_ChannelAuditEntry** glite_channel_channelAudit	(	glite_transfer_ctx *	ctx,
		const time_t	startTime,
		const time_t	endTime,
		const char *	restrictType,
		const int	lastNentries,
		const char *	channelName,
		int *	resultCount
	)

Fetches the channel admin audit for the given period.

Parameters:

	ctx	The transfer context.
	startTime	The start time for the audit
	endTime	The end time for the audit
	restrictType	Check for these events only
	lastNentries	Get the last N events
	channelName	The channel for which to fetch the audit information

Returns:: A list of channel audit entries

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.

glite_transfer_Channel2* glite_channel_getChannel2	(	glite_transfer_ctx *	ctx,
		const char *	name
	)

glite_transfer_Channel3* glite_channel_getChannel3	(	glite_transfer_ctx *	ctx,
		const char *	name
	)

char** glite_channel_getSiteGroupMembers	(	glite_transfer_ctx *	ctx,
		char *	groupName,
		int *	resultCnt
	)

Get the list of the sites that are members of the group with given name.

Parameters:

	ctx	[IN] The transfer context.
	groupName	[IN] The name of the group.
	resultCnt	[OUT] The number of items in the return array.

Returns:: A list containing the names of the sites belonging to the group, or NULL if there was an error.

char** glite_channel_getSiteGroupNames	(	glite_transfer_ctx *	ctx,
		int *	resultCnt
	)

Get a list of the names of the defined site groups.

Parameters:

	ctx	[IN] The transfer context.
	resultCnt	[OUT] The number of items in the return array.

Returns:: A list containing the names of the site groups, 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_removeGroupMember	(	glite_transfer_ctx *	ctx,
		char *	groupName,
		char *	siteName
	)

Remove the site with given name from members of the given group.

If after the operation the group is empty, the group is deleted.

Parameters:

	ctx	[IN] The transfer context.
	groupName	[IN] The name of the group.
	siteName	[IN] The name of the site.

Returns:: 0 when successful and -1 in case of 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_setBandwidth2	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	utilisation,
		const char *	message
	)

int glite_channel_setBlockSize	(	glite_transfer_ctx *	ctx,
		const char *	name,
		const char *	value,
		const char *	message
	)

setBlockSize

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	value	the block size
	message	the message for the change

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_setContact2	(	glite_transfer_ctx *	ctx,
		const char *	name,
		const char *	contact,
		const char *	message
	)

int glite_channel_setHttpTimeout	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	value,
		const char *	message
	)

setHttpTimeout

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	value	the http timeout
	message	the message for the change

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_setNominalThroughput2	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	nominalThroughput,
		const char *	message
	)

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_setNumberOfFiles2	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	numberOfFiles,
		const char *	message
	)

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_setNumberOfStreams2	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	numberOfStreams,
		const char *	message
	)

int glite_channel_setPreparingFilesRatio	(	glite_transfer_ctx *	ctx,
		const char *	name,
		double	value,
		const char *	message
	)

setPreparingFilesRatio

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	value	the preparing files ratio
	message	the message for the change

Returns:: 0 when successful and -1 in case of an error.

int glite_channel_setSrmCopyDirection	(	glite_transfer_ctx *	ctx,
		const char *	name,
		srmcopy_direction	value,
		const char *	message
	)

setSrmCopyDirection

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	value	SRM copy direction
	message	the message for the change

Returns:: 0 when successful and -1 in case of an error.

int glite_channel_setSrmCopyRefreshTimeout	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	value,
		const char *	message
	)

setSrmCopyRefreshTimeout

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	value	srm copy refresh timeout
	message	the message for the change

Returns:: 0 when successful and -1 in case of an error.

int glite_channel_setSrmCopyTimeout	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	value,
		const char *	message
	)

setSrmCopyTimeout

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	value	the srm copy timeout
	message	the message for the change

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_setState2	(	glite_transfer_ctx *	ctx,
		const char *	name,
		glite_channel_state	state,
		const char *	message
	)

int glite_channel_setTargetDirCheck	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	target_dir_check,
		const char *	message
	)

Set the flag to check the target directory on put operation.

Parameters:

	ctx	The transfer context.
	name	The name of the channel.
	target_dir_check	The flag if to check for target directory availability

Returns:: 0 when successful and -1 in case of an error.

int glite_channel_setTCPBufferSize2	(	glite_transfer_ctx *	ctx,
		const char *	name,
		const char *	buffer_size,
		const char *	message
	)

Set the default TCP buffer size for a channel.

Parameters:

	ctx	The transfer context.
	name	The name of the channel.
	buffer_size	The TCP buffer size string.

Returns:: 0 when successful and -1 in case of an error.

int glite_channel_setTransferLogLevel	(	glite_transfer_ctx *	ctx,
		const char *	name,
		transfer_log_level	value,
		const char *	message
	)

setTransferLogLevel

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	value	the transfer log level
	message	the message for the change

Returns:: 0 when successful and -1 in case of an error.

int glite_channel_setUrlCopyFirstMarkTo	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	url_copy_first_txmark_to,
		const char *	message
	)

Set the number of seconds to mark first operations for URL copy as starting ones.

Parameters:

	ctx	The transfer context.
	name	The name of the channel.
	url_copy_first_txmark_to	if to check for target directory availability

Returns:: 0 when successful and -1 in case of an error.

int glite_channel_setUrlCopyGetDoneTimeout	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	value,
		const char *	message
	)

setUrlCopyGetDoneTimeout

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	value	the url copy getDone timeout
	message	the message for the change

Returns:: 0 when successful and -1 in case of an error.

int glite_channel_setUrlCopyGetTimeout	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	value,
		const char *	message
	)

setUrlCopyGetTimeout

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	value	the url copy get timeout
	message	the message for the change

Returns:: 0 when successful and -1 in case of an error.

int glite_channel_setUrlCopyNoProgressTimeout	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	value,
		const char *	message
	)

setUrlCopyNoProgressTimeout

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	the	no-progress timeout
	message	the message for the change

Returns:: 0 when successful and -1 in case of an error.

int glite_channel_setUrlCopyPutDoneTimeout	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	value,
		const char *	message
	)

setUrlCopyPutDoneTimeout

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	value	the url copy putDone timeout
	message	the message for the change

Returns:: 0 when successful and -1 in case of an error.

int glite_channel_setUrlCopyPutTimeout	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	value,
		const char *	message
	)

setUrlCopyPutTimeout

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	value	the url copy put timeout
	message	the message for the change

Returns:: 0 when successful and -1 in case of an error.

int glite_channel_setUrlCopyTransferMarkersTimeout	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	value,
		const char *	message
	)

setUrlCopyTransferMarkersTimeout

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	value	the transfer markers timeout
	message	the message for the change

Returns:: 0 when successful and -1 in case of an error.

int glite_channel_setUrlCopyTransferTimeout	(	glite_transfer_ctx *	ctx,
		const char *	name,
		int	value,
		const char *	message
	)

setUrlCopyTransferTimeout

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	value	the transfer timeout
	message	the message for the change

Returns:: 0 when successful and -1 in case of an error.

int glite_channel_setUrlCopyTransferTimeoutPerMB	(	glite_transfer_ctx *	ctx,
		const char *	name,
		double	value,
		const char *	message
	)

setUrlCopyTransferTimeoutPerMB

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	additional	transfer timeout in seconds per MB
	message	the message for the change

Returns:: 0 when successful and -1 in case of an error.

int glite_channel_setVOLimit	(	glite_transfer_ctx *	ctx,
		const char *	name,
		const char *	VOname,
		int	limit
	)

Sets the transfer limit of a VO on a given channel.

Parameters:

	ctx	The transfer context.
	name	The name of the channel
	VOname	The name of the VO
	limit	The limit value

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.

org.glite.data.transfer.channel.ChannelManagement

Functions

Function Documentation