1

"""

     2

    Socket addresses at various levels:

     3

     4

        sockaddr    - specific network-level address for socket operations

     5

        addrinfo    - information on a specific sockaddr including its socket parameters

     6

        endpoint    - human-readable network address, corresponding to multiple sockaddr's

     7

"""

     8

     9

cimport qmsk.net.socket.platform as platform

    10

    12

    13

# build a sockaddr from the given sockaddr struct, based on sa_family

    14

cdef sockaddr build_sockaddr (platform.sockaddr *sa, size_t sa_len)

    15

    16

cdef class addrinfo :

    17

    """

    18

        A socket-level endpoint address, which contains the full socket parameters and an bind/connect address.

    19

    20

        A full addrinfo struct is stored, but ai_canonname and ai_addr are stored as (optional) objects outside of the

    21

        addrinfo struct.

    22

    23

        >>> from qmsk.net.socket import af_inet

    24

        >>> ai = addrinfo()

    25

        >>> ai.addr

    26

        >>> ai.canonname

    27

        >>> print addrinfo(addr=af_inet.sockaddr_in())

    28

        family=0, socktype=0, protocol=0, addr=0.0.0.0:0, canonname=None

    29

    """

    30

    31

    # canonname is not stored

    32

    # may be NULL

    33

    cdef platform.addrinfo ai

    34

    35

    # may be NULL

    36

    cdef sockaddr ai_addr

    37

    cdef object ai_canonname

    38

    39

    # update self.ai.ai_* to reflect self.ai_*

    40

    cdef _init_ai_members (self)

    41

    42

    # set the contents of self.ai from the given real addrinfo

    43

    # this ignores the ai_canonname attribute

    44

    cdef _init_addrinfo (self, platform.addrinfo *ai)

    45

    46

# build and return a new addrinfo instance

    47

cdef addrinfo build_addrinfo (platform.addrinfo *c_ai)

    48

    49

cdef class endpoint :

    50

    """

    52

    54

        >>> e = endpoint('127.0.0.1', 80)

    55

        >>> str(e)

    56

        'hostname=127.0.0.1, service=80'

    58

        >>> len(res)

    59

        1

    60

        >>> str(res[0])

    61

        'family=2, socktype=1, protocol=6, addr=127.0.0.1:80, canonname=None'

    62

        >>> e = endpoint('2001::5', 80)

    63

        >>> str(e)

    64

        'hostname=2001::5, service=80'

    66

        >>> len(res)

    67

        1

    68

        >>> str(res[0])

    69

        'family=10, socktype=1, protocol=6, addr=[2001::5]:80, canonname=None'

    70

    71

    """

    72

    73

    # our defining attributes, set via __init__

    74

    cdef public object hostname, service

    75