usr/src/man/man3sysevent/sysevent_subscribe_event.3sysevent

   1 '\" te
   2 .\" Copyright (c) 2009, 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  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
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH SYSEVENT_SUBSCRIBE_EVENT 3SYSEVENT "Jul 24, 2009"
   7 .SH NAME
   8 sysevent_subscribe_event, sysevent_unsubscribe_event \- register or unregister
   9 interest in event receipt
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR  [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lsysevent\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <libsysevent.h>
  15
  16 \fBint\fR \fBsysevent_subscribe_event\fR(\fBsysevent_handle_t *\fR\fIsysevent_hdl\fR,
  17      \fBchar *\fR\fIevent_class\fR, \fBchar **\fR\fIevent_subclass_list\fR,
  18      \fBint\fR \fInum_subclasses\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBvoid\fR \fBsysevent_unsubscribe_event\fR(\fBsysevent_handle_t *\fR\fIsysevent_hdl\fR,
  24      \fBchar *\fR\fIevent_class\fR);
  25 .fi
  26
  27 .SH PARAMETERS
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIevent_class\fR\fR
  32 .ad
  33 .RS 23n
  34 system event class string
  35 .RE
  36
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fIevent_subclass_list\fR\fR
  41 .ad
  42 .RS 23n
  43 array of subclass strings
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fInum_subclasses\fR\fR
  50 .ad
  51 .RS 23n
  52 number of subclass strings
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fIsysevent_hdl\fR\fR
  59 .ad
  60 .RS 23n
  61 \fBsysevent\fR subscriber handle
  62 .RE
  63
  64 .SH DESCRIPTION
  65 .sp
  66 .LP
  67 The \fBsysevent_subscribe_event()\fR function registers the caller's interest
  68 in event notifications belonging to the class \fIevent_class\fR and the
  69 subclasses contained in \fIevent_subclass_list\fR.  The subscriber handle
  70 \fIsysevent_hdl\fR is updated with the new subscription and the calling process
  71 receives event notifications from the event handler specified in
  72 \fIsysevent_bind_handle\fR.
  73 .sp
  74 .LP
  75 System events matching \fIevent_class\fR and a subclass contained in
  76 \fIevent_subclass_list\fR published after the caller returns from
  77 \fBsysevent_subscribe_event()\fR are guaranteed to be delivered to the calling
  78 process.  Matching system events published and queued prior to a call to
  79 \fBsysevent_subscribe_event()\fR may be delivered to the process's event
  80 handler.
  81 .sp
  82 .LP
  83 The \fInum_subclasses\fR argument provides the number of subclass string
  84 elements in \fIevent_subclass_list\fR.
  85 .sp
  86 .LP
  87 A caller can use the event class \fBEC_ALL\fR to subscribe to all event classes
  88 and subclasses. The event class \fBEC_SUB_ALL\fR can be used to subscribe to
  89 all subclasses within a given event class.
  90 .sp
  91 .LP
  92 Subsequent calls to \fBsysevent_subscribe_event()\fR are allowed to add
  93 additional classes or subclasses.  To remove an existing subscription,
  94 \fBsysevent_unsubscribe_event()\fR must be used to remove the subscription.
  95 .sp
  96 .LP
  97 The \fBsysevent_unsubscribe_event()\fR function removes the subscription
  98 described by \fIevent_class\fR for \fIsysevent_hdl\fR.  Event notifications
  99 matching event_class will not be delivered to the calling process upon return.
 100 .sp
 101 .LP
 102 A caller can use the event class \fBEC_ALL\fR to remove all subscriptions for
 103 \fIsysevent_hdl\fR.
 104 .sp
 105 .LP
 106 The library manages all subscription resources.
 107 .SH RETURN VALUES
 108 .sp
 109 .LP
 110 The \fBsysevent_subscribe_event()\fR function returns 0 if the subscription is
 111 successful. Otherwise, \(mi1 is returned and \fBerrno\fR is set to indicate the
 112 error.
 113 .sp
 114 .LP
 115 The \fBsysevent_unsubscribe_event()\fR function returns no value.
 116 .SH ERRORS
 117 .sp
 118 .LP
 119 The \fBsysevent_subscribe_event()\fR function will fail if:
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fBEACCES\fR\fR
 124 .ad
 125 .RS 10n
 126 The calling process has an ID other than the privileged user.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBEINVAL\fR\fR
 133 .ad
 134 .RS 10n
 135 The \fIsysevent_hdl\fR argument is an invalid \fBsysevent\fR handle.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fBENOMEM\fR\fR
 142 .ad
 143 .RS 10n
 144 There is insufficient memory available to allocate subscription resources.
 145 .RE
 146
 147 .SH EXAMPLES
 148 .LP
 149 \fBExample 1 \fRSubscribing for environmental events
 150 .sp
 151 .in +2
 152 .nf
 153 #include <libsysevent.h>
 154 #include <sys/nvpair.h>
 155
 156 static int32_t attr_int32;
 157
 158 #define    CLASS1        "class1"
 159 #define    CLASS2        "class2"
 160 #define    SUBCLASS_1    "subclass_1"
 161 #define    SUBCLASS_2    "subclass_2"
 162 #define    SUBCLASS_3    "subclass_3"
 163 #define    MAX_SUBCLASS  3
 164
 165 static void
 166 event_handler(sysevent_t *ev)
 167 {
 168     nvlist_t *nvlist;
 169
 170     /*
 171      * Special processing  for events (CLASS1, SUBCLASS_1) and
 172      * (CLASS2, SUBCLASS_3)
 173      */
 174     if ((strcmp(CLASS1, sysevent_get_class_name(ev)) == 0 &&
 175         strcmp(SUBCLASS_1, sysevent_get_subclass_name(ev)) == 0) ||
 176         (strcmp(CLASS2, sysevent_get_subclass_name(ev) == 0) &&
 177         strcmp(SUBCLASS_3, sysevent_get_subclass(ev)) == 0)) {
 178         if (sysevent_get_attr_list(ev, &nvlist) != 0)
 179             return;
 180         if (nvlist_lookup_int32(nvlist, "my_int32_attr", &attr_int32)
 181             != 0)
 182             return;
 183
 184         /* Event Processing */
 185     } else {
 186         /* Event Processing */
 187     }
 188
 189 }
 190
 191
 192 int
 193 main(int argc, char **argv)
 194 {
 195     sysevent_handle_t *shp;
 196     const char *subclass_list[MAX_SUBCLASS];
 197
 198     /* Bind event handler and create subscriber handle */
 199     shp = sysevent_bind_handle(event_handler);
 200     if (shp == NULL)
 201         exit(1);
 202
 203     /* Subscribe to all CLASS1 event notifications */
 204     subclass_list[0] = EC_SUB_ALL;
 205     if (sysevent_subscribe_event(shp, CLASS1, subclass_list, 1) != 0) {
 206         sysevent_unbind_handle(shp);
 207         exit(1);
 208     }
 209
 210     /* Subscribe to CLASS2 events for subclasses: SUBCLASS_1,
 211      * SUBCLASS_2 and SUBCLASS_3
 212      */
 213     subclass_list[0] = SUBCLASS_1;
 214     subclass_list[1] = SUBCLASS_2;
 215     subclass_list[2] = SUBCLASS_3;
 216     if (sysevent_subscribe_event(shp, CLASS2, subclass_list,
 217         MAX_SUBCLASS) != 0) {
 218         sysevent_unbind_handle(shp);
 219         exit(1);
 220     }
 221
 222     for (;;) {
 223         (void) pause();
 224     }
 225 }
 226 .fi
 227 .in -2
 228
 229 .SH ATTRIBUTES
 230 .sp
 231 .LP
 232 See \fBattributes\fR(5) for descriptions of the following attributes:
 233 .sp
 234
 235 .sp
 236 .TS
 237 box;
 238 c | c
 239 l | l .
 240 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 241 _
 242 Interface Stability     Committed
 243 _
 244 MT-Level        MT-Safe
 245 .TE
 246
 247 .SH SEE ALSO
 248 .sp
 249 .LP
 250 \fBsyseventd\fR(1M), \fBsysevent_bind_handle\fR(3SYSEVENT),
 251 \fBsysevent_get_attr_list\fR(3SYSEVENT),
 252 \fBsysevent_get_class_name\fR(3SYSEVENT),
 253 \fBsysevent_get_vendor_name\fR(3SYSEVENT), \fBattributes\fR(5)
 254 .SH NOTES
 255 .sp
 256 .LP
 257 The \fBlibsysevent\fR interfaces do not work at all in non-global zones.