NAME

       globus_gass_transfer.h - GASS transfer.

SYNOPSIS

       #include 'globus_common.h'

   Macros
       #define GLOBUS_GASS_TRANSFER_MODULE
       #define GLOBUS_GASS_TRANSFER_LENGTH_UNKNOWN
       #define GLOBUS_GASS_TRANSFER_TIMESTAMP_UNKNOWN

   Typedefs
       typedef void(* globus_gass_transfer_close_callback_t) (void *callback_arg,
           globus_gass_transfer_listener_t listener)
       typedef void(* globus_gass_transfer_listen_callback_t) (void *callback_arg,
           globus_gass_transfer_listener_t listener)
       typedef void(* globus_gass_transfer_bytes_callback_t) (void *arg, globus_gass_transfer_request_t request,
           globus_byte_t *bytes, globus_size_t length, globus_bool_t last_data)

   Enumerations
       enum globus_gass_transfer_request_type_t { GLOBUS_GASS_TRANSFER_REQUEST_TYPE_INVALID,
           GLOBUS_GASS_TRANSFER_REQUEST_TYPE_GET, GLOBUS_GASS_TRANSFER_REQUEST_TYPE_PUT,
           GLOBUS_GASS_TRANSFER_REQUEST_TYPE_APPEND }
       enum globus_gass_transfer_request_status_t { GLOBUS_GASS_TRANSFER_REQUEST_INVALID,
           GLOBUS_GASS_TRANSFER_REQUEST_STARTING, GLOBUS_GASS_TRANSFER_REQUEST_PENDING,
           GLOBUS_GASS_TRANSFER_REQUEST_FAILED, GLOBUS_GASS_TRANSFER_REQUEST_REFERRED,
           GLOBUS_GASS_TRANSFER_REQUEST_DENIED, GLOBUS_GASS_TRANSFER_REQUEST_DONE }
       enum { GLOBUS_GASS_TRANSFER_ERROR_BAD_PORT = 2, GLOBUS_GASS_TRANSFER_ERROR_INTERNAL_ERROR,
           GLOBUS_GASS_TRANSFER_ERROR_BAD_URL, GLOBUS_GASS_TRANSFER_ERROR_NOT_SUPPORTED,
           GLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED, GLOBUS_GASS_TRANSFER_ERROR_MALLOC_FAILED,
           GLOBUS_GASS_TRANSFER_ERROR_NOT_INITIALIZED, GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER,
           GLOBUS_GASS_TRANSFER_ERROR_NOT_REGISTERED, GLOBUS_GASS_TRANSFER_ERROR_NOT_FOUND,
           GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE, GLOBUS_GASS_TRANSFER_ERROR_TOO_LARGE,
           GLOBUS_GASS_TRANSFER_ERROR_REQUEST_FAILED, GLOBUS_GASS_TRANSFER_ERROR_DONE,
           GLOBUS_GASS_TRANSFER_ERROR_ALREADY_REGISTERED, GLOBUS_GASS_TRANSFER_ERROR_OPEN_FAILED,
           GLOBUS_GASS_TRANSFER_ERROR_TRANSFER_FAILED }
       enum

   Functions
       int globus_gass_transfer_register_get (globus_gass_transfer_request_t *request,
           globus_gass_transfer_requestattr_t *attr, char *url, globus_gass_transfer_callback_t callback, void
           *user_arg)
       int globus_gass_transfer_get (globus_gass_transfer_request_t *request, globus_gass_transfer_requestattr_t
           *attr, char *url)
       int globus_gass_transfer_register_put (globus_gass_transfer_request_t *request,
           globus_gass_transfer_requestattr_t *attr, char *url, globus_size_t length,
           globus_gass_transfer_callback_t callback, void *user_arg)
       int globus_gass_transfer_put (globus_gass_transfer_request_t *request, globus_gass_transfer_requestattr_t
           *attr, char *url, globus_size_t length)
       int globus_gass_transfer_register_append (globus_gass_transfer_request_t *request,
           globus_gass_transfer_requestattr_t *attr, char *url, globus_size_t length,
           globus_gass_transfer_callback_t callback, void *user_arg)
       int globus_gass_transfer_append (globus_gass_transfer_request_t *request,
           globus_gass_transfer_requestattr_t *attr, char *url, globus_size_t length)
       int globus_gass_transfer_create_listener (globus_gass_transfer_listener_t *listener,
           globus_gass_transfer_listenerattr_t *attr, char *scheme)
       int globus_gass_transfer_close_listener (globus_gass_transfer_listener_t listener,
           globus_gass_transfer_close_callback_t callback, void *user_arg)
       int globus_gass_transfer_register_listen (globus_gass_transfer_listener_t listener,
           globus_gass_transfer_listen_callback_t callback, void *user_arg)
       int globus_gass_transfer_register_accept (globus_gass_transfer_request_t *request,
           globus_gass_transfer_requestattr_t *attr, globus_gass_transfer_listener_t listener,
           globus_gass_transfer_callback_t callback, void *user_arg)
       int globus_gass_transfer_refer (globus_gass_transfer_request_t request, char **urls, globus_size_t
           num_urls)
       int globus_gass_transfer_authorize (globus_gass_transfer_request_t request, globus_size_t total_length)
       int globus_gass_transfer_deny (globus_gass_transfer_request_t request, int reason, char *message)
       char * globus_gass_transfer_listener_get_base_url (globus_gass_transfer_listener_t listener)
       void * globus_gass_transfer_listener_get_user_pointer (globus_gass_transfer_listener_t listener)
       int globus_gass_transfer_listener_set_user_pointer (globus_gass_transfer_listener_t listener, void
           *user_pointer)
       int globus_gass_transfer_send_bytes (globus_gass_transfer_request_t request, globus_byte_t *bytes,
           globus_size_t send_length, globus_bool_t last_data, globus_gass_transfer_bytes_callback_t callback,
           void *user_arg)
       int globus_gass_transfer_receive_bytes (globus_gass_transfer_request_t request, globus_byte_t *bytes,
           globus_size_t max_length, globus_size_t wait_for_length, globus_gass_transfer_bytes_callback_t
           callback, void *user_arg)
       globus_object_t * globus_gass_transfer_requestattr_initialize (globus_object_t *obj, char *proxy_url,
           globus_size_t block_size, globus_gass_transfer_file_mode_t file_mode, globus_bool_t connection_reuse)
       globus_object_t * globus_gass_transfer_socket_requestattr_initialize (globus_object_t *obj, char
           *proxy_url, globus_size_t block_size, globus_gass_transfer_file_mode_t file_mode, globus_bool_t
           connection_reuse, int sndbuf, int rcvbuf, globus_bool_t nodelay)
       globus_object_t * globus_gass_transfer_secure_requestattr_initialize (globus_object_t *obj, char
           *proxy_url, globus_size_t block_size, globus_gass_transfer_file_mode_t file_mode, globus_bool_t
           connection_reuse, int sndbuf, int rcvbuf, globus_bool_t nodelay, globus_gass_transfer_authorization_t
           authorization, char *subject)
       globus_object_t * globus_gass_transfer_listenerattr_initialize (globus_object_t *obj, int backlog,
           unsigned short port)

