usr/src/man/man3nsl/rpc_svc_input.3nsl

   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 RPC_SVC_INPUT 3NSL "Jan 6, 2003"
   7 .SH NAME
   8 rpc_svc_input, svc_add_input, svc_remove_input \- declare or remove a callback
   9 on a file descriptor
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <rpc/rpc.h>
  14
  15 \fBtypedef void (*\fR\fBsvc_callback_t\fR)(\fBsvc_input_id_t\fR \fIid\fR, \fBint\fR \fIfd\fR,
  16      \fBunsigned int\fR \fIevents\fR, \fBvoid *\fR\fIcookie\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBsvc_input_id_t\fR \fBsvc_add_input\fR(\fBint\fR \fIfd\fR, \fBunsigned int\fR \fIrevents\fR,
  22      \fBsvc_callback_t\fR \fIcallback\fR, \fBvoid *\fR\fIcookie\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBsvc_remove_input\fR(\fBsvc_input_t\fR \fIid\fR);
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 The following RPC routines are used to declare or remove a callback on a file
  34 descriptor.
  35 .SS "Routines"
  36 .sp
  37 .LP
  38 See \fBrpc\fR(3NSL) for the definition of the \fBSVCXPRT\fR data structure.
  39 .sp
  40 .ne 2
  41 .na
  42 \fBsvc_add_input\fB()\fR\fR
  43 .ad
  44 .RS 22n
  45 This function is used to register a \fIcallback\fR function on a file
  46 descriptor, \fIfd\fR. The file descriptor, \fIfd\fR, is the first parameter to
  47 be passed to \fBsvc_add_input()\fR. This \fIcallback\fR function will be
  48 automatically called if any of the events specified in the \fIevents\fR
  49 parameter occur on this descriptor. The \fIevents\fR parameter is used to
  50 specify when the callback is invoked. This parameter is a mask of poll events
  51 to which the user wants to listen. See \fBpoll\fR(2) for further details of the
  52 events that can be specified.
  53 .sp
  54 The callback to be invoked is specified using the \fIcallback\fR parameter. The
  55 \fIcookie\fR parameter can be used to pass any data to the \fIcallback\fR
  56 function. This parameter is a user-defined value which is passed as an argument
  57 to the \fIcallback\fR function, and it is not used by the Sun RPC library
  58 itself.
  59 .sp
  60 Several callbacks can be registered on the same file descriptor as long as each
  61 callback registration specifies a separate set of event flags.
  62 .sp
  63 The \fIcallback\fR function is called with the registration \fIid\fR, the
  64 \fIfd\fR file descriptor, an \fIrevents\fR value, which is a bitmask of all
  65 events concerning the file descriptor, and the \fIcookie\fR user-defined value.
  66 .sp
  67 Upon successful completion, the function returns a unique identifier for this
  68 registration, that can be used later to remove this callback. Upon failure,
  69 \fB-1\fR is returned and \fBerrno\fR is set to indicate the error.
  70 .sp
  71 The \fBsvc_add_input()\fR function will fail if:
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBEINVAL\fR\fR
  76 .ad
  77 .RS 10n
  78 The \fIfd\fR or \fIevents\fR parameters are invalid.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBEEXIST\fR\fR
  85 .ad
  86 .RS 10n
  87 A callback is already registered to the file descriptor with one of the
  88 specified events.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBENOMEM\fR\fR
  95 .ad
  96 .RS 10n
  97 Memory is exhausted.
  98 .RE
  99
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBsvc_remove_input()\fR\fR
 106 .ad
 107 .RS 22n
 108 This function is used to unregister a callback function on a file descriptor,
 109 \fIfd\fR. The \fIid\fR parameter specifies the registration to be removed.
 110 .sp
 111 Upon successful completion, the function returns zero. Upon failure, \fB-1\fR
 112 is returned and \fBerrno\fR is set to indicate the error.
 113 .sp
 114 The \fBsvc_remove_input()\fR function will fail if:
 115 .sp
 116 .ne 2
 117 .na
 118 \fBEINVAL\fR
 119 .ad
 120 .RS 10n
 121 The \fIid\fR parameter is invalid.
 122 .RE
 123
 124 .RE
 125
 126 .SH ATTRIBUTES
 127 .sp
 128 .LP
 129 See \fBattributes\fR(5) for descriptions of the following attributes:
 130 .sp
 131
 132 .sp
 133 .TS
 134 box;
 135 c | c
 136 l | l .
 137 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 138 _
 139 Architecture    All
 140 _
 141 Interface Stability     Evolving
 142 _
 143 MT-Level        MT-Safe
 144 .TE
 145
 146 .SH SEE ALSO
 147 .sp
 148 .LP
 149 \fBpoll\fR(2), \fBrpc\fR(3NSL), \fBattributes\fR(5)