usr/src/man/man3c/tcsendbreak.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 TCSENDBREAK 3C "Aug 14, 2002"
  47 .SH NAME
  48 tcsendbreak \- send a ``break'' for a specific duration
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <termios.h>
  53
  54 \fBint\fR \fBtcsendbreak\fR(\fBint\fR \fIfildes\fR, \fBint\fR \fIduration\fR);
  55 .fi
  56
  57 .SH DESCRIPTION
  58 .sp
  59 .LP
  60 The \fIfildes\fR argument is an open file descriptor associated with a
  61 terminal.
  62 .sp
  63 .LP
  64 If the terminal is using asynchronous serial data transmission,
  65 \fBtcsendbreak()\fR will cause transmission of a continuous stream of
  66 zero-valued bits for a specific duration.  If \fIduration\fR is 0, it will
  67 cause transmission of zero-valued bits for at least 0.25 seconds, and not more
  68 than 0.5 seconds.  If \fIduration\fR is not 0, it behaves in a way similar to
  69 \fBtcdrain\fR(3C).
  70 .sp
  71 .LP
  72 If the terminal is not using asynchronous serial data transmission, it sends
  73 data to generate a break condition or returns without taking any action.
  74 .sp
  75 .LP
  76 Attempts to use \fBtcsendbreak()\fR from a process which is a member of a
  77 background process group on a \fIfildes\fR associated with its controlling
  78 terminal will cause the process group to be sent a \fBSIGTTOU\fR signal. If the
  79 calling process is blocking or ignoring \fBSIGTTOU\fR signals, the process is
  80 allowed to perform the operation, and no signal is sent.
  81 .SH RETURN VALUES
  82 .sp
  83 .LP
  84 Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
  85 returned and \fBerrno\fR is set to indicate the error.
  86 .SH ERRORS
  87 .sp
  88 .LP
  89 The \fBtcsendbreak()\fR function will fail if:
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBEBADF\fR\fR
  94 .ad
  95 .RS 10n
  96 The \fIfildes\fR argument is not a valid file descriptor.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBENOTTY\fR\fR
 103 .ad
 104 .RS 10n
 105 The file associated with \fIfildes\fR is not a terminal.
 106 .RE
 107
 108 .sp
 109 .LP
 110 The \fBtcsendbreak()\fR function may fail if:
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBEIO\fR\fR
 115 .ad
 116 .RS 7n
 117 The process group of the writing process is orphaned, and the writing process
 118 is not ignoring or blocking \fBSIGTTOU\fR.
 119 .RE
 120
 121 .SH ATTRIBUTES
 122 .sp
 123 .LP
 124 See \fBattributes\fR(5) for descriptions of the following attributes:
 125 .sp
 126
 127 .sp
 128 .TS
 129 box;
 130 c | c
 131 l | l .
 132 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 133 _
 134 Interface Stability     Standard
 135 _
 136 MT-Level        MT-Safe, and Async-Signal-Safe
 137 .TE
 138
 139 .SH SEE ALSO
 140 .sp
 141 .LP
 142 \fBtcdrain\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5), \fBtermio\fR(7I)