lib/libc/sys/caps_sys_reply.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_reply.2,v 1.1 2006/02/28 22:40:49 swildner Exp $
  32 .\"
  33 .Dd February 28, 2006
  34 .Dt CAPS_SYS_REPLY 2
  35 .Os
  36 .Sh NAME
  37 .Nm caps_sys_reply
  38 .Nd reply to 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_reply "int portid" "const void *msg" "int msgsize" "off_t msgid"
  45 .Sh DESCRIPTION
  46 Reply to the received CAPS message identified by
  47 .Fa msgid
  48 on the port specified by
  49 .Fa portid .
  50 The reply may supply opaque data in
  51 .Fa msg .
  52 The memory associated with the message must be left intact until
  53 an acknowledgement is returned at a later time.
  54 The kernel does not make a copy of the message and its size may not
  55 exceed 128KB.
  56 .Pp
  57 This function is only used on the server side.
  58 The server may reply to a message without retrieving its data.
  59 .Sh RETURN VALUES
  60 .Rv -std caps_sys_reply
  61 .Sh ERRORS
  62 This function will fail if:
  63 .Bl -tag -width ".Bq Er ENOTCONN"
  64 .It Bq Er EINVAL
  65 An invalid argument was specified.
  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 This error is also returned if the remote end closed its connection
  71 and is no longer available.
  72 Note that a child process may not reply to a message received by its
  73 parent.
  74 .El
  75 .Sh SEE ALSO
  76 .Xr caps_sys_client 2 ,
  77 .Xr caps_sys_get 2 ,
  78 .Xr caps_sys_put 2 ,
  79 .Xr caps_sys_service 2
  80 .Sh HISTORY
  81 The
  82 .Fn caps_sys_reply
  83 function call first appeared in
  84 .Dx 1.0 .
  85 .Sh AUTHORS
  86 .An -nosplit
  87 CAPS IPC was written by
  88 .An Matthew Dillon .
  89 This man page was written by
  90 .An Sascha Wildner .