Package pyGlobus :: Module gassTransfer :: Class TransferClient
[show private | hide private]
[frames | no frames]

Class TransferClient

TransData --+
            |
           TransferClient


Method Summary
  __init__(self)
  __del__(self)
  append(self, attr, url, length)
Return ret is the return value from the underlying globus call if ret == 0 then the call was 'successful' in the globus sense
  get(self, attr, url)
Return ret is the return value from the underlying globus call if ret == 0 then the call was 'successful' in the globus sense
  put(self, attr, url, length)
Return ret is the return value from the underlying globus call if ret == 0 then the call was 'successful' in the globus sense
  register_append(self, attr, url, callback, arg, length)
Return ret is the return value from the underlying globus call if ret == 0 then the call was 'successful' in the globus sense
  register_get(self, attr, url, callback, arg)
Return ret is the return value from the underlying globus call if ret == 0 then the call was 'successful' in the globus sense
  register_put(self, attr, url, callback, arg, length)
Return ret is the return value from the underlying globus call if ret == 0 then the call was 'successful' in the globus sense
    Inherited from TransData
  free_callback(self, cbHandle)
Free a callback.
  receive_bytes(self, request, buffer, wait_for_amount, callback, arg)
Return a SWIG'ized pointer to the callback handle is returned.
  send_bytes(self, request, buffer, eof, callback, arg)
After authorizing a request the server calls send bytes which sends the data in the buffer object

Method Details

append(self, attr, url, length=0)

Parameters:
attr - is a RequestAttr object
url -

is the url that is the file that you want to append to An example of a url could be http://huey.lbl.gov:3730/etc/group

This function is blocking
length - is the length of the file that you wish to append The default 0, will do the put with the length arguement GLOBUS_GASS_TRANSFER_LENGTH_UNKNOWN
Returns:

ret is the return value from the underlying globus call if ret == 0 then the call was 'successful' in the globus sense

cbHandle is a SWIG'ized pointer to the callback structure, if the call was successful, otherwise it is an error message

request is a SWIG'ized pointer to the underlying request handle. The request handle is a client side request handle
Raises:
TransferException - A TransferException is raised if the register_append cannot be made

get(self, attr, url)

Parameters:
attr - is a RequestAttr object
url -

is the url that is the file that you want to get An example of a url could be http://huey.lbl.gov:3730/etc/group

This function is blocking
Returns:

ret is the return value from the underlying globus call if ret == 0 then the call was 'successful' in the globus sense

request is a SWIG'ized pointer to the underlying request handle. The request handle is a client side request handle if ret != 0 then request is an error string and is printed out
Raises:
TransferException - A TransferException is raised if the get cannot be made

put(self, attr, url, length=0)

Parameters:
attr - is a RequestAttr object
url - is the url that is the file that you want to put An example of a url could be http://huey.lbl.gov:3730/etc/group
length -

is the length of the file that you wish to put The default 0, will do the put with the length arguement GLOBUS_GASS_TRANSFER_LENGTH_UNKNOWN

This function is blocking
Returns:

ret is the return value from the underlying globus call if ret == 0 then the call was 'successful' in the globus sense

request is a SWIG'ized pointer to the underlying request handle. The request handle is a client side request handle
Raises:
TransferException - A TransferException is raised if the put cannot be made

register_append(self, attr, url, callback, arg, length=0)

Parameters:
attr - is a RequestAttr object
url - is the url that is the file that you want to append to An example of a url could be http://huey.lbl.gov:3730/etc/group
callback - is a function that will be called back after the request to get has been authorized, denied or refered
arg - is a user arguement to the callback function
length -

is the length of the file that you wish to append The default 0, will do the put with the length arguement GLOBUS_GASS_TRANSFER_LENGTH_UNKNOWN

This function is non-blocking
Returns:

ret is the return value from the underlying globus call if ret == 0 then the call was 'successful' in the globus sense

cbHandle is a SWIG'ized pointer to the callback structure, if the call was successful, otherwise it is an error message

request is a SWIG'ized pointer to the underlying request handle. The request handle is a client side request handle
Raises:
TransferException - A TransferException is raised if the register_append cannot be made

register_get(self, attr, url, callback, arg)

Parameters:
attr - is a RequestAttr object
url - is the url that is the file that you want to get An example of a url could be http://huey.lbl.gov:3730/etc/group
callback - is a function that will be called back after the request to get has been authorized, denied or refered
arg -

is a user arguement to the callback function

This function is non-blocking
Returns:

ret is the return value from the underlying globus call if ret == 0 then the call was 'successful' in the globus sense

cbHandle is a SWIG'ized pointer to the callback structure, if the call was successful, otherwise it is an error message

request is a SWIG'ized pointer to the underlying request handle. The request handle is a client side request handle
Raises:
TransferException - A TransferException is raised if the register_get cannot be made

register_put(self, attr, url, callback, arg, length=0)

Parameters:
attr - is a RequestAttr object
url - is the url that is the file that you want to put An example of a url could be http://huey.lbl.gov:3730/etc/group
callback - is a function that will be called back after the request to get has been authorized, denied or refered
arg -

is a user arguement to the callback function

This function is non-blocking
length -

is the length of the file that you wish to put The default 0, will do the put with the length arguement GLOBUS_GASS_TRANSFER_LENGTH_UNKNOWN

This function is blocking
Returns:

ret is the return value from the underlying globus call if ret == 0 then the call was 'successful' in the globus sense

cbHandle is a SWIG'ized pointer to the callback structure, if the call was successful, otherwise it is an error message

request is a SWIG'ized pointer to the underlying request handle. The request handle is a client side request handle
Raises:
TransferException - A TransferException is raised if the register_put cannot be made

Generated by Epydoc 2.1 on Thu Dec 23 16:41:57 2004 http://epydoc.sf.net