Provided by: libglobus-ftp-client-doc_9.2-2_all bug

NAME

       globus_ftp_client_restart_marker - Restart Markers.

SYNOPSIS

   Data Structures
       union globus_ftp_client_restart_marker_t
           Restart marker.

       This structure is may be either a stream mode transfer offset, or an extended block mode
       byte range. "

   Functions
       globus_result_t globus_ftp_client_restart_marker_init (globus_ftp_client_restart_marker_t
           *marker)
       globus_result_t globus_ftp_client_restart_marker_copy (globus_ftp_client_restart_marker_t
           *new_marker, globus_ftp_client_restart_marker_t *marker)
       globus_result_t globus_ftp_client_restart_marker_destroy
           (globus_ftp_client_restart_marker_t *marker)
       globus_result_t globus_ftp_client_restart_marker_insert_range
           (globus_ftp_client_restart_marker_t *marker, globus_off_t offset, globus_off_t
           end_offset)
       globus_result_t globus_ftp_client_restart_marker_set_ascii_offset
           (globus_ftp_client_restart_marker_t *marker, globus_off_t offset, globus_off_t
           ascii_offset)
       globus_result_t globus_ftp_client_restart_marker_set_offset
           (globus_ftp_client_restart_marker_t *marker, globus_off_t offset)
       globus_result_t globus_ftp_client_restart_marker_get_total
           (globus_ftp_client_restart_marker_t *marker, globus_off_t *total_bytes)
       globus_result_t globus_ftp_client_restart_marker_to_string
           (globus_ftp_client_restart_marker_t *marker, char **marker_string)
       globus_result_t globus_ftp_client_restart_marker_from_string
           (globus_ftp_client_restart_marker_t *marker, const char *marker_string)

Detailed Description

       Restart Markers.

       FTP Restart Markers

       The Globus FTP Client library provides the ability to start a file transfer from a known
       location into the file. This is accomplished by passing a restart marker to the
       globus_ftp_client_get(), globus_ftp_client_put(), or
       globus_ftp_client_third_party_transfer() functions.