Detailed Description

       GASS transfer.

Macro Definition Documentation

   #define GLOBUS_GASS_TRANSFER_LENGTH_UNKNOWN
       Value for files we don't know the length of.

   #define GLOBUS_GASS_TRANSFER_TIMESTAMP_UNKNOWN
       Value for timestamps we don't know the value of.

Enumeration Type Documentation

   anonymous enum
       GASS error codes

       Enumerator

       GLOBUS_GASS_TRANSFER_ERROR_BAD_PORT
              Invalid port in URL

       GLOBUS_GASS_TRANSFER_ERROR_INTERNAL_ERROR
              Something bad occurred while processing the request

       GLOBUS_GASS_TRANSFER_ERROR_BAD_URL
              Unparsable URL

       GLOBUS_GASS_TRANSFER_ERROR_NOT_SUPPORTED
              Invalid file open mode in the GASS File library

       GLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED
              Operation not supported by GASS for this type of URL

       GLOBUS_GASS_TRANSFER_ERROR_MALLOC_FAILED
              Out of memory

       GLOBUS_GASS_TRANSFER_ERROR_NOT_INITIALIZED
              Uninitialized or invalid handle

       GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER
              NULL pointer passed as parameter

       GLOBUS_GASS_TRANSFER_ERROR_NOT_REGISTERED
              GASS Server not yet registered

       GLOBUS_GASS_TRANSFER_ERROR_NOT_FOUND
              URL not in cache

       GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE
              Invalid use of a GASS handle

       GLOBUS_GASS_TRANSFER_ERROR_TOO_LARGE
              Bytes array exceeds GASS request size

       GLOBUS_GASS_TRANSFER_ERROR_REQUEST_FAILED
              GASS Transfer request did not complete successfully

       GLOBUS_GASS_TRANSFER_ERROR_DONE
              GASS handle already closed before this operation began

       GLOBUS_GASS_TRANSFER_ERROR_ALREADY_REGISTERED
              GASS handle already registered for processing

       GLOBUS_GASS_TRANSFER_ERROR_OPEN_FAILED
              Could not open local file

       GLOBUS_GASS_TRANSFER_ERROR_TRANSFER_FAILED
              A protocol error or client-initiated failure has occurred

   anonymous enum
       Default buffer length for the globus_gass_transfer_assist library.

Author

       Generated automatically by Doxygen for globus_gass_transfer from the source code.

globus_gass_transfer                               Version 9.4                         globus_gass_transfer.h(3)