usr/src/man/man3c/tcflow.3c

   1 '\" te
   2 .\"  Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH TCFLOW 3C "Aug 14, 2002"
  11 .SH NAME
  12 tcflow \- suspend or restart the transmission or reception of data
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <termios.h>
  17
  18 \fBint\fR \fBtcflow\fR(\fBint\fR \fIfildes\fR, \fBint\fR \fIaction\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBtcflow()\fR function suspends transmission or reception of data on the
  25 object referred to by \fIfildes\fR, depending on the value of \fIaction\fR. The
  26 \fIfildes\fR argument is an open file descriptor associated with a terminal.
  27 .RS +4
  28 .TP
  29 .ie t \(bu
  30 .el o
  31 If \fIaction\fR is \fBTCOOFF\fR, output is suspended.
  32 .RE
  33 .RS +4
  34 .TP
  35 .ie t \(bu
  36 .el o
  37 If \fIaction\fR is \fBTCOON\fR, suspended output is restarted.
  38 .RE
  39 .RS +4
  40 .TP
  41 .ie t \(bu
  42 .el o
  43 If \fIaction\fR is \fBTCIOFF\fR, the system transmits a \fBSTOP\fR character,
  44 which is intended to cause the terminal device to stop transmitting data to the
  45 system.
  46 .RE
  47 .RS +4
  48 .TP
  49 .ie t \(bu
  50 .el o
  51 If \fIaction\fR is \fBTCION\fR, the system transmits a \fBSTART\fR character,
  52 which is intended to cause the terminal device to start transmitting data to
  53 the system.
  54 .RE
  55 .sp
  56 .LP
  57 The default on the opening of a terminal file is that neither its input nor its
  58 output are suspended.
  59 .sp
  60 .LP
  61 Attempts to use \fBtcflow()\fR from a process which is a member of a background
  62 process group on a \fIfildes\fR associated with its controlling terminal, will
  63 cause the process group to be sent a \fBSIGTTOU\fR signal. If the calling
  64 process is blocking or ignoring \fBSIGTTOU\fR signals, the process is allowed
  65 to perform the operation, and no signal is sent.
  66 .SH RETURN VALUES
  67 .sp
  68 .LP
  69 Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
  70 returned and \fBerrno\fR is set to indicate the error.
  71 .SH ERRORS
  72 .sp
  73 .LP
  74 The \fBtcflow()\fR function will fail if:
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBEBADF\fR\fR
  79 .ad
  80 .RS 10n
  81 The \fIfildes\fR argument is not a valid file descriptor.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBEINVAL\fR\fR
  88 .ad
  89 .RS 10n
  90 The \fIaction\fR argument is not a supported value.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBENOTTY\fR\fR
  97 .ad
  98 .RS 10n
  99 The file associated with \fIfildes\fR is not a terminal.
 100 .RE
 101
 102 .sp
 103 .LP
 104 The \fBtcflow()\fR function may fail if:
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBEIO\fR\fR
 109 .ad
 110 .RS 7n
 111 The process group of the writing process is orphaned, and the writing process
 112 is not ignoring or blocking \fBSIGTTOU\fR.
 113 .RE
 114
 115 .SH ATTRIBUTES
 116 .sp
 117 .LP
 118 See \fBattributes\fR(5) for descriptions of the following attributes:
 119 .sp
 120
 121 .sp
 122 .TS
 123 box;
 124 c | c
 125 l | l .
 126 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 127 _
 128 Interface Stability     Standard
 129 _
 130 MT-Level        MT-Safe, and Async-Signal-Safe
 131 .TE
 132
 133 .SH SEE ALSO
 134 .sp
 135 .LP
 136 \fBtcsendbreak\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5),
 137 \fBtermio\fR(7I)