release/man3/netlink.3

   1 .\" This manpage copyright 1998 by Andi Kleen.
   2 .\"
   3 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
   4 .\" Subject to the GPL.
   5 .\" %%%LICENSE_END
   6 .\"
   7 .\" Based on the original comments from Alexey Kuznetsov
   8 .\" $Id: netlink.3,v 1.1 1999/05/14 17:17:24 freitag Exp $
   9 .\"
  10 .\"*******************************************************************
  11 .\"
  12 .\" This file was generated with po4a. Translate the source file.
  13 .\"
  14 .\"*******************************************************************
  15 .\"
  16 .\" Japanese Version Copyright (c) 1999 Shouichi Saito
  17 .\"     all rights reserved.
  18 .\" Translated Mon Jul 26 12:18:39 JST 1999
  19 .\"     by Shouichi Saito <ss236rx@ymg.urban.ne.jp>
  20 .\" Proofed Fri Aug 20 1999 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
  21 .\"
  22 .TH NETLINK 3 2014\-03\-20 GNU "Linux Programmer's Manual"
  23 .SH 名前
  24 netlink \- netlink マクロ
  25 .SH 書式
  26 .nf
  27 \fB#include <asm/types.h>\fP
  28 .br
  29 \fB#include <linux/netlink.h>\fP
  30 .sp
  31 \fBint NLMSG_ALIGN(size_t \fP\fIlen\fP\fB);\fP
  32 .br
  33 \fBint NLMSG_LENGTH(size_t \fP\fIlen\fP\fB);\fP
  34 .br
  35 \fBint NLMSG_SPACE(size_t \fP\fIlen\fP\fB);\fP
  36 .br
  37 \fBvoid *NLMSG_DATA(struct nlmsghdr *\fP\fInlh\fP\fB);\fP
  38 .br
  39 \fBstruct nlmsghdr *NLMSG_NEXT(struct nlmsghdr *\fP\fInlh\fP\fB, int \fP\fIlen\fP\fB);\fP
  40 .br
  41 \fBint NLMSG_OK(struct nlmsghdr *\fP\fInlh\fP\fB, int \fP\fIlen\fP\fB);\fP
  42 .br
  43 \fBint NLMSG_PAYLOAD(struct nlmsghdr *\fP\fInlh\fP\fB, int \fP\fIlen\fP\fB);\fP
  44 .fi
  45 .SH 説明
  46 \fI<linux/netlink.h>\fP では、 netlink データグラムにアクセスしたり、これを作成するための
  47 標準マクロがいくつか定義されている。 これらは \fBcmsg\fP(3)  で定義されている補助データ (auxiliary data) 用のマクロと、
  48 その精神において似ているものである。 netlink ソケットに対してやりとりされるバッファーには、
  49 必ずこれらのマクロだけを使ってアクセスすべきである。
  50 .TP
  51 \fBNLMSG_ALIGN\fP
  52 netlink メッセージの長さを丸めて正しく揃える。
  53 .TP
  54 \fBNLMSG_LENGTH\fP
  55 格納領域 (payload) の長さ \fIlen\fP を引数にとり、 \fInlmsghdr\fP の \fInlmsg_len\fP フィールドに代入できる
  56 揃えられた長さ (aligned length) を返す。
  57 .TP
  58 \fBNLMSG_SPACE\fP
  59 ペイロードの長さが \fIlen\fP の netlink メッセージのバイト数を返す。
  60 .TP
  61 \fBNLMSG_DATA\fP
  62 与えた \fInlmsghdr\fP に関連づけられた格納領域へのポインターを返す。
  63 .TP
  64 .\" this is bizarre, maybe the interface should be fixed.
  65 \fBNLMSG_NEXT\fP
  66 マルチパートメッセージにおいて、次の \fInlmsghdr\fP を入手する。これを呼び出すときには、 現在の nlmsghdr で NLMSG_DONE
  67 がセットされていないことを 確認しなければならない。この関数は終端で NULL を返さないからである。 \fIlen\fP
  68 引数はメッセージバッファーの残り長さが入った左辺値である。 このマクロはこの引数からメッセージヘッダーの長さ分を差し引く。
  69 .TP
  70 \fBNLMSG_OK\fP
  71 Netlink メッセージが途切れておらず、かつ解釈可能な形の場合であれば真を返す。
  72 .TP
  73 \fBNLMSG_PAYLOAD\fP
  74 \fInlmsghdr\fP に関連づけられた格納領域の長さを返す。
  75 .SH 準拠
  76 これらのマクロは非標準で、Linux での拡張である。
  77 .SH 注意
  78 通常はカーネルの低レベルインターフェイスよりも、 \fIlibnetlink\fP 経由で netlink を用いるほうが良い。
  79 .SH 関連項目
  80 \fBlibnetlink\fP(3), \fBnetlink\fP(7)
  81 .SH この文書について
  82 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.78 の一部
  83 である。プロジェクトの説明とバグ報告に関する情報は
  84 http://www.kernel.org/doc/man\-pages/ に書かれている。