globus_gass_transfer(3)

NAME
globus_gass_transfer - GASS Transfer API

 - GASS Transfer API.

SYNOPSIS

  Topics

Activation
Activation.
Client-Initiated Operations
GASS Transfer Client Operations.
Implementing Servers
GASS Server Implementation.
Sending and Receiving Data
Sending and Receiving Data.
Referrals
GASS Referrals.
Request Handles
Request Handles.
Request Attributes
Request Attributes.
Listener attributes
Listener attributes.
Implementing Request Attributes
Implementing Request Attributes.
Protocol Modules
Protocol Implementation API.

  Macros

#define GLOBUS_GASS_TRANSFER_LENGTH_UNKNOWN
#define GLOBUS_GASS_TRANSFER_TIMESTAMP_UNKNOWN

  Enumerations

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

Detailed Description

GASS Transfer API.

The GASS Transfer API is the core part of the GASS (Global Access to Secondary Storage) component of the Grid Community Toolkit. The purpose of GASS is to provide a simple way to enable grid applications to securely stage and access data to and from remote file servers using a simple protocol-independent API.

The GASS Transfer API provides a way to implement both client and server components. These share common data block and request management functionality. Client-specific functions are provided to implement file "get", "put", and "append" operations. Server-specific functions are provided to implement servers which service such requests. Client and server functionality can be included in a single application, so one could implement proxies or cross-protocol bridges.

The GASS Transfer API is easily extensible to support different remote data access protocols. The standard Globus distribution includes client-side support for the http, and https protocols, as well as server-side support for the http and https protocols. An application which requires additional protocol support may add this through the protocol module interface.

The GASS Transfer API is defined in the header file "globus_gass_transfer.h"

The GLOBUS_GASS_TRANSFER_MODULE must be activated before calling any functions in this API.

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.