summaryrefslogtreecommitdiff
path: root/usr/src/man/man3c/thr_getconcurrency.3c
diff options
context:
space:
mode:
authorRichard Lowe <richlowe@richlowe.net>2011-03-14 14:05:30 -0400
committerRichard Lowe <richlowe@richlowe.net>2011-03-14 14:05:30 -0400
commitc10c16dec587a0662068f6e2991c29ed3a9db943 (patch)
treef414286f4bba41d75683ed4fbbaa6bfa4bf7fabd /usr/src/man/man3c/thr_getconcurrency.3c
parent68caef18a23a498d9e3017b983562c0f4fd8ab23 (diff)
downloadillumos-gate-c10c16dec587a0662068f6e2991c29ed3a9db943.tar.gz
243 system manual pages should live with the software
Reviewed by: garrett@nexenta.com Reviewed by: gwr@nexenta.com Reviewed by: trisk@opensolaris.org Approved by: gwr@nexenta.com --HG-- extra : rebase_source : 0c599d0bec0dc8865fbba67721a7a6cd6b1feefb
Diffstat (limited to 'usr/src/man/man3c/thr_getconcurrency.3c')
-rw-r--r--usr/src/man/man3c/thr_getconcurrency.3c89
1 files changed, 89 insertions, 0 deletions
diff --git a/usr/src/man/man3c/thr_getconcurrency.3c b/usr/src/man/man3c/thr_getconcurrency.3c
new file mode 100644
index 0000000000..51a557e4b3
--- /dev/null
+++ b/usr/src/man/man3c/thr_getconcurrency.3c
@@ -0,0 +1,89 @@
+'\" te
+.\" Copyright (c) 1998 Sun Microsystems, Inc. All Rights Reserved
+.\" 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.
+.\" 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.
+.\" 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]
+.TH thr_getconcurrency 3C "11 May 1998" "SunOS 5.11" "Standard C Library Functions"
+.SH NAME
+thr_getconcurrency, thr_setconcurrency \- get or set thread concurrency level
+.SH SYNOPSIS
+.LP
+.nf
+cc -mt [ \fIflag\fR... ] \fIfile\fR...[ \fIlibrary\fR... ]
+#include <thread.h>
+
+\fBint\fR \fBthr_setconcurrency\fR(\fBint\fR \fInew_level\fR);
+.fi
+
+.LP
+.nf
+\fBint\fR \fBthr_getconcurrency\fR(\fBvoid\fR);
+.fi
+
+.SH DESCRIPTION
+.sp
+.LP
+These functions are obsolete and maintained for compatibility only. The
+\fBthr_setconcurrency()\fR function updates the desired concurrency level that
+\fBlibthread\fR maintains for the calling process. This value does not affect
+the behavior of the calling process.
+.sp
+.LP
+The \fBthr_getconcurrency()\fR function returns the current value for the
+desired concurrency level.
+.SH RETURN VALUES
+.sp
+.LP
+The \fBthr_getconcurrency()\fR function always returns the current value for
+the desired concurrency level.
+.sp
+.LP
+If successful, the \fBthr_setconcurrency()\fR function returns \fB0\fR.
+Otherwise, a non-zero value is returned to indicate the error.
+.SH ERRORS
+.sp
+.LP
+The \fBthr_setconcurrency()\fR function will fail if:
+.sp
+.ne 2
+.mk
+.na
+\fB\fBEAGAIN\fR \fR
+.ad
+.RS 11n
+.rt
+The specified concurrency level would cause a system resource to be exceeded.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBEINVAL\fR \fR
+.ad
+.RS 11n
+.rt
+The value for \fInew_level\fR is negative.
+.RE
+
+.SH ATTRIBUTES
+.sp
+.LP
+See \fBattributes\fR(5) for descriptions of the following attributes:
+.sp
+
+.sp
+.TS
+tab() box;
+cw(2.75i) |cw(2.75i)
+lw(2.75i) |lw(2.75i)
+.
+ATTRIBUTE TYPEATTRIBUTE VALUE
+_
+MT-LevelMT-Safe
+.TE
+
+.SH SEE ALSO
+.sp
+.LP
+\fBthr_create\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)