NEAT Sockets API
draft-dreibholz-taps-neat-socketapi-05

Document Type Active Internet-Draft (individual)
Last updated 2019-07-22
Stream (None)
Intended RFC status (None)
Formats plain text pdf htmlized bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                       T. Dreibholz
Internet-Draft                                                 SimulaMet
Intended status: Experimental                              July 22, 2019
Expires: January 23, 2020

                            NEAT Sockets API
                 draft-dreibholz-taps-neat-socketapi-05

Abstract

   This document describes a BSD Sockets-like API on top of the
   callback-based NEAT User API.  This facilitates porting existing
   applications to use a subset of NEAT's functionality.

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at https://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on January 23, 2020.

Copyright Notice

   Copyright (c) 2019 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (https://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Dreibholz               Expires January 23, 2020                [Page 1]
Internet-Draft              NEAT Sockets API                   July 2019

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   4
     1.1.  Conventions . . . . . . . . . . . . . . . . . . . . . . .   4
   2.  Initialisation and Clean-Up . . . . . . . . . . . . . . . . .   4
     2.1.  nsa_init()  . . . . . . . . . . . . . . . . . . . . . . .   4
     2.2.  nsa_cleanup() . . . . . . . . . . . . . . . . . . . . . .   4
     2.3.  nsa_map_socket()  . . . . . . . . . . . . . . . . . . . .   5
     2.4.  nsa_unmap_socket()  . . . . . . . . . . . . . . . . . . .   5
   3.  Connection Establishment and Teardown . . . . . . . . . . . .   5
     3.1.  nsa_socket()  . . . . . . . . . . . . . . . . . . . . . .   5
     3.2.  nsa_socketpair()  . . . . . . . . . . . . . . . . . . . .   6
     3.3.  nsa_close() . . . . . . . . . . . . . . . . . . . . . . .   6
     3.4.  nsa_fcntl() . . . . . . . . . . . . . . . . . . . . . . .   7
     3.5.  nsa_bind()  . . . . . . . . . . . . . . . . . . . . . . .   7
     3.6.  nsa_bindx() . . . . . . . . . . . . . . . . . . . . . . .   8
     3.7.  nsa_bindn() . . . . . . . . . . . . . . . . . . . . . . .   9
     3.8.  nsa_connect() . . . . . . . . . . . . . . . . . . . . . .   9
     3.9.  nsa_connectx()  . . . . . . . . . . . . . . . . . . . . .  10
     3.10. nsa_connectn()  . . . . . . . . . . . . . . . . . . . . .  11
     3.11. nsa_listen()  . . . . . . . . . . . . . . . . . . . . . .  11
     3.12. nsa_accept()  . . . . . . . . . . . . . . . . . . . . . .  12
     3.13. nsa_accept4() . . . . . . . . . . . . . . . . . . . . . .  12
     3.14. nsa_shutdown()  . . . . . . . . . . . . . . . . . . . . .  13
   4.  Options Handling  . . . . . . . . . . . . . . . . . . . . . .  13
     4.1.  nsa_getsockopt()  . . . . . . . . . . . . . . . . . . . .  13
     4.2.  nsa_setsockopt()  . . . . . . . . . . . . . . . . . . . .  14
     4.3.  nsa_opt_info()  . . . . . . . . . . . . . . . . . . . . .  14
   5.  Security  . . . . . . . . . . . . . . . . . . . . . . . . . .  15
     5.1.  nsa_set_secure_identity() . . . . . . . . . . . . . . . .  15
     5.2.  ... . . . . . . . . . . . . . . . . . . . . . . . . . . .  15
   6.  Input/Output Handling . . . . . . . . . . . . . . . . . . . .  15
     6.1.  nsa_write() . . . . . . . . . . . . . . . . . . . . . . .  15
     6.2.  nsa_writev()  . . . . . . . . . . . . . . . . . . . . . .  16
     6.3.  nsa_pwrite()  . . . . . . . . . . . . . . . . . . . . . .  16
     6.4.  nsa_pwrite64()  . . . . . . . . . . . . . . . . . . . . .  16
     6.5.  nsa_pwritev() . . . . . . . . . . . . . . . . . . . . . .  17
     6.6.  nsa_pwritev64() . . . . . . . . . . . . . . . . . . . . .  17
     6.7.  nsa_send()  . . . . . . . . . . . . . . . . . . . . . . .  17
     6.8.  nsa_sendto()  . . . . . . . . . . . . . . . . . . . . . .  18
     6.9.  nsa_sendmsg() . . . . . . . . . . . . . . . . . . . . . .  18
     6.10. nsa_sendv() . . . . . . . . . . . . . . . . . . . . . . .  19
Show full document text