globus_i_gass_transfer.h

/*
 * 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_DONT_DOCUMENT_INTERNAL

#ifndef GLOBUS_I_GASS_TRANSFER_H
#define GLOBUS_I_GASS_TRANSFER_H

#include "globus_gass_transfer.h"
#include "globus_gass_transfer_proto.h"
#include "globus_i_gass_transfer_keyvalue.h"

#ifdef __cplusplus
extern "C" {
#endif

extern globus_hashtable_t globus_i_gass_transfer_protocols;
extern globus_handle_table_t globus_i_gass_transfer_request_handles;
extern globus_handle_table_t globus_i_gass_transfer_listener_handles;
extern globus_list_t * globus_i_gass_transfer_requests;
extern globus_list_t * globus_i_gass_transfer_listeners;
extern globus_bool_t globus_i_gass_transfer_deactivating;

/* Default implemented protocols */
extern globus_module_descriptor_t globus_i_gass_transfer_http_module;
#define GLOBUS_I_GASS_TRANSFER_HTTP_MODULE (&globus_i_gass_transfer_http_module)
extern globus_module_descriptor_t globus_i_gass_transfer_ftp_module;
#define GLOBUS_I_GASS_TRANSFER_FTP_MODULE (&globus_i_gass_transfer_ftp_module)

extern globus_gass_transfer_proto_descriptor_t
    globus_i_gass_transfer_http_descriptor;
extern globus_gass_transfer_proto_descriptor_t
    globus_i_gass_transfer_https_descriptor;
extern globus_gass_transfer_proto_descriptor_t
    globus_i_gass_transfer_ftp_descriptor;
extern globus_gass_transfer_proto_descriptor_t
    globus_i_gass_transfer_gsiftp_descriptor;
/*
 * The request status structure. This should only be accessed
 * through the functions globus_gass_transfer_request_get_*()
 */
typedef struct 
{
    char *                  url;
    globus_gass_transfer_request_type_t     type;
    globus_gass_transfer_request_status_t   status;

    globus_bool_t               client_side;

    globus_size_t               length;
    globus_size_t               handled_length;
    globus_size_t               posted_length;

    char **                 referral_url;
    globus_size_t               referral_count;

    globus_gass_transfer_callback_t     callback;
    void *                  callback_arg;

    globus_gass_transfer_callback_t     fail_callback;
    void *                  fail_callback_arg;

    /* subject of peer */
    char *                  subject;

    /* queue of byte arrays to be sent or received */
    globus_fifo_t               pending_data;

    /* Denial reasons */
    int                     denial_reason;
    char *                  denial_message;

    globus_object_t *               attr;

    struct globus_gass_transfer_request_proto_s *
                            proto;
    void *                  user_pointer;
} globus_gass_transfer_request_struct_t;

/*
 * The listener status structure. This should only be accessed
 * through the functions globus_gass_transfer_listener_get_*()
 */
typedef struct 
{
    char *                  base_url;
    globus_gass_transfer_listener_status_t  status;
    struct globus_gass_transfer_listener_proto_s *
                            proto;

    globus_gass_transfer_listen_callback_t  listen_callback;
    void *                  listen_callback_arg;

    globus_gass_transfer_close_callback_t   close_callback;
    void *                  close_callback_arg;
    void *                  user_pointer;
} globus_gass_transfer_listener_struct_t;

/* the pending_data fifo in the request structure is one of these */
typedef struct
{
    globus_bool_t               last_data;
    globus_size_t               length;
    globus_size_t               wait_for_length;
    globus_gass_transfer_request_t      request;

    /*
     * True when this pending block has been passed to the protocol
     * module
     */
    globus_bool_t               pending;

    globus_byte_t *             bytes;
    globus_gass_transfer_bytes_callback_t   callback;
    void *                  callback_arg;
} globus_gass_transfer_pending_t;

/* implemented in globus_gass_transfer_request.c */
void
globus_i_gass_transfer_request_init(
    globus_gass_transfer_request_t *        request,
    globus_gass_transfer_requestattr_t *    attr,
    char *                  url,
    globus_gass_transfer_request_type_t     type,
    globus_gass_transfer_callback_t     callback,
    void *                  user_arg);

int
globus_i_gass_transfer_request_destroy(
    globus_gass_transfer_request_t      request);

void
globus_gass_transfer_request_set_length(
    globus_gass_transfer_request_t      request,
    globus_size_t               length);

/* implemented in globus_gass_transfer_server.c */
int
globus_i_gass_transfer_listener_destroy(
    globus_gass_transfer_listener_t     listener);

/* implemented in globus_gass_transfer_client.c */
int
globus_i_gass_transfer_client_request(
    globus_gass_transfer_request_t *        request);

/* implemented in globus_gass_transfer_send_recv.c */
typedef void
(* globus_gass_transfer_dispatch_func_t) (
    globus_gass_transfer_request_t      request);

void
globus_i_gass_transfer_send_dispatcher(
    globus_gass_transfer_request_t      request);

void
globus_i_gass_transfer_recv_dispatcher(
    globus_gass_transfer_request_t      request);

int
globus_i_gass_transfer_fail(
    globus_gass_transfer_request_t      request,
    globus_gass_transfer_request_struct_t * req,
    globus_gass_transfer_callback_t     callback,
    void *                  callback_arg);

extern globus_cond_t globus_i_gass_transfer_shutdown_cond;
extern globus_mutex_t globus_i_gass_transfer_mutex;

#if defined(GLOBUS_DEBUG_GASS_TRANSFER)
#define globus_i_gass_transfer_lock()   \
    thread_print(_GTSL("locking mutex at %s:%d\n"), __FILE__, __LINE__), \
    globus_mutex_lock(&globus_i_gass_transfer_mutex)
#define globus_i_gass_transfer_unlock() \
    thread_print(_GTSL("unlocking mutex at %s:%d\n"), __FILE__, __LINE__), \
    globus_mutex_unlock(&globus_i_gass_transfer_mutex)
#else
#define globus_i_gass_transfer_lock()   \
    globus_mutex_lock(&globus_i_gass_transfer_mutex)
#define globus_i_gass_transfer_unlock() \
    globus_mutex_unlock(&globus_i_gass_transfer_mutex)
#endif

int
globus_i_gass_transfer_close_listener(
    globus_gass_transfer_listener_t     listener,
    globus_gass_transfer_listener_struct_t *    l,
    globus_gass_transfer_close_callback_t   callback,
    void *                  user_arg);

void
globus_i_gass_transfer_deactivate_callback(
    void *                  user_arg,
    globus_gass_transfer_request_t      request);

#ifdef __cplusplus
}
#endif

#endif /* GLOBUS_I_GASS_TRANSFER_H */

#endif /* GLOBUS_DONT_DOCUMENT_INTERNAL */