1

"""

     2

    The low-level OS Socket API and related functionality, covering the Internet layer.

     3

     4

    All functionality provided here aims to be a thin wrapper around the native system API, so for the most part, methods

     5

    map directly to *one* syscall/libc call.

     6

     7

    Provided modules/types:

     8

     9

    address:

    10

        Abstract socket addresses.

    11

    12

        sockaddr        - corresponds to the `struct sockaddr` used in socket API calls. This is an abstract type

    13

                          that cannot itself be instantated, see `sockaddr_in`/`sockaddr_in6`/`endpoint`.

    14

    15

        addrinfo        - corresponds to the `struct addrinfo` used by the GAI API. Hold a concrete `sockaddr`

    16

    17

        endpoint        - abstract internet hostname+service address as handled by getaddrinfo. Maps to a series of `addrinfo`'s.

    18

    19

    af_inet:

    20

        AF_INET (IPv4) -specific functionality.

    21

    22

        sockaddr_in     - AF_INET sockaddr with addr, port fields

    23

    24

    af_inet6:

    25

        AF_INET6 (IPv6) -specific functionality.

    26

    27

        sockaddr_in6    - AF_INET6 sockaddr with addr, port, flowinfo, scope_id fields

    28

    29

    socket:

    30

        Core socket API.

    31

    32

        socket          - socket-related syscalls with a guaranteed 1:1 mapping between methods and library

    33

                          calls.

    34

    35

    sctp:

    36

        SCTP-specific socket API

    37

    38

        sctp_socket     - extension of socket.socket to support SCTP-specific socket API extensions

    39

    40

    constants:

    41

        Socket-related constants.

    42

    43

        AF_*            - address families

    44

        SOCK_*          - socket types

    45

        IPPROTO_*       - inet protocols

    46

        MSG_*           - send/recv message flags

    47

    48

        etc.

    49

"""

    50

    51

## XXX: these shadow the modules... how do we want to provide these?

    52

#from qmsk.net.socket.address import sockaddr, addrinfo, endpoint

    53

#

    54

#from qmsk.net.socket.af_inet import sockaddr_in

    55

#from qmsk.net.socket.af_inet6 import sockaddr_in6

    56

#

    57

#from qmsk.net.socket.socket import socket

    58

#from qmsk.net.socket.sctp import sctp_socket

    59

#

    61

#