Function Documentation

   globus_result_t globus_ftp_client_restart_marker_copy (globus_ftp_client_restart_marker_t *
       new_marker, globus_ftp_client_restart_marker_t * marker)
       Create a copy of a restart marker.

       This function copies the contents of marker to new_marker.

       Parameters:
           new_marker A pointer to a new restart marker.
           marker The marker to copy.

       See also:
           globus_ftp_client_restart_marker_init(), globus_ftp_client_restart_marker_destroy()

   globus_result_t globus_ftp_client_restart_marker_destroy (globus_ftp_client_restart_marker_t *
       marker)
       Destroy a restart marker.

       Parameters:
           marker Restart marker. This marker must be initialized by either calling
           globus_ftp_client_restart_marker_init() or globus_ftp_client_restart_marker_copy()

       See also:
           globus_ftp_client_restart_marker_t, globus_ftp_client_restart_marker_init(),
           globus_ftp_client_restart_marker_copy()

   globus_result_t globus_ftp_client_restart_marker_from_string
       (globus_ftp_client_restart_marker_t * marker, const char * marker_string)
       Initialize a restart marker from a string.

       This function initializes a new restart, marker, based on the marker_string parameter. The
       string may be either a single offset for a stream-mode restart marker, or a comma-
       separated list of start-end ranges.

       Parameters:
           marker The restart marker to be unitialized.
           marker_string The string containing a textual representation of a restart marker.

       See also:
           Restart Markers

   globus_result_t globus_ftp_client_restart_marker_get_total (globus_ftp_client_restart_marker_t
       * marker, globus_off_t * total_bytes)
       Get total bytes accounted for in restart marker

       This funtion will return the sum of all bytes accounted for in a restart marker. If this
       restart marker contains a stream offset then this value is the same as the offset (not the
       ascii offset) that it was set with. If it is a range list, it a sum of all the bytes in
       the ranges.

       Parameters:
           marker A previously initialized or copied restart marker
           total_bytes pointer to storage for total bytes in marker

       Returns:

           ยท Error on NULL marker or total bytes

   globus_result_t globus_ftp_client_restart_marker_init (globus_ftp_client_restart_marker_t *
       marker)
       Initialize a restart marker.

       Parameters:
           marker New restart marker.

       See also:
           globus_ftp_client_restart_marker_t, globus_ftp_client_restart_marker_destroy()

   globus_result_t globus_ftp_client_restart_marker_insert_range
       (globus_ftp_client_restart_marker_t * marker, globus_off_t offset, globus_off_t
       end_offset)
       Insert a range into a restart marker

       This function updates a restart marker with a new byte range, suitable for using to
       restart an extended block mode transfer. Adjacent ranges within the marker will be
       combined into a single entry in the marker.

       The marker must first be initialized by calling globus_ftp_client_restart_marker_init() or
       globus_ftp_client_restart_marker_copy().

       A marker can only hold a range list or a stream offset. Calling this function after
       calling globus_ftp_client_restart_marker_set_offset() will result in a marker suitable
       only for use restarting an extended block mode transfer.

       Parameters:
           marker A restart marker
           offset The starting offset of the range.
           end_offset The ending offset of the range.

       See also:
           globus_ftp_client_restart_marker_set_offset()
           globus_ftp_client_operationattr_set_mode()

   globus_result_t globus_ftp_client_restart_marker_set_ascii_offset
       (globus_ftp_client_restart_marker_t * marker, globus_off_t offset, globus_off_t
       ascii_offset)
       Set the offset for a restart marker.

       This function modifies a restart marker to contain a stream offset, suitable for using to
       restart a steam mode transfer.

       The marker must first be initialized by calling globus_ftp_client_restart_marker_init() or
       globus_ftp_client_restart_marker_copy().

       A marker can only hold a range list or a stream offset. Calling this function after
       calling globus_ftp_client_restart_marker_insert_range() will delete the ranges associated
       with the marker, and replace it with a marker suitable only for use restarting a stream
       mode transfer.

       When restarting an ASCII type transfer, use
       globus_ftp_client_restart_marker_set_ascii_offset() to set both the offset used in the
       local representation of an ACSII file, and the network representation of the ASCII file.
       For UNIX systems, the former includes counts newlines as one character towards the file
       offset, and the latter counts them as 2 characters (CRLF).

       Parameters:
           marker A restart marker
           offset The local stream offset.
           ascii_offset The network ascii representation of the offset.

       See also:
           globus_ftp_client_restart_marker_insert_range(),
           globus_ftp_client_restart_marker_set_offset(),
           globus_ftp_client_operationattr_set_mode(), globus_ftp_client_operationattr_set_type()

   globus_result_t globus_ftp_client_restart_marker_set_offset
       (globus_ftp_client_restart_marker_t * marker, globus_off_t offset)
       Set the offset for a restart marker.

       This function modifies a restart marker to contain a stream offset, suitable for using to
       restart a steam mode transfer.

       The marker must first be initialized by calling globus_ftp_client_restart_marker_init() or
       globus_ftp_client_restart_marker_copy().

       A marker can only hold a range list or a stream offset. Calling this function after
       calling globus_ftp_client_restart_marker_insert_range() will delete the ranges associated
       with the marker, and replace it with a marker suitable only for use restarting a stream
       mode transfer.

       When restarting an ASCII type transfer, the offset must take into account the additional
       carriage return characters added to the data stream.

       Parameters:
           marker A restart marker
           offset The stream offset

       See also:
           globus_ftp_client_restart_marker_insert_range(),
           globus_ftp_client_operationattr_set_mode(), globus_ftp_client_operationattr_set_type()

   globus_result_t globus_ftp_client_restart_marker_to_string (globus_ftp_client_restart_marker_t
       * marker, char ** marker_string)
       Create a string representation of a restart marker.

       This function sets the marker_string parameter to point to a freshly allocated string
       suitable for sending as an argument to the FTP REST command, or for a later call to
       globus_ftp_client_restart_marker_from_string().

       The string pointed to by marker_string must be freed by the caller.

       Parameters:
           marker An initialized FTP client restart marker.
           marker_string A pointer to a char * to be set to a freshly allocated marker string.

       See also:
           Restart Markers

Author

       Generated automatically by Doxygen for globus_ftp_client from the source code.