IEEE Std 1238.1-1994 IEEE Standard for Information Technology, OSI Application Program Interfaces—File Transfer, Access, and Management [C Language] -Description
Abstract: A C language Application Program Interface (API) to the OSI File Transfer, Access, and Management (FTAM) protocol is defined. The functions of the API implement high-level file transfer and file management operations using the service of an FTAM initiator and service provider that underlie the API. The API uses the services of the OSI Abstract Data Manipulation API (IEEE Std 122-1993) to facilitate passing of data between the API and the user.
Keywords: API, application layer, application portability, C language, file transfer, FTAM, OM, open systems, open systems interconnection, OSI, OSI Abstract Data Manipulation API
Content
1. General
1.1 Scope
1.2 Normative References
1.3 Conformance
1.3.1 Implementation Conformance
1.3.2 Application Conformance
2. Terminology and General Requirements
2.1 Conventions
2.1.1 General and Typographic Conventions
2.2 Definitions
2.2.1 Terminology
2.2.2 General Terms
2.2.3 Abbreviations
3. Overview (Informative)
3.1 FTAM API Model
3.2 Feature Summary
3.2.1 API Support Functions
3.2.2 File Transfer Functions
3.2.3 File Management Functions
3.2.4 Miscellaneous Functions
3.2.5 Document Types
3.2.6 FTAM API Base Package
3.2.7 Supporting APIs
3.3 Using the FTAM API
3.3.1 Include files
3.3.2 Library files
3.3.3 FTAM API Instances
3.3.4 Addressing the Remote Filestore
3.3.5 Filenames
3.3.6 Source Effect
3.3.7 Destination Effect
3.3.8 Synchronous and Asynchronous Processing Modes
3.3.9 Context-Free and Context-Sensitive Processing Modes
3.3.10 Interrupt Handling
3.3.11 Session Handle
3.3.12 Result Reporting
3.3.13 VFS Mapping
3.3.14 FTAM Attributes
3.3.15 Access Control
4. FTAM API Base Package OM Class Definitions
4.1 Package Definition
4.2 Class Definitions
4.2.1 Access-Control-Element
4.2.2 AE-Title
4.2.3 API-Input-Parameters
4.2.4 API-Output-Parameters
4.2.5 Charging
4.2.6 Content-Type
4.2.7 Directory-List
4.2.8 Document-Type
4.2.9 Document-Type-Text
4.2.10 Document-Type-FTAM-1
4.2.11 Document-Type-FTAM-2
4.2.12 Document-Type-Binary
4.2.13 Document-Type-FTAM-3
4.2.14 Document-Type-NBS-9
4.2.15 File-Action
4.2.16 FTAM-Attribute-Names
4.2.17 FTAM-Attributes
4.2.18 FTAM-Diagnostic
4.2.19 FTAM-Input-Parameters
4.2.20 FTAM-Output-Parameters
4.2.21 Password
4.2.22 New-Attributes
4.2.23 Session
4.3 Declaration Summary
4.3.1 Class Identifiers
4.3.2 Attribute Type Identifiers
4.3.3 C Identifier List
5. Service Interface
5.1 Datatypes
5.1.1 FT_package_t
5.1.2 FT_return_code
5.2 Functions
5.2.1 ft_abandon
5.2.2 ft_abort
5.2.3 ft_close
5.2.4 ft_connect
5.2.5 ft_disconnect
5.2.6 ft_fcattributes
5.2.7 ft_fdelete
5.2.8 ft_frattributes
5.2.9 ft_frdir
5.2.10 ft_freceive
5.2.11 ft_fsend
5.2.12 ft_gperror
5.2.13 ft_open
5.2.14 ft_rcvresult
5.3 Return Codes
5.3.1 FTAM Error Codes
5.3.2 Operation Error Codes
5.3.3 API Error Codes
5.4 C Identifier List
Annex A Overview of OM
A.1 OM Concepts and Terminology
A.1.1 Syntax
A.1.2 Value
A.1.3 OM Attribute
A.1.4 OM Object
A.1.5 OM Class
A.1.6 Package
A.1.7 Package Closure
A.1.8 Workspace
A.1.9 Descriptor
A.1.10 Use of Objects
A.2 OM Types
A.2.1 Intermediate Datatypes
A.2.2 Simple Datatypes
A.2.3 Composite Datatypes
A.3 Using OM with the FTAM API
A.3.1 Creating and Deleting the FTAM API Workspace
