man7/x25.7

   1 .\" SPDX-License-Identifier: Linux-man-pages-1-para
   2 .\"
   3 .\" This man page is Copyright (C) 1998 Heiner Eisen.
   4 .\"
   5 .\" $Id: x25.7,v 1.4 1999/05/18 10:35:12 freitag Exp $
   6 .\"
   7 .TH x25 7 (date) "Linux man-pages (unreleased)"
   8 .SH NAME
   9 x25 \- ITU-T X.25 / ISO-8208 protocol interface
  10 .SH SYNOPSIS
  11 .nf
  12 .B #include <sys/socket.h>
  13 .B #include <linux/x25.h>
  14 .P
  15 .IB x25_socket " = socket(AF_X25, SOCK_SEQPACKET, 0);"
  16 .fi
  17 .SH DESCRIPTION
  18 X25 sockets provide an interface to the X.25 packet layer protocol.
  19 This allows applications to
  20 communicate over a public X.25 data network as standardized by
  21 International Telecommunication Union's recommendation X.25
  22 (X.25 DTE-DCE mode).
  23 X25 sockets can also be used for communication
  24 without an intermediate X.25 network (X.25 DTE-DTE mode) as described
  25 in ISO-8208.
  26 .P
  27 Message boundaries are preserved \[em] a
  28 .BR read (2)
  29 from a socket will
  30 retrieve the same chunk of data as output with the corresponding
  31 .BR write (2)
  32 to the peer socket.
  33 When necessary, the kernel takes care
  34 of segmenting and reassembling long messages by means of
  35 the X.25 M-bit.
  36 There is no hard-coded upper limit for the
  37 message size.
  38 However, reassembling of a long message might fail if
  39 there is a temporary lack of system resources or when other constraints
  40 (such as socket memory or buffer size limits) become effective.
  41 If that
  42 occurs, the X.25 connection will be reset.
  43 .SS Socket addresses
  44 The
  45 .B AF_X25
  46 socket address family uses the
  47 .I struct sockaddr_x25
  48 for representing network addresses as defined in ITU-T
  49 recommendation X.121.
  50 .P
  51 .in +4n
  52 .EX
  53 struct sockaddr_x25 {
  54     sa_family_t sx25_family;    /* must be AF_X25 */
  55     x25_address sx25_addr;      /* X.121 Address */
  56 };
  57 .EE
  58 .in
  59 .P
  60 .I sx25_addr
  61 contains a char array
  62 .I x25_addr[]
  63 to be interpreted as a null-terminated string.
  64 .I sx25_addr.x25_addr[]
  65 consists of up to 15 (not counting the terminating null byte) ASCII
  66 characters forming the X.121 address.
  67 Only the decimal digit characters from \[aq]0\[aq] to \[aq]9\[aq] are allowed.
  68 .SS Socket options
  69 The following X.25-specific socket options can be set by using
  70 .BR setsockopt (2)
  71 and read with
  72 .BR getsockopt (2)
  73 with the
  74 .I level
  75 argument set to
  76 .BR SOL_X25 .
  77 .TP
  78 .B X25_QBITINCL
  79 Controls whether the X.25 Q-bit (Qualified Data Bit) is accessible by the
  80 user.
  81 It expects an integer argument.
  82 If set to 0 (default),
  83 the Q-bit is never set for outgoing packets and the Q-bit of incoming
  84 packets is ignored.
  85 If set to 1, an additional first byte is prepended
  86 to each message read from or written to the socket.
  87 For data read from
  88 the socket, a 0 first byte indicates that the Q-bits of the corresponding
  89 incoming data packets were not set.
  90 A first byte with value 1 indicates
  91 that the Q-bit of the corresponding incoming data packets was set.
  92 If the first byte of the data written to the socket is 1, the Q-bit of the
  93 corresponding outgoing data packets will be set.
  94 If the first byte is 0,
  95 the Q-bit will not be set.
  96 .SH VERSIONS
  97 The AF_X25 protocol family is a new feature of Linux 2.2.
  98 .SH BUGS
  99 Plenty, as the X.25 PLP implementation is
 100 .BR CONFIG_EXPERIMENTAL .
 101 .P
 102 This man page is incomplete.
 103 .P
 104 There is no dedicated application programmer's header file yet;
 105 you need to include the kernel header file
 106 .IR <linux/x25.h> .
 107 .B CONFIG_EXPERIMENTAL
 108 might also imply that future versions of the
 109 interface are not binary compatible.
 110 .P
 111 X.25 N-Reset events are not propagated to the user process yet.
 112 Thus,
 113 if a reset occurred, data might be lost without notice.
 114 .SH SEE ALSO
 115 .BR socket (2),
 116 .BR socket (7)
 117 .P
 118 Jonathan Simon Naylor:
 119 \[lq]The Re-Analysis and Re-Implementation of X.25.\[rq]
 120 The URL is
 121 .UR ftp://ftp.pspt.fi\:/pub\:/ham\:/linux\:/ax25\:/x25doc.tgz
 122 .UE .