TCSETATTR(3)

名称
cfgetispeed, cfsetispeed, cfgetospeed, cfsetospeed, cfsetspeed, cfmakeraw, tcgetattr, tcsetattr - termios 構造の操作

書式
#include <termios.h> speed_t cfgetispeed(const struct termios *t) int cfsetispeed(struct termios *t, speed_t speed) speed_t cfgetospeed(const struct termios *t) int cfsetospeed(struct termios *t, speed_t speed) int cfsetspeed(struct termios *t, speed_t speed) void cfmakeraw(struct termios *t) int tcgetattr(int fd, struct termios *t) int tcsetattr(int fd, int action, const struct termios *t)

解説
cfmakeraw(), tcgetattr() および tcsetattr() 関数は、termios 構造の取得および設定を行うためのものです。

cfgetispeed(), cfsetispeed(), cfgetospeed(), cfsetospeed() および cfsetspeed() 関数は、termios 構造におけるボーレートの取得および設定を 行うためのものです。以下に述べる端末に対する関数の効果は、 tcsetattr() 関数が呼び出されるまでは有効にはならず、すべてエラーが検出されます。 tcsetattr() 関数に渡されるボーレートの特定の値は、termios 構造に設定され、 特別な意味を持ちます。これについては、 tcsetattr() 関数を説明しているマニュアルページに述べます。

ボーレートの取得と設定
入力および出力のボーレートは、termios 構造に入っています。符号なしの整数 speed_t は、インクルードファイル <termios.h> の中で typedef されています。しかし、この整数の値は、それが示すボーレートに 直接対応しており、次のような記号で値が定義されています。

    #define B0      0
    #define B50     50
    #define B75     75
    #define B110    110
    #define B134    134
    #define B150    150
    #define B200    200
    #define B300    300
    #define B600    600
    #define B1200   1200
    #define B1800   1800
    #define B2400   2400
    #define B4800   4800
    #define B9600   9600
    #define B19200  19200
    #define B38400  38400
    #ifndef _POSIX_SOURCE
    #define EXTA    19200
    #define EXTB    38400
    #endif  /*_POSIX_SOURCE */

cfgetispeed() 関数は、 tp で参照される termios 構造における入力ボーレートを返します。

cfsetispeed() 関数は、 tp で参照される termios 構造における入力ボーレートを speed の値に設定します。

cfgetospeed() 関数は、 tp で参照される termios 構造における出力ボーレートを返します。

cfsetospeed() 関数は、 tp で参照される termios 構造における出力ボーレートを speed の値に設定します。

cfsetspeed() 関数は、 tp で参照される termios 構造における入力および出力ボーレートの両方を speed の値に設定します。

処理が成功すると、 cfsetispeed(), cfsetospeed() および cfsetspeed() は値ゼロを返します。それ以外の場合は -1 という値が返され、エラーを示す グローバル変数 errno が設定されます。 このセクションでは、一般端末インターフェースを制御するために用いる 関数について説明します。特定のコマンドについて特に断り書きがない限り、 これらの関数はバックグラウンド処理による使用に対しては制限があります。 このような操作を行なおうとすると、その処理グループには SIGTTOU シグナルが 送られます。呼び出し側処理が SIGTTOU シグナルをブロックまたは無視した場合は、 その処理は操作を実行することを許され、 SIGTTOU シグナルは送信されません。

fd は開くファイルの記述子ですが、すべての関数においては、関数はそれが 示す特定のファイル記述子に関して開いたファイルの内容だけでなく、潜在的に 関連する端末ファイルにも影響を及ぼします。

cfmakeraw() 関数は、termios 構造に保存されたフラグをすべての入力および 出力処理を無効にする状態に設定し、 “生の I/O パス” を与えます。この効果を 逆転させる関数は存在しないことに注意してください。これは、有効に 戻すことができる処理オプションは沢山あり、正しい方法は tcgetattr() 関数を使い、まず cfmakeraw() 関数で次に tcsetattr() 関数によって生モードを設定し、次にもう一度 tcsetattr() 関数を保存状態で使って元の端末状態に戻して 現在の端末状態のスナップショットを適用するやり方だからです。

tcgetattr() 関数は、 tp で参照される termios 構造に入っている fd によって参照される端末に付随するパラメータをコピーします。この関数は、 バックグラウンド処理から使うことが許されていますが、端末アトリビュート はその後にフォアグラウンド処理によって変更される場合があります。

tcsetattr() 関数は、 tp によって参照される termios 構造の端末に付随するパラメータを設定します。 action フィールドは、インクルードファイル <termios.h> の中で指定された通りに、以下の値を or 操作することによって 作成されます。

TCSANOW
    変更は直ちに行われます。

TCSADRAIN
    変更は、 fd に書込まれたすべての出力が端末に送信された後で 行われます。出力に影響を与えるパラメータを変更する場合には、この action 値を使わなければなりません。

TCSAFLUSH
    変更は、 fd に書込まれたすべての出力が端末に送信された後で 行われます。その上、受信されたがまだ読み取られていないすべての入力は 廃棄されます。

TCSASOFT
    この値が action 値に 又は 操作された場合は、 c_cflag, c_ispeed および c_ospeed フィールドの値は無視されます。

ボーレート値 0 は、接続を終了するために使います。 tcsetattr() 関数に出力速度 0 を指定すると、端末に対してモデム制御を主張せずに、 端末の接続を切ります。

関数 tcsetattr() に入力速度ゼロを指定した場合は、入力ボーレートは出力 ボーレートに指定されたものと同じ値に設定されます。

関数 tcsetattr() が要求した変更のいずれをも行うことができない場合は、値 -1 を返して errno を設定します。それ以外の場合は、要求された変更すべてを 可能な限り行います。指定した入力および出力のボーレートが異なり、その 組合せがサポートされていない場合には、どちらのボーレートも変更されません。

処理が成功して完了すると、関数 tcgetattr() および tcsetattr() は値 0 を返します。それ以外の場合は、値 -1 を返してエラーを示すグローバル変数 errno が次のように設定されます：

[EBADF]
    関数 tcgetattr() または tcsetattr() に対する引数 fd が有効なファイル記述子ではありません。

[EINTR]
    関数 tcsetattr() がシグナルによって中断されました。

[EINVAL]
    関数 tcsetattr() の引数 action が有効でないか、または termios 構造の中のアトリビュートを サポートされていない値に変更しようとしています。

[ENOTTY]
    関数 tcgetattr() または tcsetattr() の引数 fd に結びついたファイルが、端末ではありません。

参照
tcsendbreak(3), termios(4)

規格
関数 tcgetattr() および tcsetattr() は、 p1003.1-88 規格に準拠していると考えられます。関数 cfmakeraw() および cfsetspeed() は、 tcsetattr() 関数の TCSASOFT オプションと同様に p1003.1-88 規格の拡張です。