draft/man7/udplite.7

   1 .\" Copyright (c) 2008 by Gerrit Renker <gerrit@erg.abdn.ac.uk>
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" $Id: udplite.7,v 1.12 2008/07/23 15:22:22 gerrit Exp gerrit $
  24 .\"
  25 .\" Japanese Version Copyright (c) 2008  Akihiro MOTOKI
  26 .\"         all rights reserved.
  27 .\" Translated 2008-08-21, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v3.07
  28 .\"
  29 .TH UDPLITE  7 2008-12-03 "Linux" "Linux Programmer's Manual"
  30 .\"O .SH NAME
  31 .SH 名前
  32 .\"O udplite \- Lightweight User Datagram Protocol
  33 udplite \- 軽量なユーザーデータグラムプロトコル
  34 .\"O .SH SYNOPSIS
  35 .SH 書式
  36 .B #include <sys/socket.h>
  37 .br
  38 .\" FIXME . see #defines under `BUGS',
  39 .\"        when glibc supports this, add
  40 .\"        #include <netinet/udplite.h>
  41 .sp
  42 .B sockfd = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDPLITE);
  43 .\"O .SH DESCRIPTION
  44 .SH 説明
  45 .\"O This is an implementation of the Lightweight User Datagram Protocol
  46 .\"O (UDP-Lite), as described in RFC\ 3828.
  47 これは RFC\ 3828 に書かれている軽量なユーザーデータグラムプロトコル
  48 (Lightweight User Datagram Protocol; UDP-Lite) の実装である。
  49
  50 .\"O UDP-Lite is an extension of UDP (RFC\ 768) to support variable-length
  51 .\"O checksums.
  52 .\"O This has advantages for some types of multimedia transport that
  53 .\"O may be able to make use of slightly damaged datagrams,
  54 .\"O rather than having them discarded by lower-layer protocols.
  55 UDP-Lite は UDP (RFC\ 768) の拡張で、可変長のチェックサムをサポートしている。
  56 このプロトコルが効果を発揮するのは、少しだけ壊れたデータグラムがあった場合に、
  57 そのデータグラムを下位レイヤーのプロトコルに廃棄させるのではなく、
  58 それを利用することができるような、ある種のマルチメディア転送においてである。
  59
  60 .\"O The variable-length checksum coverage is set via a
  61 .\"O .BR setsockopt (2)
  62 .\"O option.
  63 .\"O If this option is not set, the only difference to UDP is
  64 .\"O in using a different IP protocol identifier (IANA number 136).
  65 可変長のチェックサムの対象範囲は
  66 .BR setsockopt (2)
  67 オプション経由で設定される。
  68 このオプションが設定されていない場合、UDP と異なるのは
  69 違う IP プロトコル識別子 (IANA 番号 136) を使用する点だけである。
  70
  71 .\"O The UDP-Lite implementation is a full extension of
  72 .\"O .BR udp (7),
  73 .\"O i.e., it shares the same API and API behaviour, and in addition
  74 .\"O offers two socket options to control the checksum coverage.
  75 UDP-Lite の実装は
  76 .BR udp (7)
  77 の完全な拡張、すなわち API と API の動作は同じである。
  78 これに加えて、2 つのソケットオプションがチェックサムの対象範囲を
  79 制御するために提供されている。
  80 .\"O .SS "Address Format"
  81 .SS アドレスのフォーマット
  82 .\"O UDP-Litev4 uses the
  83 .\"O .I sockaddr_in
  84 .\"O address format described in
  85 .\"O .BR ip (7).
  86 .\"O UDP-Litev6 uses the
  87 .\"O .I sockaddr_in6
  88 .\"O address format described in
  89 .\"O .BR ipv6 (7).
  90 UDP-Litev4 は
  91 .BR ip (7)
  92 で説明されている
  93 .I sockaddr_in
  94 アドレスを使用する。
  95 UDP-Litev6 は
  96 .BR ipv6 (7)
  97 で説明されている
  98 .I sockaddr_in6
  99 アドレスを使用する。
 100 .\"O .SS "Socket Options"
 101 .SS ソケットオプション
 102 .\"O To set or get a UDP-Lite socket option, call
 103 .\"O .BR getsockopt (2)
 104 .\"O to read or
 105 .\"O .BR setsockopt (2)
 106 .\"O to write the option with the option level argument set to
 107 .\"O .BR IPPROTO_UDPLITE .
 108 .\"O In addition, all
 109 .\"O .B IPPROTO_UDP
 110 .\"O socket options are valid on a UDP-Lite socket.
 111 .\"O See
 112 .\"O .BR udp (7)
 113 .\"O for more information.
 114 UDP-Lite のソケットオプションを設定/取得するには、
 115 オプションレベル引き数に
 116 .B IPPROTO_UDPLITE
 117 を指定して、取得時には
 118 .BR getsockopt (2)
 119 を、設定時には
 120 .BR setsockopt (2)
 121 を呼び出す。さらに、全ての
 122 .B IPPROTO_UDP
 123 のソケットオプションが UDP-Lite ソケットでも使用できる。
 124 詳細は
 125 .BR udp (7)
 126 を参照のこと。
 127
 128 .\"O The following two options are specific to UDP-Lite.
 129 以下の 2 つが UDP-Lite に固有のオプションである。
 130 .TP
 131 .BR UDPLITE_SEND_CSCOV
 132 .\"O This option sets the sender checksum coverage and takes an
 133 .\"O .I int
 134 .\"O as argument, with a checksum coverage value in the range 0..2^16-1.
 135 このオプションは送信側のチェックサムの対象範囲を設定する。
 136 .I int
 137 型を引き数として取り、設定可能な値の範囲は 0 から 2^16-1 までである。
 138
 139 .\"O A value of 0 means that the entire datagram is always covered.
 140 .\"O Values from 1-7 are illegal (RFC\ 3828, 3.1) and are rounded up to
 141 .\"O the minimum coverage of 8.
 142 値 0 はデータグラム全体が常にチェックサムの対象となることを意味する。
 143 値 1〜7 は不正であり (RFC\ 3828 の 3.1 章)、範囲の設定として最小値である
 144 8 に切り上げられる。
 145
 146 .\"O With regard to IPv6 jumbograms (RFC\ 2675), the UDP-Litev6 checksum
 147 .\"O coverage is limited to the first 2^16-1 octets, as per RFC\ 3828, 3.5.
 148 .\"O Higher values are therefore silently truncated to 2^16-1.
 149 .\"O If in doubt, the current coverage value can always be queried using
 150 .\"O .BR getsockopt (2).
 151 IPv6 の jumbograms (巨大なデータグラム; RFC\ 2675) の場合には、
 152 UDP-Litev6 のチェックサムの対象範囲は、RFC\ 3828 の 3.5 章にあるように、
 153 先頭から 2^16-1 オクテットまでに限定される。
 154 そのため、それより大きな値は 2^16-1 に黙って切り詰められる。
 155 現在の対象範囲の値を知りたければ、いつでも
 156 .BR getsockopt (2)
 157 を使って値を問い合わせることができる。
 158 .TP
 159 .BR UDPLITE_RECV_CSCOV
 160 .\"O This is the receiver-side analogue and uses the same argument format
 161 .\"O and value range as
 162 .\"O .BR UDPLITE_SEND_CSCOV .
 163 .\"O This option is not required to enable traffic with partial checksum
 164 .\"O coverage.
 165 .\"O Its function is that of a traffic filter: when enabled, it
 166 .\"O instructs the kernel to drop all packets which have a coverage
 167 .\"O .I less
 168 .\"O than the specified coverage value.
 169 これは受信側のチェックサムの対象範囲を設定するもので、
 170 使用される引き数形式と値の範囲は
 171 .B UDPLITE_SEND_CSCOV
 172 と同じである。
 173 このオプションは、部分的なチェックサム対象範囲を持つトラフィックを
 174 有効にするのに必要なわけではなく、トラフィックフィルターとして機能する。
 175 このオプションが有効にすると、カーネルは指定されたチェックサム対象範囲
 176 よりも「短かい」対象範囲を持つパケットを全て廃棄するようになる。
 177
 178 .\"O When the value of
 179 .\"O .B UDPLITE_RECV_CSCOV
 180 .\"O exceeds the actual packet coverage, incoming packets are silently dropped,
 181 .\"O but may generate a warning message in the system log.
 182 .B UDPLITE_RECV_CSCOV
 183 の値が実際のパケットのチェックサム対象範囲よりも大きい場合、
 184 受信したパケットは黙って廃棄される。
 185 ただし、システムログに対して警告メッセージが生成されるかもしれない。
 186 .\" SO_NO_CHECK exists and is supported by UDPv4, but is
 187 .\" commented out in socket(7), hence also commented out here
 188 .\".PP
 189 .\"Since UDP-Lite mandates checksums, checksumming can not be disabled
 190 .\"via the
 191 .\".B SO_NO_CHECK
 192 .\"option from
 193 .\".BR socket (7).
 194 .\"O .SH ERRORS
 195 .SH エラー
 196 .\"O All errors documented for
 197 .\"O .BR udp (7)
 198 .\"O may be returned.
 199 .\"O UDP-Lite does not add further errors.
 200 .BR udp (7)
 201 について書かれている全てのエラーは返る可能性がある。
 202 UDP-Lite 自体は新たなエラーは追加していない。
 203 .\"O .SH BUGS
 204 .SH バグ
 205 .\" FIXME . remove this section once glibc supports UDP-Lite
 206 .\"O Where glibc support is missing, the following definitions are needed:
 207 glibc によるサポートがない場合は、以下の定義を行う必要がある。
 208 .in +4n
 209 .nf
 210
 211 #define IPPROTO_UDPLITE     136
 212 .\" The following two are defined in the kernel in linux/net/udplite.h
 213 #define UDPLITE_SEND_CSCOV  10
 214 #define UDPLITE_RECV_CSCOV  11
 215 .fi
 216 .in
 217 .\"O .SH FILES
 218 .SH ファイル
 219 .I /proc/net/snmp
 220 .\"O \- basic UDP-Litev4 statistics counters.
 221 \- UDP-Litev4 の基本的な統計情報カウンター。
 222 .br
 223 .I /proc/net/snmp6
 224 .\"O \- basic UDP-Litev6 statistics counters.
 225 \- UDP-Litev6 の基本的な統計情報カウンター。
 226 .\"O .SH VERSIONS
 227 .SH バージョン
 228 .\"O UDP-Litev4/v6 first appeared in Linux 2.6.20.
 229 UDP-Litev4/v6 は Linux 2.6.20 で初めて登場した。
 230 .\"O .SH "SEE ALSO"
 231 .SH 関連項目
 232 .BR ip (7),
 233 .BR ipv6 (7),
 234 .BR socket (7),
 235 .BR udp (7)
 236
 237 RFC\ 3828 for the Lightweight User Datagram Protocol (UDP-Lite)
 238 .br
 239 .I Documentation/networking/udplite.txt