usr/src/man/man3mpapi/MP_SetProbingPollingRate.3mpapi

   1 '\" te
   2 .\" Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
   3 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH MP_SETPROBINGPOLLINGRATE 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_SetProbingPollingRate \- set the polling rate
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <mpapi.h>
  15
  16 \fBMP_STATUS\fR \fBMP_SetProbingPollingRate\fR(\fBMP_OID\fR \fIoid\fR,
  17      \fBMP_UINT32\fR \fIpollingRate\fR);
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fIoid\fR\fR
  25 .ad
  26 .RS 15n
  27 An object ID of either the plugin or a multipath logical unit.
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIpollingRate\fR\fR
  34 .ad
  35 .RS 15n
  36 The value to be set in \fBMP_PLUGIN_PROPERTIES\fR
  37 \fIcurrentProbingPollingRate\fR or
  38 \fBMP_MULTIPATH_LOGICAL_UNIT_PROPERTIES\fR \fIProbingPollingRate\fR.
  39 .RE
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 The \fBMP_SetProbingPollingRate()\fR function sets the polling rates. Setting
  45 the \fIpollingRate\fR to zero disables polling.
  46 .sp
  47 .LP
  48 If the object ID refers to a plugin, this sets the
  49 \fIcurrentProbingPollingRate\fR property in the plugin properties. If the
  50 object ID refers to a multipath logical unit, this sets the
  51 \fIProbingPollingRate\fR property.
  52 .SH RETURN VALUES
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  57 .ad
  58 .sp .6
  59 .RS 4n
  60 The \fIoid\fR does not specify any valid object type. This is most likely to
  61 happen if an uninitialized object ID is passed to the API.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  68 .ad
  69 .sp .6
  70 .RS 4n
  71 One of the polling values is outside the range supported by the driver or when
  72 the \fIoid\fR has a type subfield other than \fBMP_OBJECT_TYPE_PLUGIN\fR or
  73 \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  80 .ad
  81 .sp .6
  82 .RS 4n
  83 The \fIoid\fR ownerID or sequence number is invalid.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBMP_STATUS_SUCCESS\fR\fR
  90 .ad
  91 .sp .6
  92 .RS 4n
  93 The operation is successful.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBMP_STATUS_UNSUPPORTED\fR\fR
 100 .ad
 101 .sp .6
 102 .RS 4n
 103 The implementation does not support the API.
 104 .RE
 105
 106 .SH ATTRIBUTES
 107 .sp
 108 .LP
 109 See \fBattributes\fR(5) for descriptions of the following attributes:
 110 .sp
 111
 112 .sp
 113 .TS
 114 box;
 115 c | c
 116 l | l .
 117 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 118 _
 119 Interface Stability     T{
 120 Standard: ANSI INCITS 412 Multipath Management API
 121 T}
 122 _
 123 MT-Level        Safe
 124 .TE
 125
 126 .SH SEE ALSO
 127 .sp
 128 .LP
 129 \fBlibMPAPI\fR(3LIB), \fBattributes\fR(5)
 130 .sp
 131 .LP
 132 \fIMultipath Management API Version 1.0\fR