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

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