lib/libc/sys/caps_sys_abort.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_abort.2,v 1.1 2006/02/28 22:40:49 swildner Exp $
  32 .\"
  33 .Dd February 28, 2006
  34 .Dt CAPS_SYS_ABORT 2
  35 .Os
  36 .Sh NAME
  37 .Nm caps_sys_abort
  38 .Nd abort a CAPS IPC message
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In sys/caps.h
  43 .Ft int
  44 .Fn caps_sys_abort "int portid" "off_t msgid" "int flags"
  45 .Sh DESCRIPTION
  46 Abort a previously sent message.
  47 The
  48 .Fa portid
  49 argument is a port identifier returned by a previous call to
  50 .Fn caps_sys_service
  51 or
  52 .Fn caps_sys_client .
  53 The message to be aborted is identified by the 64 bit
  54 .Fa msgid
  55 that was returned by a previous call to
  56 .Fn caps_sys_put .
  57 .Pp
  58 You must still wait for the message to be returned after sending the
  59 abort request.
  60 .\".Sh RETURN VALUES
  61 .\"This function returns an abort code indicating failure or success of
  62 .\"the call:
  63 .\".Bl -tag -width ".Dv CAPS_ABORT_BEFORESERVER"
  64 .\".It Dv CAPS_ABORT_RETURNED
  65 .\"The message was already returned.
  66 .\"No action is taken.
  67 .\".It Dv CAPS_ABORT_BEFORESERVER
  68 .\"The message was caught before the server got it.
  69 .\".It Dv CAPS_ABORT_ATSERVER
  70 .\"The message was already retrieved by the server.
  71 .\".El
  72 .Sh SEE ALSO
  73 .Xr caps_sys_client 2 ,
  74 .Xr caps_sys_put 2 ,
  75 .Xr caps_sys_service 2
  76 .Sh HISTORY
  77 The
  78 .Fn caps_sys_abort
  79 function call first appeared in
  80 .Dx 1.0 .
  81 .Sh AUTHORS
  82 .An -nosplit
  83 CAPS IPC was written by
  84 .An Matthew Dillon .
  85 This man page was written by
  86 .An Sascha Wildner .
  87 .Sh BUGS
  88 This function is currently not implemented and
  89 .Dv CAPS_ABORT_NOTIMPL
  90 is returned.