Aborting Connections

Use ft_abort() to abort a connection and ft_ireceive() to determine why you received an abort indication.

ft_abort()

#include %</opt/ftam/include/map.h>
#include %</opt/ftam/include/mapftam.h>
Return_code
ft_abort(connection_id, return_event_name, input_dcb, 
         inout_dcb)
Connection_id                  connection_id;
Local_event_name               return_event_name;
struct Ft_abort_in_dcb         *input_dcb;
struct Ft_output               **inout_dcb;

Use ft_abort() to abruptly terminate a connection at any time (i.e., in any regime).




	NOTE: If you abort while writing data, you could lose any or all data written during that transfer; you will not, however, lose the source file.

Ft_abort_in_dcb

struct    Ft_abort_in_dcb {
          struct  Ft_abort_req_info    info;
};

struct  Ft_abort_req_info {
        enum  Ft_action_result        action_result;
        struct  Ft_diagnostic         *diagnostic;
};

Ft_output

struct  Ft_output {
        Uint32                size;
        struct  Api_rc        result;
};

ft_abort() Parameters

ft_abort() Parameter	Type	Description
connection_id	Mandatory Input	Uniquely identifies the specific filestore connection to abort
return_event_name	Mandatory Input	If the call is asynchronous, uniquely identifies the function call; if the call is synchronous, the value is 0 (zero)
input_dcb-> info.action_result	Mandatory Input	Conveys the reason for the abort
input_dcb-> info.diagnostic	Optional Input	ISO-specific error information; HP-UX responders accept, but ignore, this value
inout_dcb->size	Mandatory input if using inout_dcb	Size (in Octets) of the inout_dcb structure and data
inout_dcb->result	Output	Pointer to the struct Api_rc containing the outcome of the operation: result_code and vendor_code (HP-UX—specific error)

ft_ireceive()

#include %</opt/ftam/include/map.h>
#include %</opt/ftam/include/mapftam.h>
Return_code
ft_ireceive(connection_id, return_event_name, inout_dcb, 
            indication_name)
Connection_id                  connection_id;
Local_event_name               return_event_name;
struct Ft_indication_out_dcb   *inout_dcb;
Uint32                         *indication_name;

If you receive the FTE003_ABORT_IND_RCVD error, call ft_ireceive()

to determine whether the abort was caused by the system (initiator, responder, or network) or by a user, and
to receive diagnostics.

The information regarding the type of abort returns in the indication_name parameter and may be useful for troubleshooting purposes.

All diagnostics associated with the abort are returned in the inout_dcb.

Ft_indication_out_dcb

struct  Ft_indication_out_dcb {
        Uint32                                  size;
        struct  Api_rc                          result;
        union   Ft_specific_indication_info     info;
};

union  Ft_specific_indication_info {
       struct Ft_aabort_ind_info                aabort_info;
       struct Ft_pabort_ind_info                pabort_info;
};

struct  Ft_aabort_ind_info {
        enum Ft_action_result                  action_result;
        struct Ft_diagnostic                   *diagnostic;
};

struct  Ft_pabort_ind_info {
        enum  Ft_action_result                 action_result;
        struct  Ft_diagnostic                  *diagnostic;
};

ft_ireceive() Parameters

ft_ireceive() Parameter	Type	Description
connection_id	Mandatory Input	Uniquely identifies the aborted connection
return_event_name	Mandatory Input	If the call is asynchronous, uniquely identifies the function call; if the call is synchronous, the value is 0 (zero)
inout_dcb->size	Mandatory input if using inout_dcb	Size (in Octets) of the inout_dcb structure and data
inout_dcb->result	Output	Pointer to the struct Api_rc containing the outcome of the operation: result_code and vendor_code (HP-UX—specific error)
inout_dcb->info. aabort_info.action_result	Output	Specifies that an application caused the abort Specifies the overall success or failure of the request
inout_dcb->info. aabort_info.diagnostic	Output	Specifies that an application caused the abort; provides ISO-specific error information
inout_dcb->info. pabort_info.action_result	Output	Specifies that the system caused the abort Specifies the overall success or failure of the request
inout_dcb->info. pabort_info.diagnostic	Output	Specifies that the system caused the abort; provides ISO-specific error information
indication_name	Output	Specifies if the abort was a system (FT_PABORT_IND) or application (FT_AABORT_IND) abort; dictates which union Ft_specific_indication_info contains the output information

Aborting Connections

Technical documentation

» Table of Contents

» Glossary

» Index