lib/librpcsec_gss/rpc_gss_svc_max_data_length.3

   1 .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/
   2 .\" Authors: Doug Rabson <dfr@rabson.org>
   3 .\" Developed with Red Inc: Alfred Perlstein <alfred@FreeBSD.org>
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   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 the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .Dd January 26, 2010
  28 .Dt RPC_GSS_SVC_MAX_DATA_LENGTH 3
  29 .Os
  30 .Sh NAME
  31 .Nm rpc_gss_svc_max_data_length
  32 .Nd "calculate maximum data size"
  33 .Sh LIBRARY
  34 .Lb librpcsec_gss
  35 .Sh SYNOPSIS
  36 .In rpc/rpcsec_gss.h
  37 .Ft int
  38 .Fn rpc_gss_svc_max_data_length "struct svc_req *req" "int max_tp_unit_len"
  39 .Sh DESCRIPTION
  40 Calculate the maximum message size that will fit into a packet of size
  41 .Fa max_tp_unit_len ,
  42 given the current service and QoP setting.
  43 .Sh PARAMETERS
  44 .Bl -tag -width ".It max_tp_unit_len"
  45 .It req
  46 An RPC request
  47 .It max_tp_unit_len
  48 Maximum packet size of the underlying transport protocol
  49 .El
  50 .Sh RETURN VALUES
  51 The maximum message size that can be encoded
  52 .Sh SEE ALSO
  53 .Xr rpc 3 ,
  54 .Xr gssapi 3 ,
  55 .Xr rpcset_gss 3
  56 .Sh HISTORY
  57 The
  58 .Nm
  59 function first appeared in
  60 .Fx 8.0 .
  61 .Sh AUTHORS
  62 This
  63 manual page was written by
  64 .An Doug Rabson Aq dfr@FreeBSD.org .