globus_xio_gridftp_driver.h

Go to the documentation of this file.

/*
 * Copyright 1999-2006 University of Chicago
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef GLOBUS_XIO_GRIDFTP_DRIVER_H
#define GLOBUS_XIO_GRIDFTP_DRIVER_H

#include "globus_xio_system.h"
#include "globus_common.h"

#ifndef GLOBUS_GLOBAL_DOCUMENT_SET

#endif

#define globus_xio_gridftp_attr_cntl globus_xio_attr_cntl
#define globus_xio_gridftp_handle_cntl globus_xio_handle_cntl

typedef enum
{
    GLOBUS_XIO_GRIDFTP_ERROR_ATTR,
    GLOBUS_XIO_GRIDFTP_ERROR_SEEK,
    GLOBUS_XIO_GRIDFTP_ERROR_OUTSTANDING_READ,
    GLOBUS_XIO_GRIDFTP_ERROR_OUTSTANDING_WRITE,
    GLOBUS_XIO_GRIDFTP_ERROR_PENDING_READ,
    GLOBUS_XIO_GRIDFTP_ERROR_PENDING_WRITE,
    GLOBUS_XIO_GRIDFTP_ERROR_OUTSTANDING_PARTIAL_XFER

} globus_xio_gridftp_error_type_t;

#define globus_xio_gridftp_attr_cntl globus_xio_attr_cntl
#define globus_xio_gridftp_handle_cntl globus_xio_handle_cntl

typedef enum
{
    /*
     * handle cntls
     */         

    /* globus_off_t         seek_offset */
    GLOBUS_XIO_GRIDFTP_SEEK,

    /*
     * attr cntls
     */
    /* globus_ftp_client_handle_t * ftp_handle */
    GLOBUS_XIO_GRIDFTP_SET_HANDLE,

    /* globus_ftp_client_handle_t **    ftp_handle_out */
    GLOBUS_XIO_GRIDFTP_GET_HANDLE,

    /* globus_bool_t            append */
    GLOBUS_XIO_GRIDFTP_SET_APPEND,

    /* globus_bool_t *          append_out */
    GLOBUS_XIO_GRIDFTP_GET_APPEND,

    /* const char *         eret_alg_str */
    GLOBUS_XIO_GRIDFTP_SET_ERET,

    /* char **              eret_alg_str_out */
    GLOBUS_XIO_GRIDFTP_GET_ERET,

    /* const char *         esto_alg_str */
    GLOBUS_XIO_GRIDFTP_SET_ESTO,

    /* char **              esto_alg_str_out */
    GLOBUS_XIO_GRIDFTP_GET_ESTO,

    /* globus_bool_t            partial_xfer */
    GLOBUS_XIO_GRIDFTP_SET_PARTIAL_TRANSFER,

    /* globus_bool_t *          partial_xfer_out */
    GLOBUS_XIO_GRIDFTP_GET_PARTIAL_TRANSFER,

    /* int              num_streams */
    GLOBUS_XIO_GRIDFTP_SET_NUM_STREAMS,

    /* int *                num_streams_out */
    GLOBUS_XIO_GRIDFTP_GET_NUM_STREAMS,

    /* int              buf_size */
    GLOBUS_XIO_GRIDFTP_SET_TCP_BUFFER,

    /* int *                buf_size_out */
    GLOBUS_XIO_GRIDFTP_GET_TCP_BUFFER,

    /* int              mode */
    GLOBUS_XIO_GRIDFTP_SET_MODE,

    /* int *                mode_out */
    GLOBUS_XIO_GRIDFTP_GET_MODE,

    /* gss_cred_id_t            credential,
     * const char *         user,
     * const char *         password,
     * const char *         account,
     * const char *         subject */
    GLOBUS_XIO_GRIDFTP_SET_AUTH,

    /* gss_cred_id_t *          credential_out,
     * const char **                    user_out,
     * const char **                    password_out,
     * const char **                    account_out,
     * const char **                    subject_out */
    GLOBUS_XIO_GRIDFTP_GET_AUTH,

    /* int              dcau_mode */
    GLOBUS_XIO_GRIDFTP_SET_DCAU,

    /* int *                dcau_mode_out */
    GLOBUS_XIO_GRIDFTP_GET_DCAU,

    /* int              protection */
    GLOBUS_XIO_GRIDFTP_SET_DATA_PROTECTION,

    /* int *                protection_out */
    GLOBUS_XIO_GRIDFTP_GET_DATA_PROTECTION,

    /* int              protection */
    GLOBUS_XIO_GRIDFTP_SET_CONTROL_PROTECTION,

    /* int *                protection_out */
    GLOBUS_XIO_GRIDFTP_GET_CONTROL_PROTECTION

} globus_xio_gridftp_cmd_t;     

typedef enum globus_l_xio_gridftp_mode_e
{
    GLOBUS_XIO_GRIDFTP_MODE_NONE,
    GLOBUS_XIO_GRIDFTP_MODE_STREAM = 'S',
    GLOBUS_XIO_GRIDFTP_MODE_BLOCK = 'B',
    GLOBUS_XIO_GRIDFTP_MODE_EXTENDED_BLOCK = 'E',
    GLOBUS_XIO_GRIDFTP_MODE_COMPRESSED = 'C'
} globus_l_xio_gridftp_mode_t;

typedef enum globus_l_xio_gridftp_dcau_mode_e
{
    GLOBUS_XIO_GRIDFTP_DCAU_NONE = 'N',
    GLOBUS_XIO_GRIDFTP_DCAU_SELF = 'A',
    GLOBUS_XIO_GRIDFTP_DCAU_SUBJECT = 'S',
    GLOBUS_XIO_GRIDFTP_DCAU_DEFAULT
} globus_l_xio_gridftp_dcau_mode_t;


typedef enum globus_l_xio_gridftp_protection_e
{
    GLOBUS_XIO_GRIDFTP_PROTECTION_CLEAR = 'C',
    GLOBUS_XIO_GRIDFTP_PROTECTION_SAFE = 'S',
    GLOBUS_XIO_GRIDFTP_PROTECTION_CONFIDENTIAL = 'E',
    GLOBUS_XIO_GRIDFTP_PROTECTION_PRIVATE = 'P'
} globus_l_xio_gridftp_protection_t;


#endif /* GLOBUS_XIO_GRIDFTP_DRIVER_H */