8 ftp api external specification, Key objectives and features, Related documents – HP Integrity NonStop H-Series User Manual

Page 99: Connection management

8 FTP API External Specification

The FTP API external specification describes the external interface offered by the FTP application
program interface (API).

Key Objectives and Features

The API is designed to allow application programs to access the HP NonStop File Transfer Protocol
(FTP) programmatically.

The API is a set of library routines. The application program links its object code with the API library
object file to create an executable image file.

Any changes in internal design of the API should have no impact on existing applications using
the API. The API supports nowait, and indefinite wait operations.

There can be a maximum of one I/O operation on each connection. For the nowait operation,
you must verify this. As with other NSK procedure calls, when using the nowait option, do not
tamper with the buffer before the I/O is completed.

Error handling is standardized. A return code of -1 signifies that the command has failed, and the
error number gives the reason. (See Appendix B for error definitions).

The API offers debugging routines, which will display the commands and responses it sent and
received, and print these messages out to the log file specified by the user.

If the program abends, or otherwise contains an error, the program terminates. All Processes started
by the application should be cleared. That is, there should not be any orphan processes consuming
system resources.

CAUTION:

When compiling the C or C++ application, always specify wide pragmas.