lib/libc/sys/caps_sys_getgen.2

   1 .\"
   2 .\" Copyright (c) 2006 The DragonFly Project.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\"
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in
  12 .\"    the documentation and/or other materials provided with the
  13 .\"    distribution.
  14 .\" 3. Neither the name of The DragonFly Project nor the names of its
  15 .\"    contributors may be used to endorse or promote products derived
  16 .\"    from this software without specific, prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  21 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  22 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  23 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  24 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  26 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  28 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $DragonFly: src/lib/libc/sys/caps_sys_getgen.2,v 1.1 2006/02/28 22:40:49 swildner Exp $
  32 .\"
  33 .Dd February 28, 2006
  34 .Dt CAPS_SYS_GETGEN 2
  35 .Os
  36 .Sh NAME
  37 .Nm caps_sys_getgen
  38 .Nd get the generation number for a CAPS IPC link
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In sys/caps.h
  43 .Ft caps_gen_t
  44 .Fn caps_sys_getgen "int portid"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn caps_sys_getgen
  48 function returns the 64 bit generation number for a CAPS link
  49 specified by the
  50 .Fa portid
  51 identifier.
  52 This number is typically used to allow a client to detect when a
  53 service has been restarted.
  54 .Sh RETURN VALUES
  55 On success, the 64 bit generation number is returned.
  56 If an error occurs, -1 is returned and
  57 .Va errno
  58 is set.
  59 .Sh ERRORS
  60 This function will fail if:
  61 .Bl -tag -width ".Bq Er ENOTCONN"
  62 .It Bq Er EINVAL
  63 The
  64 .Fa portid
  65 could not be found.
  66 .It Bq Er ENOTCONN
  67 The process originally creating the port forked and the child
  68 process attempts to access the port.
  69 The child process is expected to create its own port.
  70 .El
  71 .Sh SEE ALSO
  72 .Xr caps_sys_setgen 2
  73 .Sh HISTORY
  74 The
  75 .Fn caps_sys_getgen
  76 function call first appeared in
  77 .Dx 1.0 .
  78 .Sh AUTHORS
  79 .An -nosplit
  80 CAPS IPC was written by
  81 .An Matthew Dillon .
  82 This man page was written by
  83 .An Sascha Wildner .