usr/src/man/man3slp/SLPGetRefreshInterval.3slp

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH SLPGETREFRESHINTERVAL 3SLP "Jan 16, 2003"
   7 .SH NAME
   8 SLPGetRefreshInterval \- return the maximum allowed refresh interval
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lslp\fR [ \fIlibrary\fR... ]#include <slp.h>
  13
  14 \fBint\fR \fBSLPGetRefreshInterval\fR(void)
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBSLPGetRefreshInterval()\fR function returns the maximum across all
  21 \fBDA\fRs of the \fBmin-refresh-interval\fR attribute.  This value satisfies
  22 the advertised refresh interval bounds for all \fBDA\fRs. If this value is used
  23 by the \fBSA\fR, it assures that no refresh registration will be rejected.  If
  24 no \fBDA\fR advertises a \fBmin-refresh-interval\fR attribute, a value of
  25 \fB0\fR is returned. If an error occurs,  an \fBSLP\fR error code is returned.
  26 .SH ERRORS
  27 .sp
  28 .LP
  29 This function or its callback may return any \fBSLP\fR error code. See the
  30 ERRORS section in \fBslp_api\fR(3SLP).
  31 .SH EXAMPLES
  32 .LP
  33 \fBExample 1 \fRUsing \fBSLPGetRefreshInterval()\fR
  34 .sp
  35 .LP
  36 Use the following example to return the maximum valid refresh interval for
  37 \fBSA\fR:
  38
  39 .sp
  40 .in +2
  41 .nf
  42 int minrefresh
  43
  44 minrefresh = SLPGetRefreshInterval(\|);
  45 .fi
  46 .in -2
  47
  48 .SH ENVIRONMENT VARIABLES
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBSLP_CONF_FILE\fR\fR
  53 .ad
  54 .RS 17n
  55 When set, use this file for configuration.
  56 .RE
  57
  58 .SH SEE ALSO
  59 .sp
  60 .LP
  61 \fBslpd\fR(1M), \fBslp_api\fR(3SLP), \fBslp.conf\fR(4), \fBslpd.reg\fR(4),
  62 \fBattributes\fR(5)
  63 .sp
  64 .LP
  65 \fISystem Administration Guide: Network Services\fR
  66 .sp
  67 .LP
  68 Kempf, J. and Guttman, E. \fIRFC 2614, An API for Service Location\fR. The
  69 Internet Society. June 1999.