usr/src/man/man3sasl/sasl_idle.3sasl

   1 '\" te
   2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2003, Sun Microsystems,
   4 .\" Inc. All Rights Reserved
   5 .\" 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.
   6 .\" 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.
   7 .\" 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]
   8 .TH SASL_IDLE 3SASL "Aug 28, 2003"
   9 .SH NAME
  10 sasl_idle \- perform precalculations during an idle period
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/sasl.h>
  16
  17 \fBint\fR \fBsasl_idle\fR(\fBsasl_conn_t *\fR\fIconn\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 Use the \fBsasl_idle()\fR interface during an idle period to allow the SASL
  24 library or any mechanisms to perform any necessary precalculation.
  25 .SH PARAMETERS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fIconn\fR\fR
  30 .ad
  31 .RS 8n
  32 The SASL connection context. The value of \fIconn\fR can be \fINULL\fR in order
  33 to complete a precalculation before the connection takes place.
  34 .RE
  35
  36 .SH RETURN VALUES
  37 .sp
  38 .LP
  39 \fBsasl_idle()\fR returns the following values:
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fB1\fR\fR
  44 .ad
  45 .RS 5n
  46 Indicates action was taken
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fB0\fR\fR
  53 .ad
  54 .RS 5n
  55 Indicates no action was taken
  56 .RE
  57
  58 .SH ATTRIBUTES
  59 .sp
  60 .LP
  61 See \fBattributes\fR(5) for descriptions of the following attributes:
  62 .sp
  63
  64 .sp
  65 .TS
  66 box;
  67 c | c
  68 l | l .
  69 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  70 _
  71 Interface Stability     Evolving
  72 _
  73 MT-Level        MT-Safe
  74 .TE
  75
  76 .SH SEE ALSO
  77 .sp
  78 .LP
  79 \fBattributes\fR(5)