lib/libc/sys/caps_sys_put.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_put.2,v 1.1 2006/02/28 22:40:49 swildner Exp $
  32 .\"
  33 .Dd February 28, 2006
  34 .Dt CAPS_SYS_PUT 2
  35 .Os
  36 .Sh NAME
  37 .Nm caps_sys_put
  38 .Nd send an opaque message to a CAPS IPC port
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In sys/caps.h
  43 .Ft off_t
  44 .Fn caps_sys_put "int portid" "const void *msg" "int msgsize"
  45 .Sh DESCRIPTION
  46 Send an opaque message
  47 .Fa msg
  48 of the specified size
  49 .Fa msgsiz
  50 to the port identified by
  51 .Fa portid .
  52 The memory associated with the message must be left intact until the
  53 message is returned.
  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 client side.
  58 .Sh RETURN VALUES
  59 On success, this function returns a 64 bit message identifier.
  60 If an error occurs, -1 is returned and
  61 .Va errno
  62 is set.
  63 .Sh ERRORS
  64 This function will fail if:
  65 .Bl -tag -width ".Bq Er ENOTCONN"
  66 .It Bq Er EINVAL
  67 An invalid argument was specified.
  68 .It Bq Er ENOTCONN
  69 The process originally creating the port forked and the child
  70 process attempts to access the port.
  71 The child process is expected to create its own port.
  72 This error is also returned if the remote end closed its connection
  73 and is no longer available.
  74 .It Bq Er ENOBUFS
  75 The maximum number of in-transmit messages has been reached.
  76 No more messages can be sent until some of them are replied to.
  77 .El
  78 .Sh SEE ALSO
  79 .Xr caps_sys_client 2 ,
  80 .Xr caps_sys_get 2 ,
  81 .Xr caps_sys_service 2
  82 .Sh HISTORY
  83 The
  84 .Fn caps_sys_put
  85 function call first appeared in
  86 .Dx 1.0 .
  87 .Sh AUTHORS
  88 .An -nosplit
  89 CAPS IPC was written by
  90 .An Matthew Dillon .
  91 This man page was written by
  92 .An Sascha Wildner .